From 188d9dd5a0769cc9e8ddeaa8852799c3348393f9 Mon Sep 17 00:00:00 2001 From: Justin Beckwith Date: Tue, 21 Aug 2018 07:40:28 -0700 Subject: [PATCH] chore: run the generator (#1299) --- src/apis/abusiveexperiencereport/v1.ts | 16 +- src/apis/acceleratedmobilepageurl/v1.ts | 4 +- src/apis/adexchangebuyer/v1.2.ts | 38 +- src/apis/adexchangebuyer/v1.3.ts | 148 +- src/apis/adexchangebuyer/v1.4.ts | 292 +- src/apis/adexchangebuyer2/v2beta1.ts | 793 +- src/apis/adexchangeseller/v1.1.ts | 164 +- src/apis/adexchangeseller/v1.ts | 138 +- src/apis/adexchangeseller/v2.0.ts | 129 +- src/apis/adexperiencereport/v1.ts | 16 +- src/apis/admin/datatransfer_v1.ts | 37 +- src/apis/admin/directory_v1.ts | 759 +- src/apis/admin/reports_v1.ts | 122 +- src/apis/adsense/v1.4.ts | 400 +- src/apis/adsensehost/v4.1.ts | 198 +- src/apis/analytics/v2.4.ts | 112 +- src/apis/analytics/v3.ts | 1015 +- src/apis/analyticsreporting/v4.ts | 4 +- src/apis/androiddeviceprovisioning/v1.ts | 232 +- src/apis/androidenterprise/v1.ts | 611 +- src/apis/androidmanagement/v1.ts | 165 +- src/apis/androidpublisher/v1.1.ts | 39 +- src/apis/androidpublisher/v1.ts | 27 +- src/apis/androidpublisher/v2.ts | 529 +- src/apis/androidpublisher/v3.ts | 459 +- src/apis/appengine/v1.ts | 425 +- src/apis/appengine/v1alpha.ts | 159 +- src/apis/appengine/v1beta.ts | 433 +- src/apis/appengine/v1beta4.ts | 246 +- src/apis/appengine/v1beta5.ts | 247 +- src/apis/appsactivity/v1.ts | 30 +- src/apis/appstate/v1.ts | 28 +- src/apis/bigquery/v2.ts | 292 +- src/apis/bigquerydatatransfer/v1.ts | 360 +- .../README.md | 6 +- .../index.ts | 19 +- .../package.json | 4 +- src/apis/binaryauthorization/v1beta1.ts | 1590 + src/apis/blogger/v2.ts | 50 +- src/apis/blogger/v3.ts | 319 +- src/apis/books/v1.ts | 635 +- src/apis/calendar/v3.ts | 781 +- src/apis/chat/v1.ts | 77 +- src/apis/civicinfo/v2.ts | 74 +- src/apis/classroom/v1.ts | 579 +- src/apis/cloudbilling/v1.ts | 215 +- src/apis/cloudbuild/README.md | 2 +- src/apis/cloudbuild/v1.ts | 94 +- src/apis/clouddebugger/v2.ts | 107 +- src/apis/clouderrorreporting/v1beta1.ts | 118 +- src/apis/cloudfunctions/v1.ts | 80 +- src/apis/cloudfunctions/v1beta2.ts | 73 +- src/apis/cloudiot/v1.ts | 1224 +- src/apis/cloudkms/v1.ts | 706 +- src/apis/cloudprofiler/v2.ts | 18 +- src/apis/cloudresourcemanager/v1.ts | 309 +- src/apis/cloudresourcemanager/v1beta1.ts | 191 +- src/apis/cloudresourcemanager/v2.ts | 128 +- src/apis/cloudresourcemanager/v2beta1.ts | 128 +- src/apis/cloudshell/v1.ts | 19 +- src/apis/cloudshell/v1alpha1.ts | 146 +- src/apis/cloudtasks/v2beta2.ts | 523 +- src/apis/cloudtrace/v1.ts | 80 +- src/apis/cloudtrace/v2.ts | 29 +- src/apis/composer/index.ts | 9 +- src/apis/composer/v1.ts | 1343 + src/apis/composer/v1beta1.ts | 150 +- src/apis/compute/alpha.ts | 18733 ++++++---- src/apis/compute/beta.ts | 8791 ++++- src/apis/compute/v1.ts | 7653 +++- src/apis/container/v1.ts | 926 +- src/apis/container/v1beta1.ts | 1053 +- src/apis/content/v2.ts | 1032 +- src/apis/content/v2sandbox.ts | 313 +- src/apis/customsearch/v1.ts | 155 +- src/apis/dataflow/v1b3.ts | 317 +- src/apis/dataproc/v1.ts | 243 +- src/apis/dataproc/v1beta2.ts | 622 +- src/apis/datastore/v1.ts | 91 +- src/apis/datastore/v1beta1.ts | 19 +- src/apis/datastore/v1beta3.ts | 43 +- src/apis/deploymentmanager/alpha.ts | 560 +- src/apis/deploymentmanager/v2.ts | 353 +- src/apis/deploymentmanager/v2beta.ts | 545 +- src/apis/dfareporting/index.ts | 10 +- src/apis/dfareporting/v2.8.ts | 2137 +- src/apis/dfareporting/v3.0.ts | 2091 +- src/apis/dfareporting/v3.1.ts | 2117 +- src/apis/dfareporting/v3.2.ts | 28877 ++++++++++++++++ src/apis/dialogflow/v2.ts | 618 +- src/apis/dialogflow/v2beta1.ts | 3658 +- src/apis/digitalassetlinks/v1.ts | 149 +- src/apis/discovery/v1.ts | 10 +- src/apis/dlp/v2.ts | 3573 +- src/apis/dns/v1.ts | 243 +- src/apis/dns/v1beta2.ts | 243 +- src/apis/dns/v2beta1.ts | 243 +- src/apis/doubleclickbidmanager/v1.ts | 31 +- src/apis/doubleclicksearch/v2.ts | 58 +- src/apis/drive/v2.ts | 710 +- src/apis/drive/v3.ts | 450 +- src/apis/firebasedynamiclinks/v1.ts | 25 +- src/apis/firebaserules/v1.ts | 117 +- src/apis/firestore/v1.ts | 717 +- src/apis/firestore/v1beta1.ts | 352 +- src/apis/firestore/v1beta2.ts | 191 +- src/apis/fitness/v1.ts | 194 +- src/apis/fusiontables/v1.ts | 255 +- src/apis/fusiontables/v2.ts | 287 +- src/apis/games/v1.ts | 541 +- .../gamesConfiguration/v1configuration.ts | 86 +- src/apis/gamesManagement/v1management.ts | 123 +- src/apis/genomics/v1.ts | 426 +- src/apis/genomics/v1alpha2.ts | 194 +- src/apis/genomics/v2alpha1.ts | 458 +- src/apis/gmail/v1.ts | 476 +- src/apis/groupsmigration/v1.ts | 4 +- src/apis/groupssettings/v1.ts | 10 +- src/apis/iam/v1.ts | 560 +- src/apis/iamcredentials/v1.ts | 46 +- src/apis/iap/v1beta1.ts | 224 +- src/apis/identitytoolkit/v3.ts | 112 +- src/apis/index.ts | 10 +- src/apis/indexing/v3.ts | 7 +- src/apis/jobs/README.md | 2 +- src/apis/jobs/index.ts | 9 +- src/apis/jobs/v2.ts | 187 +- src/apis/jobs/v3.ts | 3003 ++ src/apis/kgsearch/v1.ts | 22 +- src/apis/language/v1.ts | 22 +- src/apis/language/v1beta1.ts | 13 +- src/apis/language/v1beta2.ts | 22 +- src/apis/licensing/v1.ts | 46 +- src/apis/logging/v2.ts | 1155 +- src/apis/logging/v2beta1.ts | 264 +- src/apis/manufacturers/v1.ts | 76 +- src/apis/mirror/v1.ts | 121 +- src/apis/ml/v1.ts | 412 +- src/apis/monitoring/v3.ts | 571 +- src/apis/oauth2/v1.ts | 25 +- src/apis/oauth2/v2.ts | 13 +- src/apis/oslogin/v1.ts | 51 +- src/apis/oslogin/v1alpha.ts | 54 +- src/apis/oslogin/v1beta.ts | 51 +- src/apis/pagespeedonline/v1.ts | 16 +- src/apis/pagespeedonline/v2.ts | 16 +- src/apis/pagespeedonline/v4.ts | 22 +- src/apis/partners/v2.ts | 555 +- src/apis/people/v1.ts | 181 +- src/apis/playcustomapp/v1.ts | 4 +- src/apis/plus/v1.ts | 117 +- src/apis/plusDomains/v1.ts | 195 +- src/apis/poly/v1.ts | 120 +- src/apis/proximitybeacon/v1beta1.ts | 288 +- src/apis/pubsub/v1.ts | 328 +- src/apis/pubsub/v1beta1a.ts | 55 +- src/apis/pubsub/v1beta2.ts | 175 +- src/apis/redis/v1beta1.ts | 285 +- src/apis/replicapool/v1beta1.ts | 71 +- src/apis/replicapoolupdater/v1beta1.ts | 112 +- src/apis/reseller/v1.ts | 229 +- src/apis/runtimeconfig/v1.ts | 16 +- src/apis/runtimeconfig/v1beta1.ts | 260 +- src/apis/safebrowsing/v4.ts | 43 +- src/apis/script/v1.ts | 193 +- src/apis/searchconsole/v1.ts | 7 +- src/apis/servicebroker/v1.ts | 28 +- src/apis/servicebroker/v1alpha1.ts | 193 +- src/apis/servicebroker/v1beta1.ts | 237 +- src/apis/serviceconsumermanagement/v1.ts | 112 +- src/apis/servicecontrol/v1.ts | 219 +- src/apis/servicemanagement/v1.ts | 223 +- src/apis/serviceusage/v1.ts | 90 +- src/apis/serviceusage/v1beta1.ts | 78 +- src/apis/serviceuser/v1.ts | 55 +- src/apis/sheets/v4.ts | 189 +- src/apis/siteVerification/v1.ts | 37 +- src/apis/slides/v1.ts | 45 +- src/apis/sourcerepo/v1.ts | 73 +- src/apis/spanner/v1.ts | 329 +- src/apis/spectrum/v1explorer.ts | 1645 - src/apis/speech/v1.ts | 10 +- src/apis/speech/v1beta1.ts | 10 +- src/apis/sqladmin/README.md | 2 +- src/apis/sqladmin/v1beta3.ts | 237 +- src/apis/sqladmin/v1beta4.ts | 418 +- src/apis/storage/v1.ts | 911 +- src/apis/storage/v1beta1.ts | 179 +- src/apis/storage/v1beta2.ts | 469 +- src/apis/storagetransfer/v1.ts | 89 +- src/apis/streetviewpublish/v1.ts | 67 +- src/apis/surveys/v2.ts | 25 +- src/apis/tagmanager/v1.ts | 196 +- src/apis/tagmanager/v2.ts | 570 +- src/apis/tasks/v1.ts | 98 +- src/apis/testing/v1.ts | 33 +- src/apis/texttospeech/index.ts | 11 +- src/apis/texttospeech/v1.ts | 426 + src/apis/texttospeech/v1beta1.ts | 16 +- src/apis/toolresults/v1beta3.ts | 171 +- src/apis/tpu/v1.ts | 158 +- src/apis/tpu/v1alpha1.ts | 158 +- src/apis/translate/v2.ts | 45 +- src/apis/urlshortener/v1.ts | 13 +- src/apis/vault/v1.ts | 1146 +- src/apis/videointelligence/v1.ts | 28 +- src/apis/videointelligence/v1beta2.ts | 7 +- src/apis/vision/v1.ts | 2135 +- src/apis/vision/v1p1beta1.ts | 1076 +- src/apis/vision/v1p2beta1.ts | 2501 +- src/apis/webfonts/v1.ts | 4 +- src/apis/webmasters/v3.ts | 127 +- src/apis/websecurityscanner/v1alpha.ts | 168 +- src/apis/youtube/v3.ts | 2175 +- src/apis/youtubeAnalytics/v1.ts | 189 +- src/apis/youtubeAnalytics/v1beta1.ts | 189 +- src/apis/youtubeAnalytics/v2.ts | 200 +- src/apis/youtubereporting/v1.ts | 103 +- src/generator/templates/package.json.njk | 2 +- src/index.ts | 6 +- 220 files changed, 111079 insertions(+), 26824 deletions(-) rename src/apis/{spectrum => binaryauthorization}/README.md (83%) rename src/apis/{spectrum => binaryauthorization}/index.ts (55%) rename src/apis/{spectrum => binaryauthorization}/package.json (86%) create mode 100644 src/apis/binaryauthorization/v1beta1.ts create mode 100644 src/apis/composer/v1.ts create mode 100644 src/apis/dfareporting/v3.2.ts create mode 100644 src/apis/jobs/v3.ts delete mode 100644 src/apis/spectrum/v1explorer.ts create mode 100644 src/apis/texttospeech/v1.ts diff --git a/src/apis/abusiveexperiencereport/v1.ts b/src/apis/abusiveexperiencereport/v1.ts index 1beefefea1e..d47a9488841 100644 --- a/src/apis/abusiveexperiencereport/v1.ts +++ b/src/apis/abusiveexperiencereport/v1.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -132,8 +131,16 @@ export namespace abusiveexperiencereport_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The required site name. This is the site property whose abusive experiences have been reviewed, and it must be URL-encoded. For example, sites/https%3A%2F%2Fwww.google.com. The server will return an error of BAD_REQUEST if this field is not filled in. Note that if the site property is not yet verified in Search Console, the reportUrl field returned by the API will lead to the verification page, prompting the user to go through that process before they can gain access to the Abusive Experience Report. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.name The required site name. This is the site + * property whose abusive experiences have been reviewed, and it must be + * URL-encoded. For example, sites/https%3A%2F%2Fwww.google.com. The + * server will return an error of BAD_REQUEST if this field is not + * filled in. Note that if the site property is not yet verified in + * Search Console, the reportUrl field returned by the API will lead to + * the verification page, prompting the user to go through that process + * before they can gain access to the Abusive Experience Report. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -226,7 +233,8 @@ export namespace abusiveexperiencereport_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/acceleratedmobilepageurl/v1.ts b/src/apis/acceleratedmobilepageurl/v1.ts index 702d5875b81..72afbc10012 100644 --- a/src/apis/acceleratedmobilepageurl/v1.ts +++ b/src/apis/acceleratedmobilepageurl/v1.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -155,7 +154,8 @@ export namespace acceleratedmobilepageurl_v1 { * * @param {object} params Parameters for request * @param {().BatchGetAmpUrlsRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/adexchangebuyer/v1.2.ts b/src/apis/adexchangebuyer/v1.2.ts index 3513c4ffc0d..e889d194b0c 100644 --- a/src/apis/adexchangebuyer/v1.2.ts +++ b/src/apis/adexchangebuyer/v1.2.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -280,7 +279,8 @@ export namespace adexchangebuyer_v1_2 { * * @param {object} params Parameters for request * @param {integer} params.id The account id - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -340,7 +340,8 @@ export namespace adexchangebuyer_v1_2 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -406,7 +407,8 @@ export namespace adexchangebuyer_v1_2 { * @param {object} params Parameters for request * @param {integer} params.id The account id * @param {().Account} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -471,7 +473,8 @@ export namespace adexchangebuyer_v1_2 { * @param {object} params Parameters for request * @param {integer} params.id The account id * @param {().Account} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -598,9 +601,12 @@ export namespace adexchangebuyer_v1_2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer} params.accountId The id for the account that will serve this creative. - * @param {string} params.buyerCreativeId The buyer-specific id for this creative. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer} params.accountId The id for the account that will serve + * this creative. + * @param {string} params.buyerCreativeId The buyer-specific id for this + * creative. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -663,7 +669,8 @@ export namespace adexchangebuyer_v1_2 { * * @param {object} params Parameters for request * @param {().Creative} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -727,10 +734,15 @@ export namespace adexchangebuyer_v1_2 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {integer=} params.maxResults Maximum number of entries returned on one result page. If not set, the default is 100. Optional. - * @param {string=} params.pageToken A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional. - * @param {string=} params.statusFilter When specified, only creatives having the given status are returned. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.maxResults Maximum number of entries returned on + * one result page. If not set, the default is 100. Optional. + * @param {string=} params.pageToken A continuation token, used to page + * through ad clients. To retrieve the next page, set this parameter to + * the value of "nextPageToken" from the previous response. Optional. + * @param {string=} params.statusFilter When specified, only creatives + * having the given status are returned. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/adexchangebuyer/v1.3.ts b/src/apis/adexchangebuyer/v1.3.ts index 2b1816287e6..7784e4cc6fc 100644 --- a/src/apis/adexchangebuyer/v1.3.ts +++ b/src/apis/adexchangebuyer/v1.3.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -689,7 +688,8 @@ export namespace adexchangebuyer_v1_3 { * * @param {object} params Parameters for request * @param {integer} params.id The account id - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -749,7 +749,8 @@ export namespace adexchangebuyer_v1_3 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -815,7 +816,8 @@ export namespace adexchangebuyer_v1_3 { * @param {object} params Parameters for request * @param {integer} params.id The account id * @param {().Account} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -880,7 +882,8 @@ export namespace adexchangebuyer_v1_3 { * @param {object} params Parameters for request * @param {integer} params.id The account id * @param {().Account} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1008,7 +1011,8 @@ export namespace adexchangebuyer_v1_3 { * * @param {object} params Parameters for request * @param {integer} params.accountId The account id. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1070,7 +1074,8 @@ export namespace adexchangebuyer_v1_3 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1166,9 +1171,12 @@ export namespace adexchangebuyer_v1_3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId The account id to get the budget information for. - * @param {string} params.billingId The billing id to get the budget information for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId The account id to get the budget + * information for. + * @param {string} params.billingId The billing id to get the budget + * information for. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1231,10 +1239,13 @@ export namespace adexchangebuyer_v1_3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId The account id associated with the budget being updated. - * @param {string} params.billingId The billing id associated with the budget being updated. + * @param {string} params.accountId The account id associated with the + * budget being updated. + * @param {string} params.billingId The billing id associated with the + * budget being updated. * @param {().Budget} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1299,10 +1310,13 @@ export namespace adexchangebuyer_v1_3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId The account id associated with the budget being updated. - * @param {string} params.billingId The billing id associated with the budget being updated. + * @param {string} params.accountId The account id associated with the + * budget being updated. + * @param {string} params.billingId The billing id associated with the + * budget being updated. * @param {().Budget} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1436,9 +1450,12 @@ export namespace adexchangebuyer_v1_3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer} params.accountId The id for the account that will serve this creative. - * @param {string} params.buyerCreativeId The buyer-specific id for this creative. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer} params.accountId The id for the account that will serve + * this creative. + * @param {string} params.buyerCreativeId The buyer-specific id for this + * creative. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1501,7 +1518,8 @@ export namespace adexchangebuyer_v1_3 { * * @param {object} params Parameters for request * @param {().Creative} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1565,12 +1583,19 @@ export namespace adexchangebuyer_v1_3 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {integer=} params.accountId When specified, only creatives for the given account ids are returned. - * @param {string=} params.buyerCreativeId When specified, only creatives for the given buyer creative ids are returned. - * @param {integer=} params.maxResults Maximum number of entries returned on one result page. If not set, the default is 100. Optional. - * @param {string=} params.pageToken A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional. - * @param {string=} params.statusFilter When specified, only creatives having the given status are returned. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.accountId When specified, only creatives for the + * given account ids are returned. + * @param {string=} params.buyerCreativeId When specified, only creatives + * for the given buyer creative ids are returned. + * @param {integer=} params.maxResults Maximum number of entries returned on + * one result page. If not set, the default is 100. Optional. + * @param {string=} params.pageToken A continuation token, used to page + * through ad clients. To retrieve the next page, set this parameter to + * the value of "nextPageToken" from the previous response. Optional. + * @param {string=} params.statusFilter When specified, only creatives + * having the given status are returned. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1707,7 +1732,8 @@ export namespace adexchangebuyer_v1_3 { * * @param {object} params Parameters for request * @param {string} params.id The direct deal id - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1768,7 +1794,8 @@ export namespace adexchangebuyer_v1_3 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1864,11 +1891,18 @@ export namespace adexchangebuyer_v1_3 { * * @param {object} params Parameters for request * @param {string} params.accountId The account id to get the reports. - * @param {string} params.endDateTime The end time of the report in ISO 8601 timestamp format using UTC. - * @param {integer=} params.maxResults Maximum number of entries returned on one result page. If not set, the default is 100. Optional. - * @param {string=} params.pageToken A continuation token, used to page through performance reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional. - * @param {string} params.startDateTime The start time of the report in ISO 8601 timestamp format using UTC. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.endDateTime The end time of the report in ISO 8601 + * timestamp format using UTC. + * @param {integer=} params.maxResults Maximum number of entries returned on + * one result page. If not set, the default is 100. Optional. + * @param {string=} params.pageToken A continuation token, used to page + * through performance reports. To retrieve the next page, set this + * parameter to the value of "nextPageToken" from the previous response. + * Optional. + * @param {string} params.startDateTime The start time of the report in ISO + * 8601 timestamp format using UTC. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1979,9 +2013,12 @@ export namespace adexchangebuyer_v1_3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId The account id to delete the pretargeting config for. - * @param {string} params.configId The specific id of the configuration to delete. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId The account id to delete the + * pretargeting config for. + * @param {string} params.configId The specific id of the configuration to + * delete. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2047,9 +2084,12 @@ export namespace adexchangebuyer_v1_3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId The account id to get the pretargeting config for. - * @param {string} params.configId The specific id of the configuration to retrieve. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId The account id to get the pretargeting + * config for. + * @param {string} params.configId The specific id of the configuration to + * retrieve. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2113,9 +2153,11 @@ export namespace adexchangebuyer_v1_3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId The account id to insert the pretargeting config for. + * @param {string} params.accountId The account id to insert the + * pretargeting config for. * @param {().PretargetingConfig} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2183,8 +2225,10 @@ export namespace adexchangebuyer_v1_3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId The account id to get the pretargeting configs for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId The account id to get the pretargeting + * configs for. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2253,10 +2297,13 @@ export namespace adexchangebuyer_v1_3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId The account id to update the pretargeting config for. - * @param {string} params.configId The specific id of the configuration to update. + * @param {string} params.accountId The account id to update the + * pretargeting config for. + * @param {string} params.configId The specific id of the configuration to + * update. * @param {().PretargetingConfig} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2324,10 +2371,13 @@ export namespace adexchangebuyer_v1_3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId The account id to update the pretargeting config for. - * @param {string} params.configId The specific id of the configuration to update. + * @param {string} params.accountId The account id to update the + * pretargeting config for. + * @param {string} params.configId The specific id of the configuration to + * update. * @param {().PretargetingConfig} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/adexchangebuyer/v1.4.ts b/src/apis/adexchangebuyer/v1.4.ts index 4d81d2e7c48..995bbfac096 100644 --- a/src/apis/adexchangebuyer/v1.4.ts +++ b/src/apis/adexchangebuyer/v1.4.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -669,8 +668,8 @@ export namespace adexchangebuyer_v1_4 { } /** * This message carries publisher provided breakdown. E.g. {dimension_type: - * 'COUNTRY', [{dimension_value: {id: 1, name: 'US'}}, - * {dimension_value: {id: 2, name: 'UK'}}]} + * 'COUNTRY', [{dimension_value: {id: 1, name: + * 'US'}}, {dimension_value: {id: 2, name: 'UK'}}]} */ export interface Schema$Dimension { dimensionType?: string; @@ -1770,7 +1769,8 @@ export namespace adexchangebuyer_v1_4 { * * @param {object} params Parameters for request * @param {integer} params.id The account id - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1830,7 +1830,8 @@ export namespace adexchangebuyer_v1_4 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1894,10 +1895,12 @@ export namespace adexchangebuyer_v1_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.confirmUnsafeAccountChange Confirmation for erasing bidder and cookie matching urls. + * @param {boolean=} params.confirmUnsafeAccountChange Confirmation for + * erasing bidder and cookie matching urls. * @param {integer} params.id The account id * @param {().Account} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1960,10 +1963,12 @@ export namespace adexchangebuyer_v1_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.confirmUnsafeAccountChange Confirmation for erasing bidder and cookie matching urls. + * @param {boolean=} params.confirmUnsafeAccountChange Confirmation for + * erasing bidder and cookie matching urls. * @param {integer} params.id The account id * @param {().Account} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2099,7 +2104,8 @@ export namespace adexchangebuyer_v1_4 { * * @param {object} params Parameters for request * @param {integer} params.accountId The account id. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2161,7 +2167,8 @@ export namespace adexchangebuyer_v1_4 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2257,9 +2264,12 @@ export namespace adexchangebuyer_v1_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId The account id to get the budget information for. - * @param {string} params.billingId The billing id to get the budget information for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId The account id to get the budget + * information for. + * @param {string} params.billingId The billing id to get the budget + * information for. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2322,10 +2332,13 @@ export namespace adexchangebuyer_v1_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId The account id associated with the budget being updated. - * @param {string} params.billingId The billing id associated with the budget being updated. + * @param {string} params.accountId The account id associated with the + * budget being updated. + * @param {string} params.billingId The billing id associated with the + * budget being updated. * @param {().Budget} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2390,10 +2403,13 @@ export namespace adexchangebuyer_v1_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId The account id associated with the budget being updated. - * @param {string} params.billingId The billing id associated with the budget being updated. + * @param {string} params.accountId The account id associated with the + * budget being updated. + * @param {string} params.billingId The billing id associated with the + * budget being updated. * @param {().Budget} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2526,10 +2542,14 @@ export namespace adexchangebuyer_v1_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer} params.accountId The id for the account that will serve this creative. - * @param {string} params.buyerCreativeId The buyer-specific id for this creative. - * @param {string} params.dealId The id of the deal id to associate with this creative. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer} params.accountId The id for the account that will serve + * this creative. + * @param {string} params.buyerCreativeId The buyer-specific id for this + * creative. + * @param {string} params.dealId The id of the deal id to associate with + * this creative. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2596,9 +2616,12 @@ export namespace adexchangebuyer_v1_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer} params.accountId The id for the account that will serve this creative. - * @param {string} params.buyerCreativeId The buyer-specific id for this creative. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer} params.accountId The id for the account that will serve + * this creative. + * @param {string} params.buyerCreativeId The buyer-specific id for this + * creative. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2661,7 +2684,8 @@ export namespace adexchangebuyer_v1_4 { * * @param {object} params Parameters for request * @param {().Creative} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2725,13 +2749,21 @@ export namespace adexchangebuyer_v1_4 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {integer=} params.accountId When specified, only creatives for the given account ids are returned. - * @param {string=} params.buyerCreativeId When specified, only creatives for the given buyer creative ids are returned. - * @param {string=} params.dealsStatusFilter When specified, only creatives having the given deals status are returned. - * @param {integer=} params.maxResults Maximum number of entries returned on one result page. If not set, the default is 100. Optional. - * @param {string=} params.openAuctionStatusFilter When specified, only creatives having the given open auction status are returned. - * @param {string=} params.pageToken A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.accountId When specified, only creatives for the + * given account ids are returned. + * @param {string=} params.buyerCreativeId When specified, only creatives + * for the given buyer creative ids are returned. + * @param {string=} params.dealsStatusFilter When specified, only creatives + * having the given deals status are returned. + * @param {integer=} params.maxResults Maximum number of entries returned on + * one result page. If not set, the default is 100. Optional. + * @param {string=} params.openAuctionStatusFilter When specified, only + * creatives having the given open auction status are returned. + * @param {string=} params.pageToken A continuation token, used to page + * through ad clients. To retrieve the next page, set this parameter to + * the value of "nextPageToken" from the previous response. Optional. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2795,9 +2827,12 @@ export namespace adexchangebuyer_v1_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer} params.accountId The id for the account that will serve this creative. - * @param {string} params.buyerCreativeId The buyer-specific id for this creative. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer} params.accountId The id for the account that will serve + * this creative. + * @param {string} params.buyerCreativeId The buyer-specific id for this + * creative. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2865,10 +2900,14 @@ export namespace adexchangebuyer_v1_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer} params.accountId The id for the account that will serve this creative. - * @param {string} params.buyerCreativeId The buyer-specific id for this creative. - * @param {string} params.dealId The id of the deal id to disassociate with this creative. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer} params.accountId The id for the account that will serve + * this creative. + * @param {string} params.buyerCreativeId The buyer-specific id for this + * creative. + * @param {string} params.dealId The id of the deal id to disassociate with + * this creative. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3067,7 +3106,8 @@ export namespace adexchangebuyer_v1_4 { * @param {object} params Parameters for request * @param {string} params.proposalId The proposalId to delete deals from. * @param {().DeleteOrderDealsRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3136,9 +3176,11 @@ export namespace adexchangebuyer_v1_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.proposalId proposalId for which deals need to be added. + * @param {string} params.proposalId proposalId for which deals need to be + * added. * @param {().AddOrderDealsRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3207,8 +3249,11 @@ export namespace adexchangebuyer_v1_4 { * * @param {object} params Parameters for request * @param {string=} params.pqlQuery Query string to retrieve specific deals. - * @param {string} params.proposalId The proposalId to get deals for. To search across all proposals specify order_id = '-' as part of the URL. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.proposalId The proposalId to get deals for. To + * search across all proposals specify order_id = '-' as part of the + * URL. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3278,7 +3323,8 @@ export namespace adexchangebuyer_v1_4 { * @param {object} params Parameters for request * @param {string} params.proposalId The proposalId to edit deals on. * @param {().EditAllOrderDealsRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3429,7 +3475,8 @@ export namespace adexchangebuyer_v1_4 { * @param {object} params Parameters for request * @param {string} params.proposalId The proposalId to add notes for. * @param {().AddOrderNotesRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3497,9 +3544,14 @@ export namespace adexchangebuyer_v1_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.pqlQuery Query string to retrieve specific notes. To search the text contents of notes, please use syntax like "WHERE note.note = "foo" or "WHERE note.note LIKE "%bar%" - * @param {string} params.proposalId The proposalId to get notes for. To search across all proposals specify order_id = '-' as part of the URL. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pqlQuery Query string to retrieve specific notes. + * To search the text contents of notes, please use syntax like "WHERE + * note.note = "foo" or "WHERE note.note LIKE "%bar%" + * @param {string} params.proposalId The proposalId to get notes for. To + * search across all proposals specify order_id = '-' as part of the + * URL. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3615,9 +3667,12 @@ export namespace adexchangebuyer_v1_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.privateAuctionId The private auction id to be updated. - * @param {().UpdatePrivateAuctionProposalRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.privateAuctionId The private auction id to be + * updated. + * @param {().UpdatePrivateAuctionProposalRequest} params.resource Request + * body data + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3715,11 +3770,18 @@ export namespace adexchangebuyer_v1_4 { * * @param {object} params Parameters for request * @param {string} params.accountId The account id to get the reports. - * @param {string} params.endDateTime The end time of the report in ISO 8601 timestamp format using UTC. - * @param {integer=} params.maxResults Maximum number of entries returned on one result page. If not set, the default is 100. Optional. - * @param {string=} params.pageToken A continuation token, used to page through performance reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional. - * @param {string} params.startDateTime The start time of the report in ISO 8601 timestamp format using UTC. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.endDateTime The end time of the report in ISO 8601 + * timestamp format using UTC. + * @param {integer=} params.maxResults Maximum number of entries returned on + * one result page. If not set, the default is 100. Optional. + * @param {string=} params.pageToken A continuation token, used to page + * through performance reports. To retrieve the next page, set this + * parameter to the value of "nextPageToken" from the previous response. + * Optional. + * @param {string} params.startDateTime The start time of the report in ISO + * 8601 timestamp format using UTC. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3830,9 +3892,12 @@ export namespace adexchangebuyer_v1_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId The account id to delete the pretargeting config for. - * @param {string} params.configId The specific id of the configuration to delete. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId The account id to delete the + * pretargeting config for. + * @param {string} params.configId The specific id of the configuration to + * delete. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3898,9 +3963,12 @@ export namespace adexchangebuyer_v1_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId The account id to get the pretargeting config for. - * @param {string} params.configId The specific id of the configuration to retrieve. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId The account id to get the pretargeting + * config for. + * @param {string} params.configId The specific id of the configuration to + * retrieve. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3964,9 +4032,11 @@ export namespace adexchangebuyer_v1_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId The account id to insert the pretargeting config for. + * @param {string} params.accountId The account id to insert the + * pretargeting config for. * @param {().PretargetingConfig} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4034,8 +4104,10 @@ export namespace adexchangebuyer_v1_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId The account id to get the pretargeting configs for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId The account id to get the pretargeting + * configs for. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4104,10 +4176,13 @@ export namespace adexchangebuyer_v1_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId The account id to update the pretargeting config for. - * @param {string} params.configId The specific id of the configuration to update. + * @param {string} params.accountId The account id to update the + * pretargeting config for. + * @param {string} params.configId The specific id of the configuration to + * update. * @param {().PretargetingConfig} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4175,10 +4250,13 @@ export namespace adexchangebuyer_v1_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId The account id to update the pretargeting config for. - * @param {string} params.configId The specific id of the configuration to update. + * @param {string} params.accountId The account id to update the + * pretargeting config for. + * @param {string} params.configId The specific id of the configuration to + * update. * @param {().PretargetingConfig} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4357,8 +4435,10 @@ export namespace adexchangebuyer_v1_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.productId The id for the product to get the head revision for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.productId The id for the product to get the head + * revision for. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4418,8 +4498,10 @@ export namespace adexchangebuyer_v1_4 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {string=} params.pqlQuery The pql query used to query for products. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pqlQuery The pql query used to query for + * products. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4520,7 +4602,8 @@ export namespace adexchangebuyer_v1_4 { * * @param {object} params Parameters for request * @param {string} params.proposalId Id of the proposal to retrieve. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4581,7 +4664,8 @@ export namespace adexchangebuyer_v1_4 { * * @param {object} params Parameters for request * @param {().CreateOrdersRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4647,10 +4731,17 @@ export namespace adexchangebuyer_v1_4 { * * @param {object} params Parameters for request * @param {string} params.proposalId The proposal id to update. - * @param {string} params.revisionNumber The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the latest proposal at head revision and retry the update at that revision. - * @param {string} params.updateAction The proposed action to take on the proposal. This field is required and it must be set when updating a proposal. + * @param {string} params.revisionNumber The last known revision number to + * update. If the head revision in the marketplace database has since + * changed, an error will be thrown. The caller should then fetch the + * latest proposal at head revision and retry the update at that + * revision. + * @param {string} params.updateAction The proposed action to take on the + * proposal. This field is required and it must be set when updating a + * proposal. * @param {().Proposal} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4715,8 +4806,10 @@ export namespace adexchangebuyer_v1_4 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {string=} params.pqlQuery Query string to retrieve specific proposals. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pqlQuery Query string to retrieve specific + * proposals. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4781,8 +4874,10 @@ export namespace adexchangebuyer_v1_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.proposalId The proposal id for which the setup is complete - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.proposalId The proposal id for which the setup is + * complete + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4849,10 +4944,17 @@ export namespace adexchangebuyer_v1_4 { * * @param {object} params Parameters for request * @param {string} params.proposalId The proposal id to update. - * @param {string} params.revisionNumber The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the latest proposal at head revision and retry the update at that revision. - * @param {string} params.updateAction The proposed action to take on the proposal. This field is required and it must be set when updating a proposal. + * @param {string} params.revisionNumber The last known revision number to + * update. If the head revision in the marketplace database has since + * changed, an error will be thrown. The caller should then fetch the + * latest proposal at head revision and retry the update at that + * revision. + * @param {string} params.updateAction The proposed action to take on the + * proposal. This field is required and it must be set when updating a + * proposal. * @param {().Proposal} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5032,8 +5134,10 @@ export namespace adexchangebuyer_v1_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer} params.accountId The accountId of the publisher to get profiles for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer} params.accountId The accountId of the publisher to get + * profiles for. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/adexchangebuyer2/v2beta1.ts b/src/apis/adexchangebuyer2/v2beta1.ts index 6bde973223e..9dde555a537 100644 --- a/src/apis/adexchangebuyer2/v2beta1.ts +++ b/src/apis/adexchangebuyer2/v2beta1.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -334,7 +333,7 @@ export namespace adexchangebuyer2_v2beta1 { type?: string; } /** - * A creative and its classification data. Next ID: 36 + * A creative and its classification data. Next ID: 37 */ export interface Schema$Creative { /** @@ -364,7 +363,7 @@ export namespace adexchangebuyer2_v2beta1 { */ attributes?: string[]; /** - * The set of destination URLs for the creative. + * The set of declared destination URLs for the creative. */ clickThroughUrls?: string[]; /** @@ -1345,9 +1344,12 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to create a client for. (required) + * @param {string} params.accountId Unique numerical account ID for the + * buyer of which the client buyer is a customer; the sponsor buyer to + * create a client for. (required) * @param {().Client} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1413,9 +1415,12 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Numerical account ID of the client's sponsor buyer. (required) - * @param {string} params.clientAccountId Numerical account ID of the client buyer to retrieve. (required) - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Numerical account ID of the client's + * sponsor buyer. (required) + * @param {string} params.clientAccountId Numerical account ID of the client + * buyer to retrieve. (required) + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1478,11 +1483,21 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Unique numerical account ID of the sponsor buyer to list the clients for. - * @param {integer=} params.pageSize Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListClientsResponse.nextPageToken returned from the previous call to the accounts.clients.list method. - * @param {string=} params.partnerClientId Optional unique identifier (from the standpoint of an Ad Exchange sponsor buyer partner) of the client to return. If specified, at most one client will be returned in the response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Unique numerical account ID of the + * sponsor buyer to list the clients for. + * @param {integer=} params.pageSize Requested page size. The server may + * return fewer clients than requested. If unspecified, the server will + * pick an appropriate default. + * @param {string=} params.pageToken A token identifying a page of results + * the server should return. Typically, this is the value of + * ListClientsResponse.nextPageToken returned from the previous call to + * the accounts.clients.list method. + * @param {string=} params.partnerClientId Optional unique identifier (from + * the standpoint of an Ad Exchange sponsor buyer partner) of the client + * to return. If specified, at most one client will be returned in the + * response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1549,10 +1564,14 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to update a client for. (required) - * @param {string} params.clientAccountId Unique numerical account ID of the client to update. (required) + * @param {string} params.accountId Unique numerical account ID for the + * buyer of which the client buyer is a customer; the sponsor buyer to + * update a client for. (required) + * @param {string} params.clientAccountId Unique numerical account ID of the + * client to update. (required) * @param {().Client} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1714,10 +1733,13 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Numerical account ID of the client's sponsor buyer. (required) - * @param {string} params.clientAccountId Numerical account ID of the client buyer that the user should be associated with. (required) + * @param {string} params.accountId Numerical account ID of the client's + * sponsor buyer. (required) + * @param {string} params.clientAccountId Numerical account ID of the client + * buyer that the user should be associated with. (required) * @param {().ClientUserInvitation} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1787,10 +1809,15 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Numerical account ID of the client's sponsor buyer. (required) - * @param {string} params.clientAccountId Numerical account ID of the client buyer that the user invitation to be retrieved is associated with. (required) - * @param {string} params.invitationId Numerical identifier of the user invitation to retrieve. (required) - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Numerical account ID of the client's + * sponsor buyer. (required) + * @param {string} params.clientAccountId Numerical account ID of the client + * buyer that the user invitation to be retrieved is associated with. + * (required) + * @param {string} params.invitationId Numerical identifier of the user + * invitation to retrieve. (required) + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1857,11 +1884,22 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Numerical account ID of the client's sponsor buyer. (required) - * @param {string} params.clientAccountId Numerical account ID of the client buyer to list invitations for. (required) You must either specify a string representation of a numerical account identifier or the `-` character to list all the invitations for all the clients of a given sponsor buyer. - * @param {integer=} params.pageSize Requested page size. Server may return fewer clients than requested. If unspecified, server will pick an appropriate default. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListClientUserInvitationsResponse.nextPageToken returned from the previous call to the clients.invitations.list method. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Numerical account ID of the client's + * sponsor buyer. (required) + * @param {string} params.clientAccountId Numerical account ID of the client + * buyer to list invitations for. (required) You must either specify a + * string representation of a numerical account identifier or the `-` + * character to list all the invitations for all the clients of a given + * sponsor buyer. + * @param {integer=} params.pageSize Requested page size. Server may return + * fewer clients than requested. If unspecified, server will pick an + * appropriate default. + * @param {string=} params.pageToken A token identifying a page of results + * the server should return. Typically, this is the value of + * ListClientUserInvitationsResponse.nextPageToken returned from the + * previous call to the clients.invitations.list method. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2026,10 +2064,14 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Numerical account ID of the client's sponsor buyer. (required) - * @param {string} params.clientAccountId Numerical account ID of the client buyer that the user to be retrieved is associated with. (required) - * @param {string} params.userId Numerical identifier of the user to retrieve. (required) - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Numerical account ID of the client's + * sponsor buyer. (required) + * @param {string} params.clientAccountId Numerical account ID of the client + * buyer that the user to be retrieved is associated with. (required) + * @param {string} params.userId Numerical identifier of the user to + * retrieve. (required) + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2095,11 +2137,22 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Numerical account ID of the sponsor buyer of the client to list users for. (required) - * @param {string} params.clientAccountId The account ID of the client buyer to list users for. (required) You must specify either a string representation of a numerical account identifier or the `-` character to list all the client users for all the clients of a given sponsor buyer. - * @param {integer=} params.pageSize Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListClientUsersResponse.nextPageToken returned from the previous call to the accounts.clients.users.list method. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Numerical account ID of the sponsor + * buyer of the client to list users for. (required) + * @param {string} params.clientAccountId The account ID of the client buyer + * to list users for. (required) You must specify either a string + * representation of a numerical account identifier or the `-` character + * to list all the client users for all the clients of a given sponsor + * buyer. + * @param {integer=} params.pageSize Requested page size. The server may + * return fewer clients than requested. If unspecified, the server will + * pick an appropriate default. + * @param {string=} params.pageToken A token identifying a page of results + * the server should return. Typically, this is the value of + * ListClientUsersResponse.nextPageToken returned from the previous call + * to the accounts.clients.users.list method. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2170,11 +2223,15 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Numerical account ID of the client's sponsor buyer. (required) - * @param {string} params.clientAccountId Numerical account ID of the client buyer that the user to be retrieved is associated with. (required) - * @param {string} params.userId Numerical identifier of the user to retrieve. (required) + * @param {string} params.accountId Numerical account ID of the client's + * sponsor buyer. (required) + * @param {string} params.clientAccountId Numerical account ID of the client + * buyer that the user to be retrieved is associated with. (required) + * @param {string} params.userId Numerical identifier of the user to + * retrieve. (required) * @param {().ClientUser} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2337,10 +2394,14 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId The account that this creative belongs to. Can be used to filter the response of the creatives.list method. - * @param {string=} params.duplicateIdMode Indicates if multiple creatives can share an ID or not. Default is NO_DUPLICATES (one ID per creative). + * @param {string} params.accountId The account that this creative belongs + * to. Can be used to filter the response of the creatives.list method. + * @param {string=} params.duplicateIdMode Indicates if multiple creatives + * can share an ID or not. Default is NO_DUPLICATES (one ID per + * creative). * @param {().Creative} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2408,7 +2469,8 @@ export namespace adexchangebuyer2_v2beta1 { * @param {object} params Parameters for request * @param {string} params.accountId The account the creative belongs to. * @param {string} params.creativeId The ID of the creative to retrieve. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2471,11 +2533,31 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId The account to list the creatives from. Specify "-" to list all creatives the current user has access to. - * @param {integer=} params.pageSize Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available via another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListCreativesResponse.next_page_token returned from the previous call to 'ListCreatives' method. - * @param {string=} params.query An optional query string to filter creatives. If no filter is specified, all active creatives will be returned.

Supported queries are:

Example: 'accountId=12345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR attribute:47' - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId The account to list the creatives from. + * Specify "-" to list all creatives the current user has access to. + * @param {integer=} params.pageSize Requested page size. The server may + * return fewer creatives than requested (due to timeout constraint) + * even if more are available via another call. If unspecified, server + * will pick an appropriate default. Acceptable values are 1 to 1000, + * inclusive. + * @param {string=} params.pageToken A token identifying a page of results + * the server should return. Typically, this is the value of + * ListCreativesResponse.next_page_token returned from the previous call + * to 'ListCreatives' method. + * @param {string=} params.query An optional query string to filter + * creatives. If no filter is specified, all active creatives will be + * returned.

Supported queries are:

+ * Example: 'accountId=12345 AND (dealsStatus:disapproved AND + * disapprovalReason:unacceptable_content) OR attribute:47' + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2544,10 +2626,14 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId The account of the creative to stop notifications for. - * @param {string} params.creativeId The creative ID of the creative to stop notifications for. Specify "-" to specify stopping account level notifications. + * @param {string} params.accountId The account of the creative to stop + * notifications for. + * @param {string} params.creativeId The creative ID of the creative to stop + * notifications for. Specify "-" to specify stopping account level + * notifications. * @param {().StopWatchingCreativeRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2615,10 +2701,14 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId The account that this creative belongs to. Can be used to filter the response of the creatives.list method. - * @param {string} params.creativeId The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method. + * @param {string} params.accountId The account that this creative belongs + * to. Can be used to filter the response of the creatives.list method. + * @param {string} params.creativeId The buyer-defined creative ID of this + * creative. Can be used to filter the response of the creatives.list + * method. * @param {().Creative} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2687,9 +2777,14 @@ export namespace adexchangebuyer2_v2beta1 { * * @param {object} params Parameters for request * @param {string} params.accountId The account of the creative to watch. - * @param {string} params.creativeId The creative ID to watch for status changes. Specify "-" to watch all creatives under the above account. If both creative-level and account-level notifications are sent, only a single notification will be sent to the creative-level notification topic. + * @param {string} params.creativeId The creative ID to watch for status + * changes. Specify "-" to watch all creatives under the above account. + * If both creative-level and account-level notifications are sent, only + * a single notification will be sent to the creative-level notification + * topic. * @param {().WatchCreativeRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2912,9 +3007,11 @@ export namespace adexchangebuyer2_v2beta1 { * * @param {object} params Parameters for request * @param {string} params.accountId The account the creative belongs to. - * @param {string} params.creativeId The ID of the creative associated with the deal. + * @param {string} params.creativeId The ID of the creative associated with + * the deal. * @param {().AddDealAssociationRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2979,12 +3076,31 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId The account to list the associations from. Specify "-" to list all creatives the current user has access to. - * @param {string} params.creativeId The creative ID to list the associations from. Specify "-" to list all creatives under the above account. - * @param {integer=} params.pageSize Requested page size. Server may return fewer associations than requested. If unspecified, server will pick an appropriate default. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListDealAssociationsResponse.next_page_token returned from the previous call to 'ListDealAssociations' method. - * @param {string=} params.query An optional query string to filter deal associations. If no filter is specified, all associations will be returned. Supported queries are: Example: 'dealsId=12345 AND dealsStatus:disapproved' - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId The account to list the associations + * from. Specify "-" to list all creatives the current user has access + * to. + * @param {string} params.creativeId The creative ID to list the + * associations from. Specify "-" to list all creatives under the above + * account. + * @param {integer=} params.pageSize Requested page size. Server may return + * fewer associations than requested. If unspecified, server will pick + * an appropriate default. + * @param {string=} params.pageToken A token identifying a page of results + * the server should return. Typically, this is the value of + * ListDealAssociationsResponse.next_page_token returned from the + * previous call to 'ListDealAssociations' method. + * @param {string=} params.query An optional query string to filter deal + * associations. If no filter is specified, all associations will be + * returned. Supported queries are: Example: 'dealsId=12345 AND + * dealsStatus:disapproved' + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3062,9 +3178,12 @@ export namespace adexchangebuyer2_v2beta1 { * * @param {object} params Parameters for request * @param {string} params.accountId The account the creative belongs to. - * @param {string} params.creativeId The ID of the creative associated with the deal. - * @param {().RemoveDealAssociationRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.creativeId The ID of the creative associated with + * the deal. + * @param {().RemoveDealAssociationRequest} params.resource Request body + * data + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3290,10 +3409,20 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.isTransient Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after creation. - * @param {string} params.ownerName Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456` + * @param {boolean=} params.isTransient Whether the filter set is transient, + * or should be persisted indefinitely. By default, filter sets are not + * transient. If transient, it will be available for at least 1 hour + * after creation. + * @param {string} params.ownerName Name of the owner (bidder or account) of + * the filter set to be created. For example: - For a bidder-level + * filter set for bidder 123: `bidders/123` - For an account-level + * filter set for the buyer account representing bidder 123: + * `bidders/123/accounts/123` - For an account-level filter set for the + * child seat buyer account 456 whose bidder is 123: + * `bidders/123/accounts/456` * @param {().FilterSet} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3361,8 +3490,15 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.name Full name of the resource to delete. For + * example: - For a bidder-level filter set for bidder 123: + * `bidders/123/filterSets/abc` - For an account-level filter set for + * the buyer account representing bidder 123: + * `bidders/123/accounts/123/filterSets/abc` - For an account-level + * filter set for the child seat buyer account 456 whose bidder is + * 123: `bidders/123/accounts/456/filterSets/abc` + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3428,8 +3564,15 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.name Full name of the resource being requested. + * For example: - For a bidder-level filter set for bidder 123: + * `bidders/123/filterSets/abc` - For an account-level filter set for + * the buyer account representing bidder 123: + * `bidders/123/accounts/123/filterSets/abc` - For an account-level + * filter set for the child seat buyer account 456 whose bidder is + * 123: `bidders/123/accounts/456/filterSets/abc` + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3491,10 +3634,22 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.ownerName Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456` - * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListFilterSetsResponse.nextPageToken returned from the previous call to the accounts.filterSets.list method. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.ownerName Name of the owner (bidder or account) of + * the filter sets to be listed. For example: - For a bidder-level + * filter set for bidder 123: `bidders/123` - For an account-level + * filter set for the buyer account representing bidder 123: + * `bidders/123/accounts/123` - For an account-level filter set for the + * child seat buyer account 456 whose bidder is 123: + * `bidders/123/accounts/456` + * @param {integer=} params.pageSize Requested page size. The server may + * return fewer results than requested. If unspecified, the server will + * pick an appropriate default. + * @param {string=} params.pageToken A token identifying a page of results + * the server should return. Typically, this is the value of + * ListFilterSetsResponse.nextPageToken returned from the previous call + * to the accounts.filterSets.list method. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3661,10 +3816,22 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` - * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListBidMetricsResponse.nextPageToken returned from the previous call to the bidMetrics.list method. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.filterSetName Name of the filter set that should + * be applied to the requested metrics. For example: - For a + * bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` + * - For an account-level filter set for the buyer account representing + * bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + * account-level filter set for the child seat buyer account 456 whose + * bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {integer=} params.pageSize Requested page size. The server may + * return fewer results than requested. If unspecified, the server will + * pick an appropriate default. + * @param {string=} params.pageToken A token identifying a page of results + * the server should return. Typically, this is the value of + * ListBidMetricsResponse.nextPageToken returned from the previous call + * to the bidMetrics.list method. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3778,10 +3945,22 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` - * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListBidResponseErrorsResponse.nextPageToken returned from the previous call to the bidResponseErrors.list method. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.filterSetName Name of the filter set that should + * be applied to the requested metrics. For example: - For a + * bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` + * - For an account-level filter set for the buyer account representing + * bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + * account-level filter set for the child seat buyer account 456 whose + * bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {integer=} params.pageSize Requested page size. The server may + * return fewer results than requested. If unspecified, the server will + * pick an appropriate default. + * @param {string=} params.pageToken A token identifying a page of results + * the server should return. Typically, this is the value of + * ListBidResponseErrorsResponse.nextPageToken returned from the + * previous call to the bidResponseErrors.list method. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3906,10 +4085,22 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` - * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListBidResponsesWithoutBidsResponse.nextPageToken returned from the previous call to the bidResponsesWithoutBids.list method. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.filterSetName Name of the filter set that should + * be applied to the requested metrics. For example: - For a + * bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` + * - For an account-level filter set for the buyer account representing + * bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + * account-level filter set for the child seat buyer account 456 whose + * bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {integer=} params.pageSize Requested page size. The server may + * return fewer results than requested. If unspecified, the server will + * pick an appropriate default. + * @param {string=} params.pageToken A token identifying a page of results + * the server should return. Typically, this is the value of + * ListBidResponsesWithoutBidsResponse.nextPageToken returned from the + * previous call to the bidResponsesWithoutBids.list method. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4038,10 +4229,22 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` - * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidRequestsResponse.nextPageToken returned from the previous call to the filteredBidRequests.list method. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.filterSetName Name of the filter set that should + * be applied to the requested metrics. For example: - For a + * bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` + * - For an account-level filter set for the buyer account representing + * bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + * account-level filter set for the child seat buyer account 456 whose + * bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {integer=} params.pageSize Requested page size. The server may + * return fewer results than requested. If unspecified, the server will + * pick an appropriate default. + * @param {string=} params.pageToken A token identifying a page of results + * the server should return. Typically, this is the value of + * ListFilteredBidRequestsResponse.nextPageToken returned from the + * previous call to the filteredBidRequests.list method. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4172,10 +4375,22 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` - * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidsResponse.nextPageToken returned from the previous call to the filteredBids.list method. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.filterSetName Name of the filter set that should + * be applied to the requested metrics. For example: - For a + * bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` + * - For an account-level filter set for the buyer account representing + * bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + * account-level filter set for the child seat buyer account 456 whose + * bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {integer=} params.pageSize Requested page size. The server may + * return fewer results than requested. If unspecified, the server will + * pick an appropriate default. + * @param {string=} params.pageToken A token identifying a page of results + * the server should return. Typically, this is the value of + * ListFilteredBidsResponse.nextPageToken returned from the previous + * call to the filteredBids.list method. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4288,11 +4503,25 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer} params.creativeStatusId The ID of the creative status for which to retrieve a breakdown by creative. See [creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes). - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` - * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByCreativeResponse.nextPageToken returned from the previous call to the filteredBids.creatives.list method. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer} params.creativeStatusId The ID of the creative status + * for which to retrieve a breakdown by creative. See + * [creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes). + * @param {string} params.filterSetName Name of the filter set that should + * be applied to the requested metrics. For example: - For a + * bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` + * - For an account-level filter set for the buyer account representing + * bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + * account-level filter set for the child seat buyer account 456 whose + * bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {integer=} params.pageSize Requested page size. The server may + * return fewer results than requested. If unspecified, the server will + * pick an appropriate default. + * @param {string=} params.pageToken A token identifying a page of results + * the server should return. Typically, this is the value of + * ListCreativeStatusBreakdownByCreativeResponse.nextPageToken returned + * from the previous call to the filteredBids.creatives.list method. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4426,11 +4655,27 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer} params.creativeStatusId The ID of the creative status for which to retrieve a breakdown by detail. See [creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes). Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87. - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` - * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from the previous call to the filteredBids.details.list method. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer} params.creativeStatusId The ID of the creative status + * for which to retrieve a breakdown by detail. See + * [creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes). + * Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, + * and 87. + * @param {string} params.filterSetName Name of the filter set that should + * be applied to the requested metrics. For example: - For a + * bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` + * - For an account-level filter set for the buyer account representing + * bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + * account-level filter set for the child seat buyer account 456 whose + * bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {integer=} params.pageSize Requested page size. The server may + * return fewer results than requested. If unspecified, the server will + * pick an appropriate default. + * @param {string=} params.pageToken A token identifying a page of results + * the server should return. Typically, this is the value of + * ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned + * from the previous call to the filteredBids.details.list method. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4567,10 +4812,22 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` - * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListImpressionMetricsResponse.nextPageToken returned from the previous call to the impressionMetrics.list method. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.filterSetName Name of the filter set that should + * be applied to the requested metrics. For example: - For a + * bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` + * - For an account-level filter set for the buyer account representing + * bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + * account-level filter set for the child seat buyer account 456 whose + * bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {integer=} params.pageSize Requested page size. The server may + * return fewer results than requested. If unspecified, the server will + * pick an appropriate default. + * @param {string=} params.pageToken A token identifying a page of results + * the server should return. Typically, this is the value of + * ListImpressionMetricsResponse.nextPageToken returned from the + * previous call to the impressionMetrics.list method. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4693,10 +4950,22 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` - * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListLosingBidsResponse.nextPageToken returned from the previous call to the losingBids.list method. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.filterSetName Name of the filter set that should + * be applied to the requested metrics. For example: - For a + * bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` + * - For an account-level filter set for the buyer account representing + * bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + * account-level filter set for the child seat buyer account 456 whose + * bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {integer=} params.pageSize Requested page size. The server may + * return fewer results than requested. If unspecified, the server will + * pick an appropriate default. + * @param {string=} params.pageToken A token identifying a page of results + * the server should return. Typically, this is the value of + * ListLosingBidsResponse.nextPageToken returned from the previous call + * to the losingBids.list method. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4810,10 +5079,22 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` - * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListNonBillableWinningBidsResponse.nextPageToken returned from the previous call to the nonBillableWinningBids.list method. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.filterSetName Name of the filter set that should + * be applied to the requested metrics. For example: - For a + * bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` + * - For an account-level filter set for the buyer account representing + * bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + * account-level filter set for the child seat buyer account 456 whose + * bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {integer=} params.pageSize Requested page size. The server may + * return fewer results than requested. If unspecified, the server will + * pick an appropriate default. + * @param {string=} params.pageToken A token identifying a page of results + * the server should return. Typically, this is the value of + * ListNonBillableWinningBidsResponse.nextPageToken returned from the + * previous call to the nonBillableWinningBids.list method. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4964,10 +5245,20 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.isTransient Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after creation. - * @param {string} params.ownerName Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456` + * @param {boolean=} params.isTransient Whether the filter set is transient, + * or should be persisted indefinitely. By default, filter sets are not + * transient. If transient, it will be available for at least 1 hour + * after creation. + * @param {string} params.ownerName Name of the owner (bidder or account) of + * the filter set to be created. For example: - For a bidder-level + * filter set for bidder 123: `bidders/123` - For an account-level + * filter set for the buyer account representing bidder 123: + * `bidders/123/accounts/123` - For an account-level filter set for the + * child seat buyer account 456 whose bidder is 123: + * `bidders/123/accounts/456` * @param {().FilterSet} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5035,8 +5326,15 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.name Full name of the resource to delete. For + * example: - For a bidder-level filter set for bidder 123: + * `bidders/123/filterSets/abc` - For an account-level filter set for + * the buyer account representing bidder 123: + * `bidders/123/accounts/123/filterSets/abc` - For an account-level + * filter set for the child seat buyer account 456 whose bidder is + * 123: `bidders/123/accounts/456/filterSets/abc` + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5102,8 +5400,15 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.name Full name of the resource being requested. + * For example: - For a bidder-level filter set for bidder 123: + * `bidders/123/filterSets/abc` - For an account-level filter set for + * the buyer account representing bidder 123: + * `bidders/123/accounts/123/filterSets/abc` - For an account-level + * filter set for the child seat buyer account 456 whose bidder is + * 123: `bidders/123/accounts/456/filterSets/abc` + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5165,10 +5470,22 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.ownerName Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456` - * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListFilterSetsResponse.nextPageToken returned from the previous call to the accounts.filterSets.list method. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.ownerName Name of the owner (bidder or account) of + * the filter sets to be listed. For example: - For a bidder-level + * filter set for bidder 123: `bidders/123` - For an account-level + * filter set for the buyer account representing bidder 123: + * `bidders/123/accounts/123` - For an account-level filter set for the + * child seat buyer account 456 whose bidder is 123: + * `bidders/123/accounts/456` + * @param {integer=} params.pageSize Requested page size. The server may + * return fewer results than requested. If unspecified, the server will + * pick an appropriate default. + * @param {string=} params.pageToken A token identifying a page of results + * the server should return. Typically, this is the value of + * ListFilterSetsResponse.nextPageToken returned from the previous call + * to the accounts.filterSets.list method. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5335,10 +5652,22 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` - * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListBidMetricsResponse.nextPageToken returned from the previous call to the bidMetrics.list method. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.filterSetName Name of the filter set that should + * be applied to the requested metrics. For example: - For a + * bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` + * - For an account-level filter set for the buyer account representing + * bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + * account-level filter set for the child seat buyer account 456 whose + * bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {integer=} params.pageSize Requested page size. The server may + * return fewer results than requested. If unspecified, the server will + * pick an appropriate default. + * @param {string=} params.pageToken A token identifying a page of results + * the server should return. Typically, this is the value of + * ListBidMetricsResponse.nextPageToken returned from the previous call + * to the bidMetrics.list method. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5449,10 +5778,22 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` - * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListBidResponseErrorsResponse.nextPageToken returned from the previous call to the bidResponseErrors.list method. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.filterSetName Name of the filter set that should + * be applied to the requested metrics. For example: - For a + * bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` + * - For an account-level filter set for the buyer account representing + * bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + * account-level filter set for the child seat buyer account 456 whose + * bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {integer=} params.pageSize Requested page size. The server may + * return fewer results than requested. If unspecified, the server will + * pick an appropriate default. + * @param {string=} params.pageToken A token identifying a page of results + * the server should return. Typically, this is the value of + * ListBidResponseErrorsResponse.nextPageToken returned from the + * previous call to the bidResponseErrors.list method. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5573,10 +5914,22 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` - * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListBidResponsesWithoutBidsResponse.nextPageToken returned from the previous call to the bidResponsesWithoutBids.list method. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.filterSetName Name of the filter set that should + * be applied to the requested metrics. For example: - For a + * bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` + * - For an account-level filter set for the buyer account representing + * bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + * account-level filter set for the child seat buyer account 456 whose + * bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {integer=} params.pageSize Requested page size. The server may + * return fewer results than requested. If unspecified, the server will + * pick an appropriate default. + * @param {string=} params.pageToken A token identifying a page of results + * the server should return. Typically, this is the value of + * ListBidResponsesWithoutBidsResponse.nextPageToken returned from the + * previous call to the bidResponsesWithoutBids.list method. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5702,10 +6055,22 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` - * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidRequestsResponse.nextPageToken returned from the previous call to the filteredBidRequests.list method. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.filterSetName Name of the filter set that should + * be applied to the requested metrics. For example: - For a + * bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` + * - For an account-level filter set for the buyer account representing + * bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + * account-level filter set for the child seat buyer account 456 whose + * bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {integer=} params.pageSize Requested page size. The server may + * return fewer results than requested. If unspecified, the server will + * pick an appropriate default. + * @param {string=} params.pageToken A token identifying a page of results + * the server should return. Typically, this is the value of + * ListFilteredBidRequestsResponse.nextPageToken returned from the + * previous call to the filteredBidRequests.list method. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5832,10 +6197,22 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` - * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidsResponse.nextPageToken returned from the previous call to the filteredBids.list method. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.filterSetName Name of the filter set that should + * be applied to the requested metrics. For example: - For a + * bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` + * - For an account-level filter set for the buyer account representing + * bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + * account-level filter set for the child seat buyer account 456 whose + * bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {integer=} params.pageSize Requested page size. The server may + * return fewer results than requested. If unspecified, the server will + * pick an appropriate default. + * @param {string=} params.pageToken A token identifying a page of results + * the server should return. Typically, this is the value of + * ListFilteredBidsResponse.nextPageToken returned from the previous + * call to the filteredBids.list method. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5945,11 +6322,25 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer} params.creativeStatusId The ID of the creative status for which to retrieve a breakdown by creative. See [creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes). - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` - * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByCreativeResponse.nextPageToken returned from the previous call to the filteredBids.creatives.list method. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer} params.creativeStatusId The ID of the creative status + * for which to retrieve a breakdown by creative. See + * [creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes). + * @param {string} params.filterSetName Name of the filter set that should + * be applied to the requested metrics. For example: - For a + * bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` + * - For an account-level filter set for the buyer account representing + * bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + * account-level filter set for the child seat buyer account 456 whose + * bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {integer=} params.pageSize Requested page size. The server may + * return fewer results than requested. If unspecified, the server will + * pick an appropriate default. + * @param {string=} params.pageToken A token identifying a page of results + * the server should return. Typically, this is the value of + * ListCreativeStatusBreakdownByCreativeResponse.nextPageToken returned + * from the previous call to the filteredBids.creatives.list method. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6079,11 +6470,27 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer} params.creativeStatusId The ID of the creative status for which to retrieve a breakdown by detail. See [creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes). Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87. - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` - * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from the previous call to the filteredBids.details.list method. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer} params.creativeStatusId The ID of the creative status + * for which to retrieve a breakdown by detail. See + * [creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes). + * Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, + * and 87. + * @param {string} params.filterSetName Name of the filter set that should + * be applied to the requested metrics. For example: - For a + * bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` + * - For an account-level filter set for the buyer account representing + * bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + * account-level filter set for the child seat buyer account 456 whose + * bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {integer=} params.pageSize Requested page size. The server may + * return fewer results than requested. If unspecified, the server will + * pick an appropriate default. + * @param {string=} params.pageToken A token identifying a page of results + * the server should return. Typically, this is the value of + * ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned + * from the previous call to the filteredBids.details.list method. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6216,10 +6623,22 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` - * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListImpressionMetricsResponse.nextPageToken returned from the previous call to the impressionMetrics.list method. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.filterSetName Name of the filter set that should + * be applied to the requested metrics. For example: - For a + * bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` + * - For an account-level filter set for the buyer account representing + * bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + * account-level filter set for the child seat buyer account 456 whose + * bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {integer=} params.pageSize Requested page size. The server may + * return fewer results than requested. If unspecified, the server will + * pick an appropriate default. + * @param {string=} params.pageToken A token identifying a page of results + * the server should return. Typically, this is the value of + * ListImpressionMetricsResponse.nextPageToken returned from the + * previous call to the impressionMetrics.list method. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6339,10 +6758,22 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` - * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListLosingBidsResponse.nextPageToken returned from the previous call to the losingBids.list method. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.filterSetName Name of the filter set that should + * be applied to the requested metrics. For example: - For a + * bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` + * - For an account-level filter set for the buyer account representing + * bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + * account-level filter set for the child seat buyer account 456 whose + * bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {integer=} params.pageSize Requested page size. The server may + * return fewer results than requested. If unspecified, the server will + * pick an appropriate default. + * @param {string=} params.pageToken A token identifying a page of results + * the server should return. Typically, this is the value of + * ListLosingBidsResponse.nextPageToken returned from the previous call + * to the losingBids.list method. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6453,10 +6884,22 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` - * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. - * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListNonBillableWinningBidsResponse.nextPageToken returned from the previous call to the nonBillableWinningBids.list method. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.filterSetName Name of the filter set that should + * be applied to the requested metrics. For example: - For a + * bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` + * - For an account-level filter set for the buyer account representing + * bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + * account-level filter set for the child seat buyer account 456 whose + * bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {integer=} params.pageSize Requested page size. The server may + * return fewer results than requested. If unspecified, the server will + * pick an appropriate default. + * @param {string=} params.pageToken A token identifying a page of results + * the server should return. Typically, this is the value of + * ListNonBillableWinningBidsResponse.nextPageToken returned from the + * previous call to the nonBillableWinningBids.list method. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/adexchangeseller/v1.1.ts b/src/apis/adexchangeseller/v1.1.ts index d3641ea58a3..b4a9592991a 100644 --- a/src/apis/adexchangeseller/v1.1.ts +++ b/src/apis/adexchangeseller/v1.1.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -495,8 +494,10 @@ export namespace adexchangeseller_v1_1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account to get information about. Tip: 'myaccount' is a valid ID. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Account to get information about. Tip: + * 'myaccount' is a valid ID. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -581,9 +582,13 @@ export namespace adexchangeseller_v1_1 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {integer=} params.maxResults The maximum number of ad clients to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.maxResults The maximum number of ad clients to + * include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through ad clients. To retrieve the next page, set this parameter to + * the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -683,7 +688,8 @@ export namespace adexchangeseller_v1_1 { * @param {object} params Parameters for request * @param {string} params.adClientId Ad client for which to get the ad unit. * @param {string} params.adUnitId Ad unit to retrieve. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -747,10 +753,15 @@ export namespace adexchangeseller_v1_1 { * * @param {object} params Parameters for request * @param {string} params.adClientId Ad client for which to list ad units. - * @param {boolean=} params.includeInactive Whether to include inactive ad units. Default: true. - * @param {integer=} params.maxResults The maximum number of ad units to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {boolean=} params.includeInactive Whether to include inactive ad + * units. Default: true. + * @param {integer=} params.maxResults The maximum number of ad units to + * include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through ad units. To retrieve the next page, set this parameter to + * the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -869,10 +880,15 @@ export namespace adexchangeseller_v1_1 { * * @param {object} params Parameters for request * @param {string} params.adClientId Ad client which contains the ad unit. - * @param {string} params.adUnitId Ad unit for which to list custom channels. - * @param {integer=} params.maxResults The maximum number of custom channels to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.adUnitId Ad unit for which to list custom + * channels. + * @param {integer=} params.maxResults The maximum number of custom channels + * to include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through custom channels. To retrieve the next page, set this + * parameter to the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -981,8 +997,12 @@ export namespace adexchangeseller_v1_1 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {string=} params.locale The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.locale The locale to use for translating alert + * messages. The account locale will be used if this is not supplied. + * The AdSense default (English) will be used if the supplied locale is + * invalid or unsupported. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1074,9 +1094,11 @@ export namespace adexchangeseller_v1_1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.adClientId Ad client which contains the custom channel. + * @param {string} params.adClientId Ad client which contains the custom + * channel. * @param {string} params.customChannelId Custom channel to retrieve. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1141,10 +1163,15 @@ export namespace adexchangeseller_v1_1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.adClientId Ad client for which to list custom channels. - * @param {integer=} params.maxResults The maximum number of custom channels to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.adClientId Ad client for which to list custom + * channels. + * @param {integer=} params.maxResults The maximum number of custom channels + * to include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through custom channels. To retrieve the next page, set this + * parameter to the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1261,12 +1288,19 @@ export namespace adexchangeseller_v1_1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.adClientId Ad client which contains the custom channel. - * @param {string} params.customChannelId Custom channel for which to list ad units. - * @param {boolean=} params.includeInactive Whether to include inactive ad units. Default: true. - * @param {integer=} params.maxResults The maximum number of ad units to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.adClientId Ad client which contains the custom + * channel. + * @param {string} params.customChannelId Custom channel for which to list + * ad units. + * @param {boolean=} params.includeInactive Whether to include inactive ad + * units. Default: true. + * @param {integer=} params.maxResults The maximum number of ad units to + * include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through ad units. To retrieve the next page, set this parameter to + * the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1396,7 +1430,8 @@ export namespace adexchangeseller_v1_1 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1482,7 +1517,8 @@ export namespace adexchangeseller_v1_1 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1569,7 +1605,8 @@ export namespace adexchangeseller_v1_1 { * * @param {object} params Parameters for request * @param {string} params.dealId Preferred deal to get information about. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1631,7 +1668,8 @@ export namespace adexchangeseller_v1_1 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1732,15 +1770,25 @@ export namespace adexchangeseller_v1_1 { * * @param {object} params Parameters for request * @param {string=} params.dimension Dimensions to base the report on. - * @param {string} params.endDate End of the date range to report on in "YYYY-MM-DD" format, inclusive. + * @param {string} params.endDate End of the date range to report on in + * "YYYY-MM-DD" format, inclusive. * @param {string=} params.filter Filters to be run on the report. - * @param {string=} params.locale Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. - * @param {integer=} params.maxResults The maximum number of rows of report data to return. + * @param {string=} params.locale Optional locale to use for translating + * report output to a local language. Defaults to "en_US" if not + * specified. + * @param {integer=} params.maxResults The maximum number of rows of report + * data to return. * @param {string=} params.metric Numeric columns to include in the report. - * @param {string=} params.sort The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. - * @param {string} params.startDate Start of the date range to report on in "YYYY-MM-DD" format, inclusive. - * @param {integer=} params.startIndex Index of the first row of report data to return. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.sort The name of a dimension or metric to sort + * the resulting report on, optionally prefixed with "+" to sort + * ascending or "-" to sort descending. If no prefix is specified, the + * column is sorted ascending. + * @param {string} params.startDate Start of the date range to report on in + * "YYYY-MM-DD" format, inclusive. + * @param {integer=} params.startIndex Index of the first row of report data + * to return. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1864,11 +1912,16 @@ export namespace adexchangeseller_v1_1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.locale Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. - * @param {integer=} params.maxResults The maximum number of rows of report data to return. + * @param {string=} params.locale Optional locale to use for translating + * report output to a local language. Defaults to "en_US" if not + * specified. + * @param {integer=} params.maxResults The maximum number of rows of report + * data to return. * @param {string} params.savedReportId The saved report to retrieve. - * @param {integer=} params.startIndex Index of the first row of report data to return. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.startIndex Index of the first row of report data + * to return. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1933,9 +1986,13 @@ export namespace adexchangeseller_v1_1 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {integer=} params.maxResults The maximum number of saved reports to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.maxResults The maximum number of saved reports + * to include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through saved reports. To retrieve the next page, set this parameter + * to the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2058,10 +2115,15 @@ export namespace adexchangeseller_v1_1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.adClientId Ad client for which to list URL channels. - * @param {integer=} params.maxResults The maximum number of URL channels to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.adClientId Ad client for which to list URL + * channels. + * @param {integer=} params.maxResults The maximum number of URL channels to + * include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through URL channels. To retrieve the next page, set this parameter + * to the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/adexchangeseller/v1.ts b/src/apis/adexchangeseller/v1.ts index bd1116d3d35..4955dbe66ef 100644 --- a/src/apis/adexchangeseller/v1.ts +++ b/src/apis/adexchangeseller/v1.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -338,9 +337,13 @@ export namespace adexchangeseller_v1 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {integer=} params.maxResults The maximum number of ad clients to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.maxResults The maximum number of ad clients to + * include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through ad clients. To retrieve the next page, set this parameter to + * the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -440,7 +443,8 @@ export namespace adexchangeseller_v1 { * @param {object} params Parameters for request * @param {string} params.adClientId Ad client for which to get the ad unit. * @param {string} params.adUnitId Ad unit to retrieve. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -504,10 +508,15 @@ export namespace adexchangeseller_v1 { * * @param {object} params Parameters for request * @param {string} params.adClientId Ad client for which to list ad units. - * @param {boolean=} params.includeInactive Whether to include inactive ad units. Default: true. - * @param {integer=} params.maxResults The maximum number of ad units to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {boolean=} params.includeInactive Whether to include inactive ad + * units. Default: true. + * @param {integer=} params.maxResults The maximum number of ad units to + * include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through ad units. To retrieve the next page, set this parameter to + * the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -626,10 +635,15 @@ export namespace adexchangeseller_v1 { * * @param {object} params Parameters for request * @param {string} params.adClientId Ad client which contains the ad unit. - * @param {string} params.adUnitId Ad unit for which to list custom channels. - * @param {integer=} params.maxResults The maximum number of custom channels to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.adUnitId Ad unit for which to list custom + * channels. + * @param {integer=} params.maxResults The maximum number of custom channels + * to include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through custom channels. To retrieve the next page, set this + * parameter to the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -740,9 +754,11 @@ export namespace adexchangeseller_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.adClientId Ad client which contains the custom channel. + * @param {string} params.adClientId Ad client which contains the custom + * channel. * @param {string} params.customChannelId Custom channel to retrieve. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -807,10 +823,15 @@ export namespace adexchangeseller_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.adClientId Ad client for which to list custom channels. - * @param {integer=} params.maxResults The maximum number of custom channels to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.adClientId Ad client for which to list custom + * channels. + * @param {integer=} params.maxResults The maximum number of custom channels + * to include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through custom channels. To retrieve the next page, set this + * parameter to the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -927,12 +948,19 @@ export namespace adexchangeseller_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.adClientId Ad client which contains the custom channel. - * @param {string} params.customChannelId Custom channel for which to list ad units. - * @param {boolean=} params.includeInactive Whether to include inactive ad units. Default: true. - * @param {integer=} params.maxResults The maximum number of ad units to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.adClientId Ad client which contains the custom + * channel. + * @param {string} params.customChannelId Custom channel for which to list + * ad units. + * @param {boolean=} params.includeInactive Whether to include inactive ad + * units. Default: true. + * @param {integer=} params.maxResults The maximum number of ad units to + * include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through ad units. To retrieve the next page, set this parameter to + * the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1049,15 +1077,25 @@ export namespace adexchangeseller_v1 { * * @param {object} params Parameters for request * @param {string=} params.dimension Dimensions to base the report on. - * @param {string} params.endDate End of the date range to report on in "YYYY-MM-DD" format, inclusive. + * @param {string} params.endDate End of the date range to report on in + * "YYYY-MM-DD" format, inclusive. * @param {string=} params.filter Filters to be run on the report. - * @param {string=} params.locale Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. - * @param {integer=} params.maxResults The maximum number of rows of report data to return. + * @param {string=} params.locale Optional locale to use for translating + * report output to a local language. Defaults to "en_US" if not + * specified. + * @param {integer=} params.maxResults The maximum number of rows of report + * data to return. * @param {string=} params.metric Numeric columns to include in the report. - * @param {string=} params.sort The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. - * @param {string} params.startDate Start of the date range to report on in "YYYY-MM-DD" format, inclusive. - * @param {integer=} params.startIndex Index of the first row of report data to return. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.sort The name of a dimension or metric to sort + * the resulting report on, optionally prefixed with "+" to sort + * ascending or "-" to sort descending. If no prefix is specified, the + * column is sorted ascending. + * @param {string} params.startDate Start of the date range to report on in + * "YYYY-MM-DD" format, inclusive. + * @param {integer=} params.startIndex Index of the first row of report data + * to return. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1181,11 +1219,16 @@ export namespace adexchangeseller_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.locale Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. - * @param {integer=} params.maxResults The maximum number of rows of report data to return. + * @param {string=} params.locale Optional locale to use for translating + * report output to a local language. Defaults to "en_US" if not + * specified. + * @param {integer=} params.maxResults The maximum number of rows of report + * data to return. * @param {string} params.savedReportId The saved report to retrieve. - * @param {integer=} params.startIndex Index of the first row of report data to return. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.startIndex Index of the first row of report data + * to return. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1250,9 +1293,13 @@ export namespace adexchangeseller_v1 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {integer=} params.maxResults The maximum number of saved reports to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.maxResults The maximum number of saved reports + * to include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through saved reports. To retrieve the next page, set this parameter + * to the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1375,10 +1422,15 @@ export namespace adexchangeseller_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.adClientId Ad client for which to list URL channels. - * @param {integer=} params.maxResults The maximum number of URL channels to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.adClientId Ad client for which to list URL + * channels. + * @param {integer=} params.maxResults The maximum number of URL channels to + * include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through URL channels. To retrieve the next page, set this parameter + * to the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/adexchangeseller/v2.0.ts b/src/apis/adexchangeseller/v2.0.ts index 77930ae4f4e..cb8bdd8386d 100644 --- a/src/apis/adexchangeseller/v2.0.ts +++ b/src/apis/adexchangeseller/v2.0.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -466,8 +465,10 @@ export namespace adexchangeseller_v2_0 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account to get information about. Tip: 'myaccount' is a valid ID. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Account to get information about. Tip: + * 'myaccount' is a valid ID. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -527,9 +528,13 @@ export namespace adexchangeseller_v2_0 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {integer=} params.maxResults The maximum number of accounts to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through accounts. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.maxResults The maximum number of accounts to + * include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through accounts. To retrieve the next page, set this parameter to + * the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -635,9 +640,13 @@ export namespace adexchangeseller_v2_0 { * * @param {object} params Parameters for request * @param {string} params.accountId Account to which the ad client belongs. - * @param {integer=} params.maxResults The maximum number of ad clients to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.maxResults The maximum number of ad clients to + * include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through ad clients. To retrieve the next page, set this parameter to + * the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -741,8 +750,12 @@ export namespace adexchangeseller_v2_0 { * * @param {object} params Parameters for request * @param {string} params.accountId Account owning the alerts. - * @param {string=} params.locale The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.locale The locale to use for translating alert + * messages. The account locale will be used if this is not supplied. + * The AdSense default (English) will be used if the supplied locale is + * invalid or unsupported. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -840,9 +853,11 @@ export namespace adexchangeseller_v2_0 { * * @param {object} params Parameters for request * @param {string} params.accountId Account to which the ad client belongs. - * @param {string} params.adClientId Ad client which contains the custom channel. + * @param {string} params.adClientId Ad client which contains the custom + * channel. * @param {string} params.customChannelId Custom channel to retrieve. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -908,10 +923,15 @@ export namespace adexchangeseller_v2_0 { * * @param {object} params Parameters for request * @param {string} params.accountId Account to which the ad client belongs. - * @param {string} params.adClientId Ad client for which to list custom channels. - * @param {integer=} params.maxResults The maximum number of custom channels to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.adClientId Ad client for which to list custom + * channels. + * @param {integer=} params.maxResults The maximum number of custom channels + * to include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through custom channels. To retrieve the next page, set this + * parameter to the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1056,8 +1076,10 @@ export namespace adexchangeseller_v2_0 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account with visibility to the dimensions. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Account with visibility to the + * dimensions. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1151,7 +1173,8 @@ export namespace adexchangeseller_v2_0 { * * @param {object} params Parameters for request * @param {string} params.accountId Account with visibility to the metrics. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1246,7 +1269,8 @@ export namespace adexchangeseller_v2_0 { * @param {object} params Parameters for request * @param {string} params.accountId Account owning the deal. * @param {string} params.dealId Preferred deal to get information about. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1311,7 +1335,8 @@ export namespace adexchangeseller_v2_0 { * * @param {object} params Parameters for request * @param {string} params.accountId Account owning the deals. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1425,15 +1450,25 @@ export namespace adexchangeseller_v2_0 { * @param {object} params Parameters for request * @param {string} params.accountId Account which owns the generated report. * @param {string=} params.dimension Dimensions to base the report on. - * @param {string} params.endDate End of the date range to report on in "YYYY-MM-DD" format, inclusive. + * @param {string} params.endDate End of the date range to report on in + * "YYYY-MM-DD" format, inclusive. * @param {string=} params.filter Filters to be run on the report. - * @param {string=} params.locale Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. - * @param {integer=} params.maxResults The maximum number of rows of report data to return. + * @param {string=} params.locale Optional locale to use for translating + * report output to a local language. Defaults to "en_US" if not + * specified. + * @param {integer=} params.maxResults The maximum number of rows of report + * data to return. * @param {string=} params.metric Numeric columns to include in the report. - * @param {string=} params.sort The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. - * @param {string} params.startDate Start of the date range to report on in "YYYY-MM-DD" format, inclusive. - * @param {integer=} params.startIndex Index of the first row of report data to return. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.sort The name of a dimension or metric to sort + * the resulting report on, optionally prefixed with "+" to sort + * ascending or "-" to sort descending. If no prefix is specified, the + * column is sorted ascending. + * @param {string} params.startDate Start of the date range to report on in + * "YYYY-MM-DD" format, inclusive. + * @param {integer=} params.startIndex Index of the first row of report data + * to return. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1564,11 +1599,16 @@ export namespace adexchangeseller_v2_0 { * * @param {object} params Parameters for request * @param {string} params.accountId Account owning the saved report. - * @param {string=} params.locale Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. - * @param {integer=} params.maxResults The maximum number of rows of report data to return. + * @param {string=} params.locale Optional locale to use for translating + * report output to a local language. Defaults to "en_US" if not + * specified. + * @param {integer=} params.maxResults The maximum number of rows of report + * data to return. * @param {string} params.savedReportId The saved report to retrieve. - * @param {integer=} params.startIndex Index of the first row of report data to return. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.startIndex Index of the first row of report data + * to return. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1636,9 +1676,13 @@ export namespace adexchangeseller_v2_0 { * * @param {object} params Parameters for request * @param {string} params.accountId Account owning the saved reports. - * @param {integer=} params.maxResults The maximum number of saved reports to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.maxResults The maximum number of saved reports + * to include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through saved reports. To retrieve the next page, set this parameter + * to the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1772,10 +1816,15 @@ export namespace adexchangeseller_v2_0 { * * @param {object} params Parameters for request * @param {string} params.accountId Account to which the ad client belongs. - * @param {string} params.adClientId Ad client for which to list URL channels. - * @param {integer=} params.maxResults The maximum number of URL channels to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.adClientId Ad client for which to list URL + * channels. + * @param {integer=} params.maxResults The maximum number of URL channels to + * include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through URL channels. To retrieve the next page, set this parameter + * to the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/adexperiencereport/v1.ts b/src/apis/adexperiencereport/v1.ts index e55d3361714..828c6fe4f9a 100644 --- a/src/apis/adexperiencereport/v1.ts +++ b/src/apis/adexperiencereport/v1.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -149,8 +148,16 @@ export namespace adexperiencereport_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The required site name. It should be the site property whose ad experiences may have been reviewed, and it should be URL-encoded. For example, sites/https%3A%2F%2Fwww.google.com. The server will return an error of BAD_REQUEST if this field is not filled in. Note that if the site property is not yet verified in Search Console, the reportUrl field returned by the API will lead to the verification page, prompting the user to go through that process before they can gain access to the Ad Experience Report. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.name The required site name. It should be the site + * property whose ad experiences may have been reviewed, and it should + * be URL-encoded. For example, sites/https%3A%2F%2Fwww.google.com. The + * server will return an error of BAD_REQUEST if this field is not + * filled in. Note that if the site property is not yet verified in + * Search Console, the reportUrl field returned by the API will lead to + * the verification page, prompting the user to go through that process + * before they can gain access to the Ad Experience Report. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -244,7 +251,8 @@ export namespace adexperiencereport_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/admin/datatransfer_v1.ts b/src/apis/admin/datatransfer_v1.ts index 65c194cbc38..6dcc6c3cf33 100644 --- a/src/apis/admin/datatransfer_v1.ts +++ b/src/apis/admin/datatransfer_v1.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -232,8 +231,10 @@ export namespace admin_datatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.applicationId ID of the application resource to be retrieved. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.applicationId ID of the application resource to be + * retrieved. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -295,10 +296,13 @@ export namespace admin_datatransfer_v1 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {string=} params.customerId Immutable ID of the Google Apps account. - * @param {integer=} params.maxResults Maximum number of results to return. Default is 100. + * @param {string=} params.customerId Immutable ID of the Google Apps + * account. + * @param {integer=} params.maxResults Maximum number of results to return. + * Default is 100. * @param {string=} params.pageToken Token to specify next page in the list. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -408,8 +412,10 @@ export namespace admin_datatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dataTransferId ID of the resource to be retrieved. This is returned in the response from the insert method. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.dataTransferId ID of the resource to be retrieved. + * This is returned in the response from the insert method. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -472,7 +478,8 @@ export namespace admin_datatransfer_v1 { * * @param {object} params Parameters for request * @param {().DataTransfer} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -537,13 +544,17 @@ export namespace admin_datatransfer_v1 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {string=} params.customerId Immutable ID of the Google Apps account. - * @param {integer=} params.maxResults Maximum number of results to return. Default is 100. + * @param {string=} params.customerId Immutable ID of the Google Apps + * account. + * @param {integer=} params.maxResults Maximum number of results to return. + * Default is 100. * @param {string=} params.newOwnerUserId Destination user's profile ID. * @param {string=} params.oldOwnerUserId Source user's profile ID. - * @param {string=} params.pageToken Token to specify the next page in the list. + * @param {string=} params.pageToken Token to specify the next page in the + * list. * @param {string=} params.status Status of the transfer. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/admin/directory_v1.ts b/src/apis/admin/directory_v1.ts index bc39cba3123..35063da96a8 100644 --- a/src/apis/admin/directory_v1.ts +++ b/src/apis/admin/directory_v1.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -1671,6 +1670,10 @@ export namespace admin_directory_v1 { * List of aliases (Read-only) */ aliases?: string[]; + /** + * Indicates if user is archived + */ + archived?: boolean; /** * Boolean indicating if the user should change password in next login */ @@ -2393,8 +2396,11 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {integer} params.codeId The unique ID of the ASP to be deleted. - * @param {string} params.userKey Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.userKey Identifies the user in the API request. + * The value can be the user's primary email address, alias email + * address, or unique user ID. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2458,8 +2464,11 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {integer} params.codeId The unique ID of the ASP. - * @param {string} params.userKey Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.userKey Identifies the user in the API request. + * The value can be the user's primary email address, alias email + * address, or unique user ID. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2520,8 +2529,11 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userKey Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.userKey Identifies the user in the API request. + * The value can be the user's primary email address, alias email + * address, or unique user ID. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2643,7 +2655,8 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {().Channel} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2735,7 +2748,8 @@ export namespace admin_directory_v1 { * @param {string} params.customerId Immutable ID of the G Suite account * @param {string} params.resourceId Immutable ID of Chrome OS Device * @param {().ChromeOsDeviceAction} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2803,8 +2817,10 @@ export namespace admin_directory_v1 { * @param {object} params Parameters for request * @param {string} params.customerId Immutable ID of the G Suite account * @param {string} params.deviceId Immutable ID of Chrome OS Device - * @param {string=} params.projection Restrict information returned to a set of selected fields. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.projection Restrict information returned to a set + * of selected fields. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2869,14 +2885,20 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {string} params.customerId Immutable ID of the G Suite account - * @param {integer=} params.maxResults Maximum number of results to return. Default is 100 + * @param {integer=} params.maxResults Maximum number of results to return. + * Default is 100 * @param {string=} params.orderBy Column to use for sorting results - * @param {string=} params.orgUnitPath Full path of the organizational unit or its ID + * @param {string=} params.orgUnitPath Full path of the organizational unit + * or its ID * @param {string=} params.pageToken Token to specify next page in the list - * @param {string=} params.projection Restrict information returned to a set of selected fields. - * @param {string=} params.query Search string in the format given at http://support.google.com/chromeos/a/bin/answer.py?answer=1698333 - * @param {string=} params.sortOrder Whether to return results in ascending or descending order. Only of use when orderBy is also used - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.projection Restrict information returned to a set + * of selected fields. + * @param {string=} params.query Search string in the format given at + * http://support.google.com/chromeos/a/bin/answer.py?answer=1698333 + * @param {string=} params.sortOrder Whether to return results in ascending + * or descending order. Only of use when orderBy is also used + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2945,9 +2967,11 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {string} params.customerId Immutable ID of the G Suite account - * @param {string} params.orgUnitPath Full path of the target organizational unit or its ID + * @param {string} params.orgUnitPath Full path of the target organizational + * unit or its ID * @param {().ChromeOsMoveDevicesToOu} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3015,9 +3039,11 @@ export namespace admin_directory_v1 { * @param {object} params Parameters for request * @param {string} params.customerId Immutable ID of the G Suite account * @param {string} params.deviceId Immutable ID of Chrome OS Device - * @param {string=} params.projection Restrict information returned to a set of selected fields. + * @param {string=} params.projection Restrict information returned to a set + * of selected fields. * @param {().ChromeOsDevice} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3087,9 +3113,11 @@ export namespace admin_directory_v1 { * @param {object} params Parameters for request * @param {string} params.customerId Immutable ID of the G Suite account * @param {string} params.deviceId Immutable ID of Chrome OS Device - * @param {string=} params.projection Restrict information returned to a set of selected fields. + * @param {string=} params.projection Restrict information returned to a set + * of selected fields. * @param {().ChromeOsDevice} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3320,7 +3348,8 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {string} params.customerKey Id of the customer to be retrieved - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3382,7 +3411,8 @@ export namespace admin_directory_v1 { * @param {object} params Parameters for request * @param {string} params.customerKey Id of the customer to be updated * @param {().Customer} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3447,7 +3477,8 @@ export namespace admin_directory_v1 { * @param {object} params Parameters for request * @param {string} params.customerKey Id of the customer to be updated * @param {().Customer} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3568,8 +3599,10 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {string} params.customer Immutable ID of the G Suite account. - * @param {string} params.domainAliasName Name of domain alias to be retrieved. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.domainAliasName Name of domain alias to be + * retrieved. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3636,8 +3669,10 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {string} params.customer Immutable ID of the G Suite account. - * @param {string} params.domainAliasName Name of domain alias to be retrieved. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.domainAliasName Name of domain alias to be + * retrieved. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3703,7 +3738,8 @@ export namespace admin_directory_v1 { * @param {object} params Parameters for request * @param {string} params.customer Immutable ID of the G Suite account. * @param {().DomainAlias} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3771,8 +3807,10 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {string} params.customer Immutable ID of the G Suite account. - * @param {string=} params.parentDomainName Name of the parent domain for which domain aliases are to be fetched. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.parentDomainName Name of the parent domain for + * which domain aliases are to be fetched. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3915,7 +3953,8 @@ export namespace admin_directory_v1 { * @param {object} params Parameters for request * @param {string} params.customer Immutable ID of the G Suite account. * @param {string} params.domainName Name of domain to be deleted - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3981,7 +4020,8 @@ export namespace admin_directory_v1 { * @param {object} params Parameters for request * @param {string} params.customer Immutable ID of the G Suite account. * @param {string} params.domainName Name of domain to be retrieved - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4045,7 +4085,8 @@ export namespace admin_directory_v1 { * @param {object} params Parameters for request * @param {string} params.customer Immutable ID of the G Suite account. * @param {().Domains} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4109,7 +4150,8 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {string} params.customer Immutable ID of the G Suite account. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4246,7 +4288,8 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {string} params.groupKey Email or immutable ID of the group - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4309,7 +4352,8 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {string} params.groupKey Email or immutable ID of the group - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4370,7 +4414,8 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {().Group} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4434,15 +4479,26 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {string=} params.customer Immutable ID of the G Suite account. In case of multi-domain, to fetch all groups for a customer, fill this field instead of domain. - * @param {string=} params.domain Name of the domain. Fill this field to get groups from only this domain. To return all groups in a multi-domain fill customer field instead. - * @param {integer=} params.maxResults Maximum number of results to return. Default is 200 + * @param {string=} params.customer Immutable ID of the G Suite account. In + * case of multi-domain, to fetch all groups for a customer, fill this + * field instead of domain. + * @param {string=} params.domain Name of the domain. Fill this field to get + * groups from only this domain. To return all groups in a multi-domain + * fill customer field instead. + * @param {integer=} params.maxResults Maximum number of results to return. + * Default is 200 * @param {string=} params.orderBy Column to use for sorting results * @param {string=} params.pageToken Token to specify next page in the list - * @param {string=} params.query Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-groups - * @param {string=} params.sortOrder Whether to return results in ascending or descending order. Only of use when orderBy is also used - * @param {string=} params.userKey Email or immutable Id of the user if only those groups are to be listed, the given user is a member of. If Id, it should match with id of user object - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.query Query string search. Should be of the form + * "". Complete documentation is at + * https://developers.google.com/admin-sdk/directory/v1/guides/search-groups + * @param {string=} params.sortOrder Whether to return results in ascending + * or descending order. Only of use when orderBy is also used + * @param {string=} params.userKey Email or immutable Id of the user if only + * those groups are to be listed, the given user is a member of. If Id, + * it should match with id of user object + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4505,9 +4561,11 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.groupKey Email or immutable ID of the group. If ID, it should match with id of group object + * @param {string} params.groupKey Email or immutable ID of the group. If + * ID, it should match with id of group object * @param {().Group} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4570,9 +4628,11 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.groupKey Email or immutable ID of the group. If ID, it should match with id of group object + * @param {string} params.groupKey Email or immutable ID of the group. If + * ID, it should match with id of group object * @param {().Group} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4764,7 +4824,8 @@ export namespace admin_directory_v1 { * @param {object} params Parameters for request * @param {string} params.alias The alias to be removed * @param {string} params.groupKey Email or immutable ID of the group - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4831,7 +4892,8 @@ export namespace admin_directory_v1 { * @param {object} params Parameters for request * @param {string} params.groupKey Email or immutable ID of the group * @param {().Alias} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4897,7 +4959,8 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {string} params.groupKey Email or immutable ID of the group - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5020,7 +5083,8 @@ export namespace admin_directory_v1 { * @param {object} params Parameters for request * @param {string} params.groupKey Email or immutable ID of the group * @param {string} params.memberKey Email or immutable ID of the member - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5085,7 +5149,8 @@ export namespace admin_directory_v1 { * @param {object} params Parameters for request * @param {string} params.groupKey Email or immutable ID of the group * @param {string} params.memberKey Email or immutable ID of the member - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5147,9 +5212,14 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.groupKey Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID. - * @param {string} params.memberKey Identifies the user member in the API request. The value can be the user's primary email address, alias, or unique ID. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.groupKey Identifies the group in the API request. + * The value can be the group's email address, group alias, or the + * unique group ID. + * @param {string} params.memberKey Identifies the user member in the API + * request. The value can be the user's primary email address, alias, or + * unique ID. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5219,7 +5289,8 @@ export namespace admin_directory_v1 { * @param {object} params Parameters for request * @param {string} params.groupKey Email or immutable ID of the group * @param {().Member} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5283,11 +5354,15 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {string} params.groupKey Email or immutable ID of the group - * @param {boolean=} params.includeDerivedMembership Whether to list indirect memberships. Default: false. - * @param {integer=} params.maxResults Maximum number of results to return. Default is 200 + * @param {boolean=} params.includeDerivedMembership Whether to list + * indirect memberships. Default: false. + * @param {integer=} params.maxResults Maximum number of results to return. + * Default is 200 * @param {string=} params.pageToken Token to specify next page in the list - * @param {string=} params.roles Comma separated role values to filter list results on. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.roles Comma separated role values to filter list + * results on. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5351,10 +5426,13 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.groupKey Email or immutable ID of the group. If ID, it should match with id of group object - * @param {string} params.memberKey Email or immutable ID of the user. If ID, it should match with id of member object + * @param {string} params.groupKey Email or immutable ID of the group. If + * ID, it should match with id of group object + * @param {string} params.memberKey Email or immutable ID of the user. If + * ID, it should match with id of member object * @param {().Member} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5418,10 +5496,13 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.groupKey Email or immutable ID of the group. If ID, it should match with id of group object - * @param {string} params.memberKey Email or immutable ID of the user. If ID, it should match with id of member object + * @param {string} params.groupKey Email or immutable ID of the group. If + * ID, it should match with id of group object + * @param {string} params.memberKey Email or immutable ID of the user. If + * ID, it should match with id of member object * @param {().Member} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5636,7 +5717,8 @@ export namespace admin_directory_v1 { * @param {string} params.customerId Immutable ID of the G Suite account * @param {string} params.resourceId Immutable ID of Mobile Device * @param {().MobileDeviceAction} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5704,7 +5786,8 @@ export namespace admin_directory_v1 { * @param {object} params Parameters for request * @param {string} params.customerId Immutable ID of the G Suite account * @param {string} params.resourceId Immutable ID of Mobile Device - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5771,9 +5854,11 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {string} params.customerId Immutable ID of the G Suite account - * @param {string=} params.projection Restrict information returned to a set of selected fields. + * @param {string=} params.projection Restrict information returned to a set + * of selected fields. * @param {string} params.resourceId Immutable ID of Mobile Device - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5838,13 +5923,18 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {string} params.customerId Immutable ID of the G Suite account - * @param {integer=} params.maxResults Maximum number of results to return. Default is 100 + * @param {integer=} params.maxResults Maximum number of results to return. + * Default is 100 * @param {string=} params.orderBy Column to use for sorting results * @param {string=} params.pageToken Token to specify next page in the list - * @param {string=} params.projection Restrict information returned to a set of selected fields. - * @param {string=} params.query Search string in the format given at http://support.google.com/a/bin/answer.py?answer=1408863#search - * @param {string=} params.sortOrder Whether to return results in ascending or descending order. Only of use when orderBy is also used - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.projection Restrict information returned to a set + * of selected fields. + * @param {string=} params.query Search string in the format given at + * http://support.google.com/a/bin/answer.py?answer=1408863#search + * @param {string=} params.sortOrder Whether to return results in ascending + * or descending order. Only of use when orderBy is also used + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6015,9 +6105,12 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.customer The unique ID for the customer's G Suite account. The customerId is also returned as part of the Users resource. + * @param {string} params.customer The unique ID for the customer's G Suite + * account. The customerId is also returned as part of the Users + * resource. * @param {string} params.notificationId The unique ID of the notification. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6083,9 +6176,12 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.customer The unique ID for the customer's G Suite account. The customerId is also returned as part of the Users resource. + * @param {string} params.customer The unique ID for the customer's G Suite + * account. The customerId is also returned as part of the Users + * resource. * @param {string} params.notificationId The unique ID of the notification. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6149,11 +6245,16 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.customer The unique ID for the customer's G Suite account. - * @param {string=} params.language The ISO 639-1 code of the language notifications are returned in. The default is English (en). - * @param {integer=} params.maxResults Maximum number of notifications to return per page. The default is 100. - * @param {string=} params.pageToken The token to specify the page of results to retrieve. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.customer The unique ID for the customer's G Suite + * account. + * @param {string=} params.language The ISO 639-1 code of the language + * notifications are returned in. The default is English (en). + * @param {integer=} params.maxResults Maximum number of notifications to + * return per page. The default is 100. + * @param {string=} params.pageToken The token to specify the page of + * results to retrieve. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6219,10 +6320,12 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.customer The unique ID for the customer's G Suite account. + * @param {string} params.customer The unique ID for the customer's G Suite + * account. * @param {string} params.notificationId The unique ID of the notification. * @param {().Notification} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6290,10 +6393,12 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.customer The unique ID for the customer's G Suite account. + * @param {string} params.customer The unique ID for the customer's G Suite + * account. * @param {string} params.notificationId The unique ID of the notification. * @param {().Notification} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6472,8 +6577,10 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {string} params.customerId Immutable ID of the G Suite account - * @param {string} params.orgUnitPath Full path of the organizational unit or its ID - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.orgUnitPath Full path of the organizational unit + * or its ID + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6538,8 +6645,10 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {string} params.customerId Immutable ID of the G Suite account - * @param {string} params.orgUnitPath Full path of the organizational unit or its ID - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.orgUnitPath Full path of the organizational unit + * or its ID + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6603,7 +6712,8 @@ export namespace admin_directory_v1 { * @param {object} params Parameters for request * @param {string} params.customerId Immutable ID of the G Suite account * @param {().OrgUnit} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6668,9 +6778,12 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {string} params.customerId Immutable ID of the G Suite account - * @param {string=} params.orgUnitPath the URL-encoded organizational unit's path or its ID - * @param {string=} params.type Whether to return all sub-organizations or just immediate children - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.orgUnitPath the URL-encoded organizational unit's + * path or its ID + * @param {string=} params.type Whether to return all sub-organizations or + * just immediate children + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6735,9 +6848,11 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {string} params.customerId Immutable ID of the G Suite account - * @param {string} params.orgUnitPath Full path of the organizational unit or its ID + * @param {string} params.orgUnitPath Full path of the organizational unit + * or its ID * @param {().OrgUnit} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6803,9 +6918,11 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {string} params.customerId Immutable ID of the G Suite account - * @param {string} params.orgUnitPath Full path of the organizational unit or its ID + * @param {string} params.orgUnitPath Full path of the organizational unit + * or its ID * @param {().OrgUnit} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6990,7 +7107,8 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {string} params.customer Immutable ID of the G Suite account. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -7081,7 +7199,8 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -7151,7 +7270,8 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -7265,8 +7385,11 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {string} params.buildingId The ID of the building to delete. - * @param {string} params.customer The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.customer The unique ID for the customer's G Suite + * account. As an account administrator, you can also use the + * my_customer alias to represent your account's customer ID. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -7332,9 +7455,13 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.buildingId The unique ID of the building to retrieve. - * @param {string} params.customer The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.buildingId The unique ID of the building to + * retrieve. + * @param {string} params.customer The unique ID for the customer's G Suite + * account. As an account administrator, you can also use the + * my_customer alias to represent your account's customer ID. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -7397,9 +7524,12 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.customer The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. + * @param {string} params.customer The unique ID for the customer's G Suite + * account. As an account administrator, you can also use the + * my_customer alias to represent your account's customer ID. * @param {().Building} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -7466,10 +7596,14 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.customer The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. + * @param {string} params.customer The unique ID for the customer's G Suite + * account. As an account administrator, you can also use the + * my_customer alias to represent your account's customer ID. * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Token to specify the next page in the list. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pageToken Token to specify the next page in the + * list. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -7538,9 +7672,12 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {string} params.buildingId The ID of the building to update. - * @param {string} params.customer The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. + * @param {string} params.customer The unique ID for the customer's G Suite + * account. As an account administrator, you can also use the + * my_customer alias to represent your account's customer ID. * @param {().Building} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -7608,9 +7745,12 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {string} params.buildingId The ID of the building to update. - * @param {string} params.customer The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. + * @param {string} params.customer The unique ID for the customer's G Suite + * account. As an account administrator, you can also use the + * my_customer alias to represent your account's customer ID. * @param {().Building} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -7808,9 +7948,13 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.calendarResourceId The unique ID of the calendar resource to delete. - * @param {string} params.customer The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.calendarResourceId The unique ID of the calendar + * resource to delete. + * @param {string} params.customer The unique ID for the customer's G Suite + * account. As an account administrator, you can also use the + * my_customer alias to represent your account's customer ID. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -7876,9 +8020,13 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.calendarResourceId The unique ID of the calendar resource to retrieve. - * @param {string} params.customer The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.calendarResourceId The unique ID of the calendar + * resource to retrieve. + * @param {string} params.customer The unique ID for the customer's G Suite + * account. As an account administrator, you can also use the + * my_customer alias to represent your account's customer ID. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -7942,9 +8090,12 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.customer The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. + * @param {string} params.customer The unique ID for the customer's G Suite + * account. As an account administrator, you can also use the + * my_customer alias to represent your account's customer ID. * @param {().CalendarResource} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8012,12 +8163,29 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.customer The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. + * @param {string} params.customer The unique ID for the customer's G Suite + * account. As an account administrator, you can also use the + * my_customer alias to represent your account's customer ID. * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.orderBy Field(s) to sort results by in either ascending or descending order. Supported fields include resourceId, resourceName, capacity, buildingId, and floorName. If no order is specified, defaults to ascending. Should be of the form "field [asc|desc], field [asc|desc], ...". For example buildingId, capacity desc would return results sorted first by buildingId in ascending order then by capacity in descending order. - * @param {string=} params.pageToken Token to specify the next page in the list. - * @param {string=} params.query String query used to filter results. Should be of the form "field operator value" where field can be any of supported fields and operators can be any of supported operations. Operators include '=' for exact match and ':' for prefix match or HAS match where applicable. For prefix match, the value should always be followed by a *. Supported fields include generatedResourceName, name, buildingId, featureInstances.feature.name. For example buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.orderBy Field(s) to sort results by in either + * ascending or descending order. Supported fields include resourceId, + * resourceName, capacity, buildingId, and floorName. If no order is + * specified, defaults to ascending. Should be of the form "field + * [asc|desc], field [asc|desc], ...". For example buildingId, capacity + * desc would return results sorted first by buildingId in ascending + * order then by capacity in descending order. + * @param {string=} params.pageToken Token to specify the next page in the + * list. + * @param {string=} params.query String query used to filter results. Should + * be of the form "field operator value" where field can be any of + * supported fields and operators can be any of supported operations. + * Operators include '=' for exact match and ':' for prefix match or HAS + * match where applicable. For prefix match, the value should always be + * followed by a *. Supported fields include generatedResourceName, + * name, buildingId, featureInstances.feature.name. For example + * buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8088,10 +8256,14 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.calendarResourceId The unique ID of the calendar resource to update. - * @param {string} params.customer The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. + * @param {string} params.calendarResourceId The unique ID of the calendar + * resource to update. + * @param {string} params.customer The unique ID for the customer's G Suite + * account. As an account administrator, you can also use the + * my_customer alias to represent your account's customer ID. * @param {().CalendarResource} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8161,10 +8333,14 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.calendarResourceId The unique ID of the calendar resource to update. - * @param {string} params.customer The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. + * @param {string} params.calendarResourceId The unique ID of the calendar + * resource to update. + * @param {string} params.customer The unique ID for the customer's G Suite + * account. As an account administrator, you can also use the + * my_customer alias to represent your account's customer ID. * @param {().CalendarResource} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8383,9 +8559,12 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.customer The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. + * @param {string} params.customer The unique ID for the customer's G Suite + * account. As an account administrator, you can also use the + * my_customer alias to represent your account's customer ID. * @param {string} params.featureKey The unique ID of the feature to delete. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8451,9 +8630,13 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.customer The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. - * @param {string} params.featureKey The unique ID of the feature to retrieve. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.customer The unique ID for the customer's G Suite + * account. As an account administrator, you can also use the + * my_customer alias to represent your account's customer ID. + * @param {string} params.featureKey The unique ID of the feature to + * retrieve. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8516,9 +8699,12 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.customer The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. + * @param {string} params.customer The unique ID for the customer's G Suite + * account. As an account administrator, you can also use the + * my_customer alias to represent your account's customer ID. * @param {().Feature} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8585,10 +8771,14 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.customer The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. + * @param {string} params.customer The unique ID for the customer's G Suite + * account. As an account administrator, you can also use the + * my_customer alias to represent your account's customer ID. * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Token to specify the next page in the list. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pageToken Token to specify the next page in the + * list. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8655,10 +8845,13 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.customer The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. + * @param {string} params.customer The unique ID for the customer's G Suite + * account. As an account administrator, you can also use the + * my_customer alias to represent your account's customer ID. * @param {string} params.featureKey The unique ID of the feature to update. * @param {().Feature} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8725,10 +8918,13 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.customer The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. + * @param {string} params.customer The unique ID for the customer's G Suite + * account. As an account administrator, you can also use the + * my_customer alias to represent your account's customer ID. * @param {string} params.oldName The unique ID of the feature to rename. * @param {().FeatureRename} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8794,10 +8990,13 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.customer The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. + * @param {string} params.customer The unique ID for the customer's G Suite + * account. As an account administrator, you can also use the + * my_customer alias to represent your account's customer ID. * @param {string} params.featureKey The unique ID of the feature to update. * @param {().Feature} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -9019,8 +9218,10 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {string} params.customer Immutable ID of the G Suite account. - * @param {string} params.roleAssignmentId Immutable ID of the role assignment. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.roleAssignmentId Immutable ID of the role + * assignment. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -9087,8 +9288,10 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {string} params.customer Immutable ID of the G Suite account. - * @param {string} params.roleAssignmentId Immutable ID of the role assignment. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.roleAssignmentId Immutable ID of the role + * assignment. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -9154,7 +9357,8 @@ export namespace admin_directory_v1 { * @param {object} params Parameters for request * @param {string} params.customer Immutable ID of the G Suite account. * @param {().RoleAssignment} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -9223,10 +9427,15 @@ export namespace admin_directory_v1 { * @param {object} params Parameters for request * @param {string} params.customer Immutable ID of the G Suite account. * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Token to specify the next page in the list. - * @param {string=} params.roleId Immutable ID of a role. If included in the request, returns only role assignments containing this role ID. - * @param {string=} params.userKey The user's primary email address, alias email address, or unique user ID. If included in the request, returns role assignments only for this user. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pageToken Token to specify the next page in the + * list. + * @param {string=} params.roleId Immutable ID of a role. If included in the + * request, returns only role assignments containing this role ID. + * @param {string=} params.userKey The user's primary email address, alias + * email address, or unique user ID. If included in the request, returns + * role assignments only for this user. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -9384,7 +9593,8 @@ export namespace admin_directory_v1 { * @param {object} params Parameters for request * @param {string} params.customer Immutable ID of the G Suite account. * @param {string} params.roleId Immutable ID of the role. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -9449,7 +9659,8 @@ export namespace admin_directory_v1 { * @param {object} params Parameters for request * @param {string} params.customer Immutable ID of the G Suite account. * @param {string} params.roleId Immutable ID of the role. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -9512,7 +9723,8 @@ export namespace admin_directory_v1 { * @param {object} params Parameters for request * @param {string} params.customer Immutable ID of the G Suite account. * @param {().Role} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -9577,8 +9789,10 @@ export namespace admin_directory_v1 { * @param {object} params Parameters for request * @param {string} params.customer Immutable ID of the G Suite account. * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Token to specify the next page in the list. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pageToken Token to specify the next page in the + * list. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -9644,7 +9858,8 @@ export namespace admin_directory_v1 { * @param {string} params.customer Immutable ID of the G Suite account. * @param {string} params.roleId Immutable ID of the role. * @param {().Role} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -9711,7 +9926,8 @@ export namespace admin_directory_v1 { * @param {string} params.customer Immutable ID of the G Suite account. * @param {string} params.roleId Immutable ID of the role. * @param {().Role} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -9896,7 +10112,8 @@ export namespace admin_directory_v1 { * @param {object} params Parameters for request * @param {string} params.customerId Immutable ID of the G Suite account * @param {string} params.schemaKey Name or immutable ID of the schema - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -9962,7 +10179,8 @@ export namespace admin_directory_v1 { * @param {object} params Parameters for request * @param {string} params.customerId Immutable ID of the G Suite account * @param {string} params.schemaKey Name or immutable ID of the schema - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -10026,7 +10244,8 @@ export namespace admin_directory_v1 { * @param {object} params Parameters for request * @param {string} params.customerId Immutable ID of the G Suite account * @param {().Schema} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -10091,7 +10310,8 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {string} params.customerId Immutable ID of the G Suite account - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -10158,7 +10378,8 @@ export namespace admin_directory_v1 { * @param {string} params.customerId Immutable ID of the G Suite account * @param {string} params.schemaKey Name or immutable ID of the schema. * @param {().Schema} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -10226,7 +10447,8 @@ export namespace admin_directory_v1 { * @param {string} params.customerId Immutable ID of the G Suite account * @param {string} params.schemaKey Name or immutable ID of the schema. * @param {().Schema} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -10402,9 +10624,13 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clientId The Client ID of the application the token is issued to. - * @param {string} params.userKey Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.clientId The Client ID of the application the + * token is issued to. + * @param {string} params.userKey Identifies the user in the API request. + * The value can be the user's primary email address, alias email + * address, or unique user ID. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -10467,9 +10693,13 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clientId The Client ID of the application the token is issued to. - * @param {string} params.userKey Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.clientId The Client ID of the application the + * token is issued to. + * @param {string} params.userKey Identifies the user in the API request. + * The value can be the user's primary email address, alias email + * address, or unique user ID. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -10531,8 +10761,11 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userKey Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.userKey Identifies the user in the API request. + * The value can be the user's primary email address, alias email + * address, or unique user ID. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -10658,7 +10891,8 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {string} params.userKey Email or immutable ID of the user - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -10720,11 +10954,16 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.customFieldMask Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom. - * @param {string=} params.projection What subset of fields to fetch for this user. + * @param {string=} params.customFieldMask Comma-separated list of schema + * names. All fields from these schemas are fetched. This should only be + * set when projection=custom. + * @param {string=} params.projection What subset of fields to fetch for + * this user. * @param {string} params.userKey Email or immutable ID of the user - * @param {string=} params.viewType Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.viewType Whether to fetch the ADMIN_VIEW or + * DOMAIN_PUBLIC view of the user. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -10785,7 +11024,8 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {().User} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -10848,19 +11088,34 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {string=} params.customer Immutable ID of the G Suite account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain. - * @param {string=} params.customFieldMask Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom. - * @param {string=} params.domain Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead. - * @param {string=} params.event Event on which subscription is intended (if subscribing) - * @param {integer=} params.maxResults Maximum number of results to return. Default is 100. Max allowed is 500 + * @param {string=} params.customer Immutable ID of the G Suite account. In + * case of multi-domain, to fetch all users for a customer, fill this + * field instead of domain. + * @param {string=} params.customFieldMask Comma-separated list of schema + * names. All fields from these schemas are fetched. This should only be + * set when projection=custom. + * @param {string=} params.domain Name of the domain. Fill this field to get + * users from only this domain. To return all users in a multi-domain + * fill customer field instead. + * @param {string=} params.event Event on which subscription is intended (if + * subscribing) + * @param {integer=} params.maxResults Maximum number of results to return. + * Default is 100. Max allowed is 500 * @param {string=} params.orderBy Column to use for sorting results * @param {string=} params.pageToken Token to specify next page in the list - * @param {string=} params.projection What subset of fields to fetch for this user. - * @param {string=} params.query Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users - * @param {string=} params.showDeleted If set to true retrieves the list of deleted users. Default is false - * @param {string=} params.sortOrder Whether to return results in ascending or descending order. - * @param {string=} params.viewType Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.projection What subset of fields to fetch for + * this user. + * @param {string=} params.query Query string search. Should be of the form + * "". Complete documentation is at + * https://developers.google.com/admin-sdk/directory/v1/guides/search-users + * @param {string=} params.showDeleted If set to true retrieves the list of + * deleted users. Default is false + * @param {string=} params.sortOrder Whether to return results in ascending + * or descending order. + * @param {string=} params.viewType Whether to fetch the ADMIN_VIEW or + * DOMAIN_PUBLIC view of the user. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -10925,7 +11180,8 @@ export namespace admin_directory_v1 { * @param {object} params Parameters for request * @param {string} params.userKey Email or immutable ID of the user as admin * @param {().UserMakeAdmin} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -10988,9 +11244,11 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userKey Email or immutable ID of the user. If ID, it should match with id of user object + * @param {string} params.userKey Email or immutable ID of the user. If ID, + * it should match with id of user object * @param {().User} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -11055,7 +11313,8 @@ export namespace admin_directory_v1 { * @param {object} params Parameters for request * @param {string} params.userKey The immutable id of the user * @param {().UserUndelete} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -11117,9 +11376,11 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userKey Email or immutable ID of the user. If ID, it should match with id of user object + * @param {string} params.userKey Email or immutable ID of the user. If ID, + * it should match with id of user object * @param {().User} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -11182,20 +11443,35 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.customer Immutable ID of the G Suite account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain. - * @param {string=} params.customFieldMask Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom. - * @param {string=} params.domain Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead. - * @param {string=} params.event Event on which subscription is intended (if subscribing) - * @param {integer=} params.maxResults Maximum number of results to return. Default is 100. Max allowed is 500 + * @param {string=} params.customer Immutable ID of the G Suite account. In + * case of multi-domain, to fetch all users for a customer, fill this + * field instead of domain. + * @param {string=} params.customFieldMask Comma-separated list of schema + * names. All fields from these schemas are fetched. This should only be + * set when projection=custom. + * @param {string=} params.domain Name of the domain. Fill this field to get + * users from only this domain. To return all users in a multi-domain + * fill customer field instead. + * @param {string=} params.event Event on which subscription is intended (if + * subscribing) + * @param {integer=} params.maxResults Maximum number of results to return. + * Default is 100. Max allowed is 500 * @param {string=} params.orderBy Column to use for sorting results * @param {string=} params.pageToken Token to specify next page in the list - * @param {string=} params.projection What subset of fields to fetch for this user. - * @param {string=} params.query Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users - * @param {string=} params.showDeleted If set to true retrieves the list of deleted users. Default is false - * @param {string=} params.sortOrder Whether to return results in ascending or descending order. - * @param {string=} params.viewType Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user. + * @param {string=} params.projection What subset of fields to fetch for + * this user. + * @param {string=} params.query Query string search. Should be of the form + * "". Complete documentation is at + * https://developers.google.com/admin-sdk/directory/v1/guides/search-users + * @param {string=} params.showDeleted If set to true retrieves the list of + * deleted users. Default is false + * @param {string=} params.sortOrder Whether to return results in ascending + * or descending order. + * @param {string=} params.viewType Whether to fetch the ADMIN_VIEW or + * DOMAIN_PUBLIC view of the user. * @param {().Channel} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -11511,7 +11787,8 @@ export namespace admin_directory_v1 { * @param {object} params Parameters for request * @param {string} params.alias The alias to be removed * @param {string} params.userKey Email or immutable ID of the user - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -11578,7 +11855,8 @@ export namespace admin_directory_v1 { * @param {object} params Parameters for request * @param {string} params.userKey Email or immutable ID of the user * @param {().Alias} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -11643,9 +11921,11 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.event Event on which subscription is intended (if subscribing) + * @param {string=} params.event Event on which subscription is intended (if + * subscribing) * @param {string} params.userKey Email or immutable ID of the user - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -11709,10 +11989,12 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.event Event on which subscription is intended (if subscribing) + * @param {string=} params.event Event on which subscription is intended (if + * subscribing) * @param {string} params.userKey Email or immutable ID of the user * @param {().Channel} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -11859,7 +12141,8 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {string} params.userKey Email or immutable ID of the user - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -11925,7 +12208,8 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {string} params.userKey Email or immutable ID of the user - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -11989,7 +12273,8 @@ export namespace admin_directory_v1 { * @param {object} params Parameters for request * @param {string} params.userKey Email or immutable ID of the user * @param {().UserPhoto} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -12057,7 +12342,8 @@ export namespace admin_directory_v1 { * @param {object} params Parameters for request * @param {string} params.userKey Email or immutable ID of the user * @param {().UserPhoto} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -12194,7 +12480,8 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {string} params.userKey Email or immutable ID of the user - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -12261,7 +12548,8 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {string} params.userKey Email or immutable ID of the user - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -12328,8 +12616,11 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userKey Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.userKey Identifies the user in the API request. + * The value can be the user's primary email address, alias email + * address, or unique user ID. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/admin/reports_v1.ts b/src/apis/admin/reports_v1.ts index fc40f9c64b5..c4b4bfe2b49 100644 --- a/src/apis/admin/reports_v1.ts +++ b/src/apis/admin/reports_v1.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -249,17 +248,28 @@ export namespace admin_reports_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.actorIpAddress IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses. - * @param {string} params.applicationName Application name for which the events are to be retrieved. - * @param {string=} params.customerId Represents the customer for which the data is to be fetched. - * @param {string=} params.endTime Return events which occurred at or before this time. + * @param {string=} params.actorIpAddress IP Address of host where the event + * was performed. Supports both IPv4 and IPv6 addresses. + * @param {string} params.applicationName Application name for which the + * events are to be retrieved. + * @param {string=} params.customerId Represents the customer for which the + * data is to be fetched. + * @param {string=} params.endTime Return events which occurred at or before + * this time. * @param {string=} params.eventName Name of the event being queried. - * @param {string=} params.filters Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],... - * @param {integer=} params.maxResults Number of activity records to be shown in each page. + * @param {string=} params.filters Event parameters in the form [parameter1 + * name][operator][parameter1 value],[parameter2 + * name][operator][parameter2 value],... + * @param {integer=} params.maxResults Number of activity records to be + * shown in each page. * @param {string=} params.pageToken Token to specify next page. - * @param {string=} params.startTime Return events which occurred at or after this time. - * @param {string} params.userKey Represents the profile id or the user email for which the data should be filtered. When 'all' is specified as the userKey, it returns usageReports for all users. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.startTime Return events which occurred at or + * after this time. + * @param {string} params.userKey Represents the profile id or the user + * email for which the data should be filtered. When 'all' is specified + * as the userKey, it returns usageReports for all users. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -325,18 +335,29 @@ export namespace admin_reports_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.actorIpAddress IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses. - * @param {string} params.applicationName Application name for which the events are to be retrieved. - * @param {string=} params.customerId Represents the customer for which the data is to be fetched. - * @param {string=} params.endTime Return events which occurred at or before this time. + * @param {string=} params.actorIpAddress IP Address of host where the event + * was performed. Supports both IPv4 and IPv6 addresses. + * @param {string} params.applicationName Application name for which the + * events are to be retrieved. + * @param {string=} params.customerId Represents the customer for which the + * data is to be fetched. + * @param {string=} params.endTime Return events which occurred at or before + * this time. * @param {string=} params.eventName Name of the event being queried. - * @param {string=} params.filters Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],... - * @param {integer=} params.maxResults Number of activity records to be shown in each page. + * @param {string=} params.filters Event parameters in the form [parameter1 + * name][operator][parameter1 value],[parameter2 + * name][operator][parameter2 value],... + * @param {integer=} params.maxResults Number of activity records to be + * shown in each page. * @param {string=} params.pageToken Token to specify next page. - * @param {string=} params.startTime Return events which occurred at or after this time. - * @param {string} params.userKey Represents the profile id or the user email for which the data should be filtered. When 'all' is specified as the userKey, it returns usageReports for all users. + * @param {string=} params.startTime Return events which occurred at or + * after this time. + * @param {string} params.userKey Represents the profile id or the user + * email for which the data should be filtered. When 'all' is specified + * as the userKey, it returns usageReports for all users. * @param {().Channel} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -523,7 +544,8 @@ export namespace admin_reports_v1 { * * @param {object} params Parameters for request * @param {().Channel} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -613,11 +635,16 @@ export namespace admin_reports_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.customerId Represents the customer for which the data is to be fetched. - * @param {string} params.date Represents the date in yyyy-mm-dd format for which the data is to be fetched. + * @param {string=} params.customerId Represents the customer for which the + * data is to be fetched. + * @param {string} params.date Represents the date in yyyy-mm-dd format for + * which the data is to be fetched. * @param {string=} params.pageToken Token to specify next page. - * @param {string=} params.parameters Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.parameters Represents the application name, + * parameter name pairs to fetch in csv as app_name1:param_name1, + * app_name2:param_name2. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -719,15 +746,24 @@ export namespace admin_reports_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.customerId Represents the customer for which the data is to be fetched. - * @param {string} params.date Represents the date in yyyy-mm-dd format for which the data is to be fetched. - * @param {string} params.entityKey Represents the key of object for which the data should be filtered. - * @param {string} params.entityType Type of object. Should be one of - gplus_communities. - * @param {string=} params.filters Represents the set of filters including parameter operator value. - * @param {integer=} params.maxResults Maximum number of results to return. Maximum allowed is 1000 + * @param {string=} params.customerId Represents the customer for which the + * data is to be fetched. + * @param {string} params.date Represents the date in yyyy-mm-dd format for + * which the data is to be fetched. + * @param {string} params.entityKey Represents the key of object for which + * the data should be filtered. + * @param {string} params.entityType Type of object. Should be one of - + * gplus_communities. + * @param {string=} params.filters Represents the set of filters including + * parameter operator value. + * @param {integer=} params.maxResults Maximum number of results to return. + * Maximum allowed is 1000 * @param {string=} params.pageToken Token to specify next page. - * @param {string=} params.parameters Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.parameters Represents the application name, + * parameter name pairs to fetch in csv as app_name1:param_name1, + * app_name2:param_name2. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -847,14 +883,22 @@ export namespace admin_reports_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.customerId Represents the customer for which the data is to be fetched. - * @param {string} params.date Represents the date in yyyy-mm-dd format for which the data is to be fetched. - * @param {string=} params.filters Represents the set of filters including parameter operator value. - * @param {integer=} params.maxResults Maximum number of results to return. Maximum allowed is 1000 + * @param {string=} params.customerId Represents the customer for which the + * data is to be fetched. + * @param {string} params.date Represents the date in yyyy-mm-dd format for + * which the data is to be fetched. + * @param {string=} params.filters Represents the set of filters including + * parameter operator value. + * @param {integer=} params.maxResults Maximum number of results to return. + * Maximum allowed is 1000 * @param {string=} params.pageToken Token to specify next page. - * @param {string=} params.parameters Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2. - * @param {string} params.userKey Represents the profile id or the user email for which the data should be filtered. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.parameters Represents the application name, + * parameter name pairs to fetch in csv as app_name1:param_name1, + * app_name2:param_name2. + * @param {string} params.userKey Represents the profile id or the user + * email for which the data should be filtered. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/adsense/v1.4.ts b/src/apis/adsense/v1.4.ts index 219fcc976a3..185b23e8cf6 100644 --- a/src/apis/adsense/v1.4.ts +++ b/src/apis/adsense/v1.4.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -176,15 +175,15 @@ export namespace adsense_v1_4 { } export interface Schema$AdCode { /** - * The ad code snippet. + * The Auto ad code snippet. The ad code snippet. */ adCode?: string; /** - * The ad code snippet that goes in the body of an AMP page. + * The AMP Auto ad code snippet that goes in the body of an AMP page. */ ampBody?: string; /** - * The ad code snippet that goes in the head of an AMP page. + * The AMP Auto ad code snippet that goes in the head of an AMP page. */ ampHead?: string; /** @@ -643,8 +642,10 @@ export namespace adsense_v1_4 { * * @param {object} params Parameters for request * @param {string} params.accountId Account to get information about. - * @param {boolean=} params.tree Whether the tree of sub accounts should be returned. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {boolean=} params.tree Whether the tree of sub accounts should be + * returned. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -704,9 +705,13 @@ export namespace adsense_v1_4 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {integer=} params.maxResults The maximum number of accounts to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through accounts. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.maxResults The maximum number of accounts to + * include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through accounts. To retrieve the next page, set this parameter to + * the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -810,14 +815,15 @@ export namespace adsense_v1_4 { /** * adsense.accounts.adclients.getAdCode - * @desc Get ad code for a given ad client. + * @desc Get Auto ad code for a given ad client. * @alias adsense.accounts.adclients.getAdCode * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account which contains the ad client. * @param {string} params.adClientId Ad client to get the code for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -885,9 +891,13 @@ export namespace adsense_v1_4 { * * @param {object} params Parameters for request * @param {string} params.accountId Account for which to list ad clients. - * @param {integer=} params.maxResults The maximum number of ad clients to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.maxResults The maximum number of ad clients to + * include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through ad clients. To retrieve the next page, set this parameter to + * the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1010,7 +1020,8 @@ export namespace adsense_v1_4 { * @param {string} params.accountId Account to which the ad client belongs. * @param {string} params.adClientId Ad client for which to get the ad unit. * @param {string} params.adUnitId Ad unit to retrieve. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1076,7 +1087,8 @@ export namespace adsense_v1_4 { * @param {string} params.accountId Account which contains the ad client. * @param {string} params.adClientId Ad client with contains the ad unit. * @param {string} params.adUnitId Ad unit to get the code for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1146,10 +1158,15 @@ export namespace adsense_v1_4 { * @param {object} params Parameters for request * @param {string} params.accountId Account to which the ad client belongs. * @param {string} params.adClientId Ad client for which to list ad units. - * @param {boolean=} params.includeInactive Whether to include inactive ad units. Default: true. - * @param {integer=} params.maxResults The maximum number of ad units to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {boolean=} params.includeInactive Whether to include inactive ad + * units. Default: true. + * @param {integer=} params.maxResults The maximum number of ad units to + * include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through ad units. To retrieve the next page, set this parameter to + * the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1299,10 +1316,15 @@ export namespace adsense_v1_4 { * @param {object} params Parameters for request * @param {string} params.accountId Account to which the ad client belongs. * @param {string} params.adClientId Ad client which contains the ad unit. - * @param {string} params.adUnitId Ad unit for which to list custom channels. - * @param {integer=} params.maxResults The maximum number of custom channels to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.adUnitId Ad unit for which to list custom + * channels. + * @param {integer=} params.maxResults The maximum number of custom channels + * to include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through custom channels. To retrieve the next page, set this + * parameter to the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1418,7 +1440,8 @@ export namespace adsense_v1_4 { * @param {object} params Parameters for request * @param {string} params.accountId Account which contains the ad unit. * @param {string} params.alertId Alert to delete. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1483,9 +1506,14 @@ export namespace adsense_v1_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account for which to retrieve the alerts. - * @param {string=} params.locale The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Account for which to retrieve the + * alerts. + * @param {string=} params.locale The locale to use for translating alert + * messages. The account locale will be used if this is not supplied. + * The AdSense default (English) will be used if the supplied locale is + * invalid or unsupported. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1600,9 +1628,11 @@ export namespace adsense_v1_4 { * * @param {object} params Parameters for request * @param {string} params.accountId Account to which the ad client belongs. - * @param {string} params.adClientId Ad client which contains the custom channel. + * @param {string} params.adClientId Ad client which contains the custom + * channel. * @param {string} params.customChannelId Custom channel to retrieve. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1668,10 +1698,15 @@ export namespace adsense_v1_4 { * * @param {object} params Parameters for request * @param {string} params.accountId Account to which the ad client belongs. - * @param {string} params.adClientId Ad client for which to list custom channels. - * @param {integer=} params.maxResults The maximum number of custom channels to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.adClientId Ad client for which to list custom + * channels. + * @param {integer=} params.maxResults The maximum number of custom channels + * to include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through custom channels. To retrieve the next page, set this + * parameter to the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1798,12 +1833,19 @@ export namespace adsense_v1_4 { * * @param {object} params Parameters for request * @param {string} params.accountId Account to which the ad client belongs. - * @param {string} params.adClientId Ad client which contains the custom channel. - * @param {string} params.customChannelId Custom channel for which to list ad units. - * @param {boolean=} params.includeInactive Whether to include inactive ad units. Default: true. - * @param {integer=} params.maxResults The maximum number of ad units to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.adClientId Ad client which contains the custom + * channel. + * @param {string} params.customChannelId Custom channel for which to list + * ad units. + * @param {boolean=} params.includeInactive Whether to include inactive ad + * units. Default: true. + * @param {integer=} params.maxResults The maximum number of ad units to + * include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through ad units. To retrieve the next page, set this parameter to + * the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1919,8 +1961,10 @@ export namespace adsense_v1_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account for which to retrieve the payments. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Account for which to retrieve the + * payments. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2015,18 +2059,31 @@ export namespace adsense_v1_4 { * * @param {object} params Parameters for request * @param {string} params.accountId Account upon which to report. - * @param {string=} params.currency Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set. + * @param {string=} params.currency Optional currency to use when reporting + * on monetary metrics. Defaults to the account's currency if not set. * @param {string=} params.dimension Dimensions to base the report on. - * @param {string} params.endDate End of the date range to report on in "YYYY-MM-DD" format, inclusive. + * @param {string} params.endDate End of the date range to report on in + * "YYYY-MM-DD" format, inclusive. * @param {string=} params.filter Filters to be run on the report. - * @param {string=} params.locale Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. - * @param {integer=} params.maxResults The maximum number of rows of report data to return. + * @param {string=} params.locale Optional locale to use for translating + * report output to a local language. Defaults to "en_US" if not + * specified. + * @param {integer=} params.maxResults The maximum number of rows of report + * data to return. * @param {string=} params.metric Numeric columns to include in the report. - * @param {string=} params.sort The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. - * @param {string} params.startDate Start of the date range to report on in "YYYY-MM-DD" format, inclusive. - * @param {integer=} params.startIndex Index of the first row of report data to return. - * @param {boolean=} params.useTimezoneReporting Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.sort The name of a dimension or metric to sort + * the resulting report on, optionally prefixed with "+" to sort + * ascending or "-" to sort descending. If no prefix is specified, the + * column is sorted ascending. + * @param {string} params.startDate Start of the date range to report on in + * "YYYY-MM-DD" format, inclusive. + * @param {integer=} params.startIndex Index of the first row of report data + * to return. + * @param {boolean=} params.useTimezoneReporting Whether the report should + * be generated in the AdSense account's local timezone. If false + * default PST/PDT timezone will be used. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2174,12 +2231,18 @@ export namespace adsense_v1_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account to which the saved reports belong. - * @param {string=} params.locale Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. - * @param {integer=} params.maxResults The maximum number of rows of report data to return. + * @param {string} params.accountId Account to which the saved reports + * belong. + * @param {string=} params.locale Optional locale to use for translating + * report output to a local language. Defaults to "en_US" if not + * specified. + * @param {integer=} params.maxResults The maximum number of rows of report + * data to return. * @param {string} params.savedReportId The saved report to retrieve. - * @param {integer=} params.startIndex Index of the first row of report data to return. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.startIndex Index of the first row of report data + * to return. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2255,10 +2318,15 @@ export namespace adsense_v1_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account to which the saved reports belong. - * @param {integer=} params.maxResults The maximum number of saved reports to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Account to which the saved reports + * belong. + * @param {integer=} params.maxResults The maximum number of saved reports + * to include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through saved reports. To retrieve the next page, set this parameter + * to the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2390,9 +2458,11 @@ export namespace adsense_v1_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account for which to get the saved ad style. + * @param {string} params.accountId Account for which to get the saved ad + * style. * @param {string} params.savedAdStyleId Saved ad style to retrieve. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2456,10 +2526,15 @@ export namespace adsense_v1_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account for which to list saved ad styles. - * @param {integer=} params.maxResults The maximum number of saved ad styles to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Account for which to list saved ad + * styles. + * @param {integer=} params.maxResults The maximum number of saved ad styles + * to include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through saved ad styles. To retrieve the next page, set this + * parameter to the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2579,10 +2654,15 @@ export namespace adsense_v1_4 { * * @param {object} params Parameters for request * @param {string} params.accountId Account to which the ad client belongs. - * @param {string} params.adClientId Ad client for which to list URL channels. - * @param {integer=} params.maxResults The maximum number of URL channels to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.adClientId Ad client for which to list URL + * channels. + * @param {integer=} params.maxResults The maximum number of URL channels to + * include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through URL channels. To retrieve the next page, set this parameter + * to the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2691,9 +2771,13 @@ export namespace adsense_v1_4 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {integer=} params.maxResults The maximum number of ad clients to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.maxResults The maximum number of ad clients to + * include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through ad clients. To retrieve the next page, set this parameter to + * the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2793,7 +2877,8 @@ export namespace adsense_v1_4 { * @param {object} params Parameters for request * @param {string} params.adClientId Ad client for which to get the ad unit. * @param {string} params.adUnitId Ad unit to retrieve. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2856,7 +2941,8 @@ export namespace adsense_v1_4 { * @param {object} params Parameters for request * @param {string} params.adClientId Ad client with contains the ad unit. * @param {string} params.adUnitId Ad unit to get the code for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2925,10 +3011,15 @@ export namespace adsense_v1_4 { * * @param {object} params Parameters for request * @param {string} params.adClientId Ad client for which to list ad units. - * @param {boolean=} params.includeInactive Whether to include inactive ad units. Default: true. - * @param {integer=} params.maxResults The maximum number of ad units to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {boolean=} params.includeInactive Whether to include inactive ad + * units. Default: true. + * @param {integer=} params.maxResults The maximum number of ad units to + * include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through ad units. To retrieve the next page, set this parameter to + * the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3061,10 +3152,15 @@ export namespace adsense_v1_4 { * * @param {object} params Parameters for request * @param {string} params.adClientId Ad client which contains the ad unit. - * @param {string} params.adUnitId Ad unit for which to list custom channels. - * @param {integer=} params.maxResults The maximum number of custom channels to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.adUnitId Ad unit for which to list custom + * channels. + * @param {integer=} params.maxResults The maximum number of custom channels + * to include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through custom channels. To retrieve the next page, set this + * parameter to the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3175,7 +3271,8 @@ export namespace adsense_v1_4 { * * @param {object} params Parameters for request * @param {string} params.alertId Alert to delete. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3237,8 +3334,12 @@ export namespace adsense_v1_4 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {string=} params.locale The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.locale The locale to use for translating alert + * messages. The account locale will be used if this is not supplied. + * The AdSense default (English) will be used if the supplied locale is + * invalid or unsupported. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3341,9 +3442,11 @@ export namespace adsense_v1_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.adClientId Ad client which contains the custom channel. + * @param {string} params.adClientId Ad client which contains the custom + * channel. * @param {string} params.customChannelId Custom channel to retrieve. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3408,10 +3511,15 @@ export namespace adsense_v1_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.adClientId Ad client for which to list custom channels. - * @param {integer=} params.maxResults The maximum number of custom channels to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.adClientId Ad client for which to list custom + * channels. + * @param {integer=} params.maxResults The maximum number of custom channels + * to include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through custom channels. To retrieve the next page, set this + * parameter to the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3527,12 +3635,19 @@ export namespace adsense_v1_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.adClientId Ad client which contains the custom channel. - * @param {string} params.customChannelId Custom channel for which to list ad units. - * @param {boolean=} params.includeInactive Whether to include inactive ad units. Default: true. - * @param {integer=} params.maxResults The maximum number of ad units to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.adClientId Ad client which contains the custom + * channel. + * @param {string} params.customChannelId Custom channel for which to list + * ad units. + * @param {boolean=} params.includeInactive Whether to include inactive ad + * units. Default: true. + * @param {integer=} params.maxResults The maximum number of ad units to + * include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through ad units. To retrieve the next page, set this parameter to + * the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3662,7 +3777,8 @@ export namespace adsense_v1_4 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3748,7 +3864,8 @@ export namespace adsense_v1_4 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3834,7 +3951,8 @@ export namespace adsense_v1_4 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3922,18 +4040,31 @@ export namespace adsense_v1_4 { * * @param {object} params Parameters for request * @param {string=} params.accountId Accounts upon which to report. - * @param {string=} params.currency Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set. + * @param {string=} params.currency Optional currency to use when reporting + * on monetary metrics. Defaults to the account's currency if not set. * @param {string=} params.dimension Dimensions to base the report on. - * @param {string} params.endDate End of the date range to report on in "YYYY-MM-DD" format, inclusive. + * @param {string} params.endDate End of the date range to report on in + * "YYYY-MM-DD" format, inclusive. * @param {string=} params.filter Filters to be run on the report. - * @param {string=} params.locale Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. - * @param {integer=} params.maxResults The maximum number of rows of report data to return. + * @param {string=} params.locale Optional locale to use for translating + * report output to a local language. Defaults to "en_US" if not + * specified. + * @param {integer=} params.maxResults The maximum number of rows of report + * data to return. * @param {string=} params.metric Numeric columns to include in the report. - * @param {string=} params.sort The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. - * @param {string} params.startDate Start of the date range to report on in "YYYY-MM-DD" format, inclusive. - * @param {integer=} params.startIndex Index of the first row of report data to return. - * @param {boolean=} params.useTimezoneReporting Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.sort The name of a dimension or metric to sort + * the resulting report on, optionally prefixed with "+" to sort + * ascending or "-" to sort descending. If no prefix is specified, the + * column is sorted ascending. + * @param {string} params.startDate Start of the date range to report on in + * "YYYY-MM-DD" format, inclusive. + * @param {integer=} params.startIndex Index of the first row of report data + * to return. + * @param {boolean=} params.useTimezoneReporting Whether the report should + * be generated in the AdSense account's local timezone. If false + * default PST/PDT timezone will be used. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4079,11 +4210,16 @@ export namespace adsense_v1_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.locale Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. - * @param {integer=} params.maxResults The maximum number of rows of report data to return. + * @param {string=} params.locale Optional locale to use for translating + * report output to a local language. Defaults to "en_US" if not + * specified. + * @param {integer=} params.maxResults The maximum number of rows of report + * data to return. * @param {string} params.savedReportId The saved report to retrieve. - * @param {integer=} params.startIndex Index of the first row of report data to return. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.startIndex Index of the first row of report data + * to return. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4157,9 +4293,13 @@ export namespace adsense_v1_4 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {integer=} params.maxResults The maximum number of saved reports to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.maxResults The maximum number of saved reports + * to include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through saved reports. To retrieve the next page, set this parameter + * to the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4282,7 +4422,8 @@ export namespace adsense_v1_4 { * * @param {object} params Parameters for request * @param {string} params.savedAdStyleId Saved ad style to retrieve. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4344,9 +4485,13 @@ export namespace adsense_v1_4 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {integer=} params.maxResults The maximum number of saved ad styles to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.maxResults The maximum number of saved ad styles + * to include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through saved ad styles. To retrieve the next page, set this + * parameter to the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4455,10 +4600,15 @@ export namespace adsense_v1_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.adClientId Ad client for which to list URL channels. - * @param {integer=} params.maxResults The maximum number of URL channels to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.adClientId Ad client for which to list URL + * channels. + * @param {integer=} params.maxResults The maximum number of URL channels to + * include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through URL channels. To retrieve the next page, set this parameter + * to the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/adsensehost/v4.1.ts b/src/apis/adsensehost/v4.1.ts index 28220725b95..121e6bcbca7 100644 --- a/src/apis/adsensehost/v4.1.ts +++ b/src/apis/adsensehost/v4.1.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -429,7 +428,8 @@ export namespace adsensehost_v4_1 { * * @param {object} params Parameters for request * @param {string} params.accountId Account to get information about. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -491,7 +491,8 @@ export namespace adsensehost_v4_1 { * * @param {object} params Parameters for request * @param {string} params.filterAdClientId Ad clients to list accounts for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -592,7 +593,8 @@ export namespace adsensehost_v4_1 { * @param {object} params Parameters for request * @param {string} params.accountId Account which contains the ad client. * @param {string} params.adClientId Ad client to get. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -656,9 +658,13 @@ export namespace adsensehost_v4_1 { * * @param {object} params Parameters for request * @param {string} params.accountId Account for which to list ad clients. - * @param {integer=} params.maxResults The maximum number of ad clients to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.maxResults The maximum number of ad clients to + * include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through ad clients. To retrieve the next page, set this parameter to + * the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -780,7 +786,8 @@ export namespace adsensehost_v4_1 { * @param {string} params.accountId Account which contains the ad unit. * @param {string} params.adClientId Ad client for which to get ad unit. * @param {string} params.adUnitId Ad unit to delete. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -850,7 +857,8 @@ export namespace adsensehost_v4_1 { * @param {string} params.accountId Account which contains the ad unit. * @param {string} params.adClientId Ad client for which to get ad unit. * @param {string} params.adUnitId Ad unit to get. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -917,8 +925,10 @@ export namespace adsensehost_v4_1 { * @param {string} params.accountId Account which contains the ad client. * @param {string} params.adClientId Ad client with contains the ad unit. * @param {string} params.adUnitId Ad unit to get the code for. - * @param {string=} params.hostCustomChannelId Host custom channel to attach to the ad code. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.hostCustomChannelId Host custom channel to attach + * to the ad code. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -987,9 +997,11 @@ export namespace adsensehost_v4_1 { * * @param {object} params Parameters for request * @param {string} params.accountId Account which will contain the ad unit. - * @param {string} params.adClientId Ad client into which to insert the ad unit. + * @param {string} params.adClientId Ad client into which to insert the ad + * unit. * @param {().AdUnit} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1058,10 +1070,15 @@ export namespace adsensehost_v4_1 { * @param {object} params Parameters for request * @param {string} params.accountId Account which contains the ad client. * @param {string} params.adClientId Ad client for which to list ad units. - * @param {boolean=} params.includeInactive Whether to include inactive ad units. Default: true. - * @param {integer=} params.maxResults The maximum number of ad units to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {boolean=} params.includeInactive Whether to include inactive ad + * units. Default: true. + * @param {integer=} params.maxResults The maximum number of ad units to + * include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through ad units. To retrieve the next page, set this parameter to + * the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1133,7 +1150,8 @@ export namespace adsensehost_v4_1 { * @param {string} params.adClientId Ad client which contains the ad unit. * @param {string} params.adUnitId Ad unit to get. * @param {().AdUnit} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1204,7 +1222,8 @@ export namespace adsensehost_v4_1 { * @param {string} params.accountId Account which contains the ad client. * @param {string} params.adClientId Ad client which contains the ad unit. * @param {().AdUnit} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1444,15 +1463,25 @@ export namespace adsensehost_v4_1 { * @param {object} params Parameters for request * @param {string} params.accountId Hosted account upon which to report. * @param {string=} params.dimension Dimensions to base the report on. - * @param {string} params.endDate End of the date range to report on in "YYYY-MM-DD" format, inclusive. + * @param {string} params.endDate End of the date range to report on in + * "YYYY-MM-DD" format, inclusive. * @param {string=} params.filter Filters to be run on the report. - * @param {string=} params.locale Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. - * @param {integer=} params.maxResults The maximum number of rows of report data to return. + * @param {string=} params.locale Optional locale to use for translating + * report output to a local language. Defaults to "en_US" if not + * specified. + * @param {integer=} params.maxResults The maximum number of rows of report + * data to return. * @param {string=} params.metric Numeric columns to include in the report. - * @param {string=} params.sort The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. - * @param {string} params.startDate Start of the date range to report on in "YYYY-MM-DD" format, inclusive. - * @param {integer=} params.startIndex Index of the first row of report data to return. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.sort The name of a dimension or metric to sort + * the resulting report on, optionally prefixed with "+" to sort + * ascending or "-" to sort descending. If no prefix is specified, the + * column is sorted ascending. + * @param {string} params.startDate Start of the date range to report on in + * "YYYY-MM-DD" format, inclusive. + * @param {integer=} params.startIndex Index of the first row of report data + * to return. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1584,7 +1613,8 @@ export namespace adsensehost_v4_1 { * * @param {object} params Parameters for request * @param {string} params.adClientId Ad client to get. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1644,9 +1674,13 @@ export namespace adsensehost_v4_1 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {integer=} params.maxResults The maximum number of ad clients to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.maxResults The maximum number of ad clients to + * include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through ad clients. To retrieve the next page, set this parameter to + * the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1756,9 +1790,11 @@ export namespace adsensehost_v4_1 { * @param {object} params Parameters for request * @param {string} params.productCode Products to associate with the user. * @param {string=} params.userLocale The preferred locale of the user. - * @param {string=} params.websiteLocale The locale of the user's hosted website. + * @param {string=} params.websiteLocale The locale of the user's hosted + * website. * @param {string} params.websiteUrl The URL of the user's hosted website. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1825,8 +1861,10 @@ export namespace adsensehost_v4_1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.token The token returned to the association callback URL. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.token The token returned to the association + * callback URL. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1940,9 +1978,11 @@ export namespace adsensehost_v4_1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.adClientId Ad client from which to delete the custom channel. + * @param {string} params.adClientId Ad client from which to delete the + * custom channel. * @param {string} params.customChannelId Custom channel to delete. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2010,9 +2050,11 @@ export namespace adsensehost_v4_1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.adClientId Ad client from which to get the custom channel. + * @param {string} params.adClientId Ad client from which to get the custom + * channel. * @param {string} params.customChannelId Custom channel to get. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2076,9 +2118,11 @@ export namespace adsensehost_v4_1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.adClientId Ad client to which the new custom channel will be added. + * @param {string} params.adClientId Ad client to which the new custom + * channel will be added. * @param {().CustomChannel} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2145,10 +2189,15 @@ export namespace adsensehost_v4_1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.adClientId Ad client for which to list custom channels. - * @param {integer=} params.maxResults The maximum number of custom channels to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.adClientId Ad client for which to list custom + * channels. + * @param {integer=} params.maxResults The maximum number of custom channels + * to include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through custom channels. To retrieve the next page, set this + * parameter to the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2215,10 +2264,12 @@ export namespace adsensehost_v4_1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.adClientId Ad client in which the custom channel will be updated. + * @param {string} params.adClientId Ad client in which the custom channel + * will be updated. * @param {string} params.customChannelId Custom channel to get. * @param {().CustomChannel} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2285,9 +2336,11 @@ export namespace adsensehost_v4_1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.adClientId Ad client in which the custom channel will be updated. + * @param {string} params.adClientId Ad client in which the custom channel + * will be updated. * @param {().CustomChannel} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2475,15 +2528,25 @@ export namespace adsensehost_v4_1 { * * @param {object} params Parameters for request * @param {string=} params.dimension Dimensions to base the report on. - * @param {string} params.endDate End of the date range to report on in "YYYY-MM-DD" format, inclusive. + * @param {string} params.endDate End of the date range to report on in + * "YYYY-MM-DD" format, inclusive. * @param {string=} params.filter Filters to be run on the report. - * @param {string=} params.locale Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. - * @param {integer=} params.maxResults The maximum number of rows of report data to return. + * @param {string=} params.locale Optional locale to use for translating + * report output to a local language. Defaults to "en_US" if not + * specified. + * @param {integer=} params.maxResults The maximum number of rows of report + * data to return. * @param {string=} params.metric Numeric columns to include in the report. - * @param {string=} params.sort The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. - * @param {string} params.startDate Start of the date range to report on in "YYYY-MM-DD" format, inclusive. - * @param {integer=} params.startIndex Index of the first row of report data to return. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.sort The name of a dimension or metric to sort + * the resulting report on, optionally prefixed with "+" to sort + * ascending or "-" to sort descending. If no prefix is specified, the + * column is sorted ascending. + * @param {string} params.startDate Start of the date range to report on in + * "YYYY-MM-DD" format, inclusive. + * @param {integer=} params.startIndex Index of the first row of report data + * to return. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2607,9 +2670,11 @@ export namespace adsensehost_v4_1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.adClientId Ad client from which to delete the URL channel. + * @param {string} params.adClientId Ad client from which to delete the URL + * channel. * @param {string} params.urlChannelId URL channel to delete. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2677,9 +2742,11 @@ export namespace adsensehost_v4_1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.adClientId Ad client to which the new URL channel will be added. + * @param {string} params.adClientId Ad client to which the new URL channel + * will be added. * @param {().UrlChannel} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2746,10 +2813,15 @@ export namespace adsensehost_v4_1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.adClientId Ad client for which to list URL channels. - * @param {integer=} params.maxResults The maximum number of URL channels to include in the response, used for paging. - * @param {string=} params.pageToken A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.adClientId Ad client for which to list URL + * channels. + * @param {integer=} params.maxResults The maximum number of URL channels to + * include in the response, used for paging. + * @param {string=} params.pageToken A continuation token, used to page + * through URL channels. To retrieve the next page, set this parameter + * to the value of "nextPageToken" from the previous response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/analytics/v2.4.ts b/src/apis/analytics/v2.4.ts index 2ed63908f6b..b3c006fe759 100644 --- a/src/apis/analytics/v2.4.ts +++ b/src/apis/analytics/v2.4.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -88,17 +87,31 @@ export namespace analytics_v2_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.dimensions A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'. - * @param {string} params.end-date End date for fetching report data. All requests should specify an end date formatted as YYYY-MM-DD. - * @param {string=} params.filters A comma-separated list of dimension or metric filters to be applied to the report data. - * @param {string} params.ids Unique table ID for retrieving report data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. - * @param {integer=} params.max-results The maximum number of entries to include in this feed. - * @param {string} params.metrics A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified to retrieve a valid Analytics report. - * @param {string=} params.segment An Analytics advanced segment to be applied to the report data. - * @param {string=} params.sort A comma-separated list of dimensions or metrics that determine the sort order for the report data. - * @param {string} params.start-date Start date for fetching report data. All requests should specify a start date formatted as YYYY-MM-DD. - * @param {integer=} params.start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.dimensions A comma-separated list of Analytics + * dimensions. E.g., 'ga:browser,ga:city'. + * @param {string} params.end-date End date for fetching report data. All + * requests should specify an end date formatted as YYYY-MM-DD. + * @param {string=} params.filters A comma-separated list of dimension or + * metric filters to be applied to the report data. + * @param {string} params.ids Unique table ID for retrieving report data. + * Table ID is of the form ga:XXXX, where XXXX is the Analytics view + * (profile) ID. + * @param {integer=} params.max-results The maximum number of entries to + * include in this feed. + * @param {string} params.metrics A comma-separated list of Analytics + * metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must + * be specified to retrieve a valid Analytics report. + * @param {string=} params.segment An Analytics advanced segment to be + * applied to the report data. + * @param {string=} params.sort A comma-separated list of dimensions or + * metrics that determine the sort order for the report data. + * @param {string} params.start-date Start date for fetching report data. + * All requests should specify a start date formatted as YYYY-MM-DD. + * @param {integer=} params.start-index An index of the first entity to + * retrieve. Use this parameter as a pagination mechanism along with the + * max-results parameter. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -249,9 +262,13 @@ export namespace analytics_v2_4 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {integer=} params.max-results The maximum number of accounts to include in this response. - * @param {integer=} params.start-index An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.max-results The maximum number of accounts to + * include in this response. + * @param {integer=} params.start-index An index of the first account to + * retrieve. Use this parameter as a pagination mechanism along with the + * max-results parameter. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -345,12 +362,22 @@ export namespace analytics_v2_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID to retrieve goals for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to. - * @param {integer=} params.max-results The maximum number of goals to include in this response. - * @param {string} params.profileId View (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or '~all', which refers to all the views (profiles) that user has access to. - * @param {integer=} params.start-index An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * @param {string} params.webPropertyId Web property ID to retrieve goals for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Account ID to retrieve goals for. Can + * either be a specific account ID or '~all', which refers to all the + * accounts that user has access to. + * @param {integer=} params.max-results The maximum number of goals to + * include in this response. + * @param {string} params.profileId View (Profile) ID to retrieve goals for. + * Can either be a specific view (profile) ID or '~all', which refers to + * all the views (profiles) that user has access to. + * @param {integer=} params.start-index An index of the first goal to + * retrieve. Use this parameter as a pagination mechanism along with the + * max-results parameter. + * @param {string} params.webPropertyId Web property ID to retrieve goals + * for. Can either be a specific web property ID or '~all', which refers + * to all the web properties that user has access to. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -463,11 +490,20 @@ export namespace analytics_v2_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID for the views (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access. - * @param {integer=} params.max-results The maximum number of views (profiles) to include in this response. - * @param {integer=} params.start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * @param {string} params.webPropertyId Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Account ID for the views (profiles) to + * retrieve. Can either be a specific account ID or '~all', which refers + * to all the accounts to which the user has access. + * @param {integer=} params.max-results The maximum number of views + * (profiles) to include in this response. + * @param {integer=} params.start-index An index of the first entity to + * retrieve. Use this parameter as a pagination mechanism along with the + * max-results parameter. + * @param {string} params.webPropertyId Web property ID for the views + * (profiles) to retrieve. Can either be a specific web property ID or + * '~all', which refers to all the web properties to which the user has + * access. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -575,9 +611,13 @@ export namespace analytics_v2_4 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {integer=} params.max-results The maximum number of advanced segments to include in this response. - * @param {integer=} params.start-index An index of the first advanced segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.max-results The maximum number of advanced + * segments to include in this response. + * @param {integer=} params.start-index An index of the first advanced + * segment to retrieve. Use this parameter as a pagination mechanism + * along with the max-results parameter. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -671,10 +711,16 @@ export namespace analytics_v2_4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to. - * @param {integer=} params.max-results The maximum number of web properties to include in this response. - * @param {integer=} params.start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Account ID to retrieve web properties + * for. Can either be a specific account ID or '~all', which refers to + * all the accounts that user has access to. + * @param {integer=} params.max-results The maximum number of web properties + * to include in this response. + * @param {integer=} params.start-index An index of the first entity to + * retrieve. Use this parameter as a pagination mechanism along with the + * max-results parameter. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/analytics/v3.ts b/src/apis/analytics/v3.ts index 68930ce6ab2..1f99675a8f1 100644 --- a/src/apis/analytics/v3.ts +++ b/src/apis/analytics/v3.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -2684,20 +2683,40 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.dimensions A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'. - * @param {string} params.end-date End date for fetching Analytics data. Request can should specify an end date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is yesterday. - * @param {string=} params.filters A comma-separated list of dimension or metric filters to be applied to Analytics data. - * @param {string} params.ids Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. - * @param {boolean=} params.include-empty-rows The response will include empty rows if this parameter is set to true, the default is true - * @param {integer=} params.max-results The maximum number of entries to include in this feed. - * @param {string} params.metrics A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified. - * @param {string=} params.output The selected format for the response. Default format is JSON. + * @param {string=} params.dimensions A comma-separated list of Analytics + * dimensions. E.g., 'ga:browser,ga:city'. + * @param {string} params.end-date End date for fetching Analytics data. + * Request can should specify an end date formatted as YYYY-MM-DD, or as + * a relative date (e.g., today, yesterday, or 7daysAgo). The default + * value is yesterday. + * @param {string=} params.filters A comma-separated list of dimension or + * metric filters to be applied to Analytics data. + * @param {string} params.ids Unique table ID for retrieving Analytics data. + * Table ID is of the form ga:XXXX, where XXXX is the Analytics view + * (profile) ID. + * @param {boolean=} params.include-empty-rows The response will include + * empty rows if this parameter is set to true, the default is true + * @param {integer=} params.max-results The maximum number of entries to + * include in this feed. + * @param {string} params.metrics A comma-separated list of Analytics + * metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must + * be specified. + * @param {string=} params.output The selected format for the response. + * Default format is JSON. * @param {string=} params.samplingLevel The desired sampling level. - * @param {string=} params.segment An Analytics segment to be applied to data. - * @param {string=} params.sort A comma-separated list of dimensions or metrics that determine the sort order for Analytics data. - * @param {string} params.start-date Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo. - * @param {integer=} params.start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.segment An Analytics segment to be applied to + * data. + * @param {string=} params.sort A comma-separated list of dimensions or + * metrics that determine the sort order for Analytics data. + * @param {string} params.start-date Start date for fetching Analytics data. + * Requests can specify a start date formatted as YYYY-MM-DD, or as a + * relative date (e.g., today, yesterday, or 7daysAgo). The default + * value is 7daysAgo. + * @param {integer=} params.start-index An index of the first entity to + * retrieve. Use this parameter as a pagination mechanism along with the + * max-results parameter. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2841,17 +2860,35 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.dimensions A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source,mcf:medium'. - * @param {string} params.end-date End date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo. - * @param {string=} params.filters A comma-separated list of dimension or metric filters to be applied to the Analytics data. - * @param {string} params.ids Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. - * @param {integer=} params.max-results The maximum number of entries to include in this feed. - * @param {string} params.metrics A comma-separated list of Multi-Channel Funnels metrics. E.g., 'mcf:totalConversions,mcf:totalConversionValue'. At least one metric must be specified. + * @param {string=} params.dimensions A comma-separated list of + * Multi-Channel Funnels dimensions. E.g., 'mcf:source,mcf:medium'. + * @param {string} params.end-date End date for fetching Analytics data. + * Requests can specify a start date formatted as YYYY-MM-DD, or as a + * relative date (e.g., today, yesterday, or 7daysAgo). The default + * value is 7daysAgo. + * @param {string=} params.filters A comma-separated list of dimension or + * metric filters to be applied to the Analytics data. + * @param {string} params.ids Unique table ID for retrieving Analytics data. + * Table ID is of the form ga:XXXX, where XXXX is the Analytics view + * (profile) ID. + * @param {integer=} params.max-results The maximum number of entries to + * include in this feed. + * @param {string} params.metrics A comma-separated list of Multi-Channel + * Funnels metrics. E.g., + * 'mcf:totalConversions,mcf:totalConversionValue'. At least one metric + * must be specified. * @param {string=} params.samplingLevel The desired sampling level. - * @param {string=} params.sort A comma-separated list of dimensions or metrics that determine the sort order for the Analytics data. - * @param {string} params.start-date Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo. - * @param {integer=} params.start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.sort A comma-separated list of dimensions or + * metrics that determine the sort order for the Analytics data. + * @param {string} params.start-date Start date for fetching Analytics data. + * Requests can specify a start date formatted as YYYY-MM-DD, or as a + * relative date (e.g., today, yesterday, or 7daysAgo). The default + * value is 7daysAgo. + * @param {integer=} params.start-index An index of the first entity to + * retrieve. Use this parameter as a pagination mechanism along with the + * max-results parameter. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2983,13 +3020,22 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.dimensions A comma-separated list of real time dimensions. E.g., 'rt:medium,rt:city'. - * @param {string=} params.filters A comma-separated list of dimension or metric filters to be applied to real time data. - * @param {string} params.ids Unique table ID for retrieving real time data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. - * @param {integer=} params.max-results The maximum number of entries to include in this feed. - * @param {string} params.metrics A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least one metric must be specified. - * @param {string=} params.sort A comma-separated list of dimensions or metrics that determine the sort order for real time data. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.dimensions A comma-separated list of real time + * dimensions. E.g., 'rt:medium,rt:city'. + * @param {string=} params.filters A comma-separated list of dimension or + * metric filters to be applied to real time data. + * @param {string} params.ids Unique table ID for retrieving real time data. + * Table ID is of the form ga:XXXX, where XXXX is the Analytics view + * (profile) ID. + * @param {integer=} params.max-results The maximum number of entries to + * include in this feed. + * @param {string} params.metrics A comma-separated list of real time + * metrics. E.g., 'rt:activeUsers'. At least one metric must be + * specified. + * @param {string=} params.sort A comma-separated list of dimensions or + * metrics that determine the sort order for real time data. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3159,9 +3205,13 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {integer=} params.max-results The maximum number of accounts to include in this response. - * @param {integer=} params.start-index An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.max-results The maximum number of accounts to + * include in this response. + * @param {integer=} params.start-index An index of the first account to + * retrieve. Use this parameter as a pagination mechanism along with the + * max-results parameter. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3257,9 +3307,14 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {integer=} params.max-results The maximum number of account summaries to include in this response, where the largest acceptable value is 1000. - * @param {integer=} params.start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.max-results The maximum number of account + * summaries to include in this response, where the largest acceptable + * value is 1000. + * @param {integer=} params.start-index An index of the first entity to + * retrieve. Use this parameter as a pagination mechanism along with the + * max-results parameter. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3358,7 +3413,8 @@ export namespace analytics_v3 { * @param {object} params Parameters for request * @param {string} params.accountId Account ID to delete the user link for. * @param {string} params.linkId Link ID to delete the user link for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3426,7 +3482,8 @@ export namespace analytics_v3 { * @param {object} params Parameters for request * @param {string} params.accountId Account ID to create the user link for. * @param {().EntityUserLink} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3494,10 +3551,15 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID to retrieve the user links for. - * @param {integer=} params.max-results The maximum number of account-user links to include in this response. - * @param {integer=} params.start-index An index of the first account-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Account ID to retrieve the user links + * for. + * @param {integer=} params.max-results The maximum number of account-user + * links to include in this response. + * @param {integer=} params.start-index An index of the first account-user + * link to retrieve. Use this parameter as a pagination mechanism along + * with the max-results parameter. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3565,10 +3627,13 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID to update the account-user link for. - * @param {string} params.linkId Link ID to update the account-user link for. + * @param {string} params.accountId Account ID to update the account-user + * link for. + * @param {string} params.linkId Link ID to update the account-user link + * for. * @param {().EntityUserLink} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3722,7 +3787,8 @@ export namespace analytics_v3 { * * @param {object} params Parameters for request * @param {().HashClientIdRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3816,11 +3882,17 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account Id for the custom data sources to retrieve. - * @param {integer=} params.max-results The maximum number of custom data sources to include in this response. - * @param {integer=} params.start-index A 1-based index of the first custom data source to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * @param {string} params.webPropertyId Web property Id for the custom data sources to retrieve. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Account Id for the custom data sources + * to retrieve. + * @param {integer=} params.max-results The maximum number of custom data + * sources to include in this response. + * @param {integer=} params.start-index A 1-based index of the first custom + * data source to retrieve. Use this parameter as a pagination mechanism + * along with the max-results parameter. + * @param {string} params.webPropertyId Web property Id for the custom data + * sources to retrieve. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3926,10 +3998,14 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID for the custom dimension to retrieve. - * @param {string} params.customDimensionId The ID of the custom dimension to retrieve. - * @param {string} params.webPropertyId Web property ID for the custom dimension to retrieve. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Account ID for the custom dimension to + * retrieve. + * @param {string} params.customDimensionId The ID of the custom dimension + * to retrieve. + * @param {string} params.webPropertyId Web property ID for the custom + * dimension to retrieve. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3993,10 +4069,13 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID for the custom dimension to create. - * @param {string} params.webPropertyId Web property ID for the custom dimension to create. + * @param {string} params.accountId Account ID for the custom dimension to + * create. + * @param {string} params.webPropertyId Web property ID for the custom + * dimension to create. * @param {().CustomDimension} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4064,11 +4143,17 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID for the custom dimensions to retrieve. - * @param {integer=} params.max-results The maximum number of custom dimensions to include in this response. - * @param {integer=} params.start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * @param {string} params.webPropertyId Web property ID for the custom dimensions to retrieve. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Account ID for the custom dimensions to + * retrieve. + * @param {integer=} params.max-results The maximum number of custom + * dimensions to include in this response. + * @param {integer=} params.start-index An index of the first entity to + * retrieve. Use this parameter as a pagination mechanism along with the + * max-results parameter. + * @param {string} params.webPropertyId Web property ID for the custom + * dimensions to retrieve. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4137,12 +4222,18 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID for the custom dimension to update. - * @param {string} params.customDimensionId Custom dimension ID for the custom dimension to update. - * @param {boolean=} params.ignoreCustomDataSourceLinks Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set. - * @param {string} params.webPropertyId Web property ID for the custom dimension to update. + * @param {string} params.accountId Account ID for the custom dimension to + * update. + * @param {string} params.customDimensionId Custom dimension ID for the + * custom dimension to update. + * @param {boolean=} params.ignoreCustomDataSourceLinks Force the update and + * ignore any warnings related to the custom dimension being linked to a + * custom data source / data set. + * @param {string} params.webPropertyId Web property ID for the custom + * dimension to update. * @param {().CustomDimension} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4210,12 +4301,18 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID for the custom dimension to update. - * @param {string} params.customDimensionId Custom dimension ID for the custom dimension to update. - * @param {boolean=} params.ignoreCustomDataSourceLinks Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set. - * @param {string} params.webPropertyId Web property ID for the custom dimension to update. + * @param {string} params.accountId Account ID for the custom dimension to + * update. + * @param {string} params.customDimensionId Custom dimension ID for the + * custom dimension to update. + * @param {boolean=} params.ignoreCustomDataSourceLinks Force the update and + * ignore any warnings related to the custom dimension being linked to a + * custom data source / data set. + * @param {string} params.webPropertyId Web property ID for the custom + * dimension to update. * @param {().CustomDimension} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4418,10 +4515,14 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID for the custom metric to retrieve. - * @param {string} params.customMetricId The ID of the custom metric to retrieve. - * @param {string} params.webPropertyId Web property ID for the custom metric to retrieve. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Account ID for the custom metric to + * retrieve. + * @param {string} params.customMetricId The ID of the custom metric to + * retrieve. + * @param {string} params.webPropertyId Web property ID for the custom + * metric to retrieve. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4485,10 +4586,13 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID for the custom metric to create. - * @param {string} params.webPropertyId Web property ID for the custom dimension to create. + * @param {string} params.accountId Account ID for the custom metric to + * create. + * @param {string} params.webPropertyId Web property ID for the custom + * dimension to create. * @param {().CustomMetric} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4556,11 +4660,17 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID for the custom metrics to retrieve. - * @param {integer=} params.max-results The maximum number of custom metrics to include in this response. - * @param {integer=} params.start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * @param {string} params.webPropertyId Web property ID for the custom metrics to retrieve. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Account ID for the custom metrics to + * retrieve. + * @param {integer=} params.max-results The maximum number of custom metrics + * to include in this response. + * @param {integer=} params.start-index An index of the first entity to + * retrieve. Use this parameter as a pagination mechanism along with the + * max-results parameter. + * @param {string} params.webPropertyId Web property ID for the custom + * metrics to retrieve. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4629,12 +4739,18 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID for the custom metric to update. - * @param {string} params.customMetricId Custom metric ID for the custom metric to update. - * @param {boolean=} params.ignoreCustomDataSourceLinks Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set. - * @param {string} params.webPropertyId Web property ID for the custom metric to update. + * @param {string} params.accountId Account ID for the custom metric to + * update. + * @param {string} params.customMetricId Custom metric ID for the custom + * metric to update. + * @param {boolean=} params.ignoreCustomDataSourceLinks Force the update and + * ignore any warnings related to the custom metric being linked to a + * custom data source / data set. + * @param {string} params.webPropertyId Web property ID for the custom + * metric to update. * @param {().CustomMetric} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4702,12 +4818,18 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID for the custom metric to update. - * @param {string} params.customMetricId Custom metric ID for the custom metric to update. - * @param {boolean=} params.ignoreCustomDataSourceLinks Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set. - * @param {string} params.webPropertyId Web property ID for the custom metric to update. + * @param {string} params.accountId Account ID for the custom metric to + * update. + * @param {string} params.customMetricId Custom metric ID for the custom + * metric to update. + * @param {boolean=} params.ignoreCustomDataSourceLinks Force the update and + * ignore any warnings related to the custom metric being linked to a + * custom data source / data set. + * @param {string} params.webPropertyId Web property ID for the custom + * metric to update. * @param {().CustomMetric} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4910,11 +5032,15 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID to which the experiment belongs + * @param {string} params.accountId Account ID to which the experiment + * belongs * @param {string} params.experimentId ID of the experiment to delete - * @param {string} params.profileId View (Profile) ID to which the experiment belongs - * @param {string} params.webPropertyId Web property ID to which the experiment belongs - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.profileId View (Profile) ID to which the + * experiment belongs + * @param {string} params.webPropertyId Web property ID to which the + * experiment belongs + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4981,11 +5107,16 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID to retrieve the experiment for. - * @param {string} params.experimentId Experiment ID to retrieve the experiment for. - * @param {string} params.profileId View (Profile) ID to retrieve the experiment for. - * @param {string} params.webPropertyId Web property ID to retrieve the experiment for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Account ID to retrieve the experiment + * for. + * @param {string} params.experimentId Experiment ID to retrieve the + * experiment for. + * @param {string} params.profileId View (Profile) ID to retrieve the + * experiment for. + * @param {string} params.webPropertyId Web property ID to retrieve the + * experiment for. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5051,10 +5182,13 @@ export namespace analytics_v3 { * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to create the experiment for. - * @param {string} params.profileId View (Profile) ID to create the experiment for. - * @param {string} params.webPropertyId Web property ID to create the experiment for. + * @param {string} params.profileId View (Profile) ID to create the + * experiment for. + * @param {string} params.webPropertyId Web property ID to create the + * experiment for. * @param {().Experiment} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5123,11 +5257,17 @@ export namespace analytics_v3 { * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to retrieve experiments for. - * @param {integer=} params.max-results The maximum number of experiments to include in this response. - * @param {string} params.profileId View (Profile) ID to retrieve experiments for. - * @param {integer=} params.start-index An index of the first experiment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * @param {string} params.webPropertyId Web property ID to retrieve experiments for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.max-results The maximum number of experiments to + * include in this response. + * @param {string} params.profileId View (Profile) ID to retrieve + * experiments for. + * @param {integer=} params.start-index An index of the first experiment to + * retrieve. Use this parameter as a pagination mechanism along with the + * max-results parameter. + * @param {string} params.webPropertyId Web property ID to retrieve + * experiments for. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5197,11 +5337,15 @@ export namespace analytics_v3 { * * @param {object} params Parameters for request * @param {string} params.accountId Account ID of the experiment to update. - * @param {string} params.experimentId Experiment ID of the experiment to update. - * @param {string} params.profileId View (Profile) ID of the experiment to update. - * @param {string} params.webPropertyId Web property ID of the experiment to update. + * @param {string} params.experimentId Experiment ID of the experiment to + * update. + * @param {string} params.profileId View (Profile) ID of the experiment to + * update. + * @param {string} params.webPropertyId Web property ID of the experiment to + * update. * @param {().Experiment} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5271,11 +5415,15 @@ export namespace analytics_v3 { * * @param {object} params Parameters for request * @param {string} params.accountId Account ID of the experiment to update. - * @param {string} params.experimentId Experiment ID of the experiment to update. - * @param {string} params.profileId View (Profile) ID of the experiment to update. - * @param {string} params.webPropertyId Web property ID of the experiment to update. + * @param {string} params.experimentId Experiment ID of the experiment to + * update. + * @param {string} params.profileId View (Profile) ID of the experiment to + * update. + * @param {string} params.webPropertyId Web property ID of the experiment to + * update. * @param {().Experiment} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5514,7 +5662,8 @@ export namespace analytics_v3 { * @param {object} params Parameters for request * @param {string} params.accountId Account ID to delete the filter for. * @param {string} params.filterId ID of the filter to be deleted. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5583,7 +5732,8 @@ export namespace analytics_v3 { * @param {object} params Parameters for request * @param {string} params.accountId Account ID to retrieve filters for. * @param {string} params.filterId Filter ID to retrieve filters for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5648,7 +5798,8 @@ export namespace analytics_v3 { * @param {object} params Parameters for request * @param {string} params.accountId Account ID to create filter for. * @param {().Filter} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5715,9 +5866,13 @@ export namespace analytics_v3 { * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to retrieve filters for. - * @param {integer=} params.max-results The maximum number of filters to include in this response. - * @param {integer=} params.start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.max-results The maximum number of filters to + * include in this response. + * @param {integer=} params.start-index An index of the first entity to + * retrieve. Use this parameter as a pagination mechanism along with the + * max-results parameter. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5786,7 +5941,8 @@ export namespace analytics_v3 { * @param {string} params.accountId Account ID to which the filter belongs. * @param {string} params.filterId ID of the filter to be updated. * @param {().Filter} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5856,7 +6012,8 @@ export namespace analytics_v3 { * @param {string} params.accountId Account ID to which the filter belongs. * @param {string} params.filterId ID of the filter to be updated. * @param {().Filter} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6045,9 +6202,12 @@ export namespace analytics_v3 { * @param {object} params Parameters for request * @param {string} params.accountId Account ID to retrieve the goal for. * @param {string} params.goalId Goal ID to retrieve the goal for. - * @param {string} params.profileId View (Profile) ID to retrieve the goal for. - * @param {string} params.webPropertyId Web property ID to retrieve the goal for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.profileId View (Profile) ID to retrieve the goal + * for. + * @param {string} params.webPropertyId Web property ID to retrieve the goal + * for. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6111,10 +6271,13 @@ export namespace analytics_v3 { * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to create the goal for. - * @param {string} params.profileId View (Profile) ID to create the goal for. - * @param {string} params.webPropertyId Web property ID to create the goal for. + * @param {string} params.profileId View (Profile) ID to create the goal + * for. + * @param {string} params.webPropertyId Web property ID to create the goal + * for. * @param {().Goal} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6181,12 +6344,22 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID to retrieve goals for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to. - * @param {integer=} params.max-results The maximum number of goals to include in this response. - * @param {string} params.profileId View (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or '~all', which refers to all the views (profiles) that user has access to. - * @param {integer=} params.start-index An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * @param {string} params.webPropertyId Web property ID to retrieve goals for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Account ID to retrieve goals for. Can + * either be a specific account ID or '~all', which refers to all the + * accounts that user has access to. + * @param {integer=} params.max-results The maximum number of goals to + * include in this response. + * @param {string} params.profileId View (Profile) ID to retrieve goals for. + * Can either be a specific view (profile) ID or '~all', which refers to + * all the views (profiles) that user has access to. + * @param {integer=} params.start-index An index of the first goal to + * retrieve. Use this parameter as a pagination mechanism along with the + * max-results parameter. + * @param {string} params.webPropertyId Web property ID to retrieve goals + * for. Can either be a specific web property ID or '~all', which refers + * to all the web properties that user has access to. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6258,7 +6431,8 @@ export namespace analytics_v3 { * @param {string} params.profileId View (Profile) ID to update the goal. * @param {string} params.webPropertyId Web property ID to update the goal. * @param {().Goal} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6330,7 +6504,8 @@ export namespace analytics_v3 { * @param {string} params.profileId View (Profile) ID to update the goal. * @param {string} params.webPropertyId Web property ID to update the goal. * @param {().Goal} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6547,11 +6722,15 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID to which the profile filter link belongs. + * @param {string} params.accountId Account ID to which the profile filter + * link belongs. * @param {string} params.linkId ID of the profile filter link to delete. - * @param {string} params.profileId Profile ID to which the filter link belongs. - * @param {string} params.webPropertyId Web property Id to which the profile filter link belongs. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.profileId Profile ID to which the filter link + * belongs. + * @param {string} params.webPropertyId Web property Id to which the profile + * filter link belongs. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6617,11 +6796,14 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID to retrieve profile filter link for. + * @param {string} params.accountId Account ID to retrieve profile filter + * link for. * @param {string} params.linkId ID of the profile filter link. * @param {string} params.profileId Profile ID to retrieve filter link for. - * @param {string} params.webPropertyId Web property Id to retrieve profile filter link for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.webPropertyId Web property Id to retrieve profile + * filter link for. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6685,11 +6867,14 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID to create profile filter link for. + * @param {string} params.accountId Account ID to create profile filter link + * for. * @param {string} params.profileId Profile ID to create filter link for. - * @param {string} params.webPropertyId Web property Id to create profile filter link for. + * @param {string} params.webPropertyId Web property Id to create profile + * filter link for. * @param {().ProfileFilterLink} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6757,12 +6942,21 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID to retrieve profile filter links for. - * @param {integer=} params.max-results The maximum number of profile filter links to include in this response. - * @param {string} params.profileId Profile ID to retrieve filter links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to. - * @param {integer=} params.start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * @param {string} params.webPropertyId Web property Id for profile filter links for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Account ID to retrieve profile filter + * links for. + * @param {integer=} params.max-results The maximum number of profile filter + * links to include in this response. + * @param {string} params.profileId Profile ID to retrieve filter links for. + * Can either be a specific profile ID or '~all', which refers to all + * the profiles that user has access to. + * @param {integer=} params.start-index An index of the first entity to + * retrieve. Use this parameter as a pagination mechanism along with the + * max-results parameter. + * @param {string} params.webPropertyId Web property Id for profile filter + * links for. Can either be a specific web property ID or '~all', which + * refers to all the web properties that user has access to. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6831,12 +7025,16 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID to which profile filter link belongs. - * @param {string} params.linkId ID of the profile filter link to be updated. + * @param {string} params.accountId Account ID to which profile filter link + * belongs. + * @param {string} params.linkId ID of the profile filter link to be + * updated. * @param {string} params.profileId Profile ID to which filter link belongs - * @param {string} params.webPropertyId Web property Id to which profile filter link belongs + * @param {string} params.webPropertyId Web property Id to which profile + * filter link belongs * @param {().ProfileFilterLink} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6904,12 +7102,16 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID to which profile filter link belongs. - * @param {string} params.linkId ID of the profile filter link to be updated. + * @param {string} params.accountId Account ID to which profile filter link + * belongs. + * @param {string} params.linkId ID of the profile filter link to be + * updated. * @param {string} params.profileId Profile ID to which filter link belongs - * @param {string} params.webPropertyId Web property Id to which profile filter link belongs + * @param {string} params.webPropertyId Web property Id to which profile + * filter link belongs * @param {().ProfileFilterLink} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -7148,10 +7350,13 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID to delete the view (profile) for. + * @param {string} params.accountId Account ID to delete the view (profile) + * for. * @param {string} params.profileId ID of the view (profile) to be deleted. - * @param {string} params.webPropertyId Web property ID to delete the view (profile) for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.webPropertyId Web property ID to delete the view + * (profile) for. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -7217,10 +7422,14 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID to retrieve the view (profile) for. - * @param {string} params.profileId View (Profile) ID to retrieve the view (profile) for. - * @param {string} params.webPropertyId Web property ID to retrieve the view (profile) for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Account ID to retrieve the view + * (profile) for. + * @param {string} params.profileId View (Profile) ID to retrieve the view + * (profile) for. + * @param {string} params.webPropertyId Web property ID to retrieve the view + * (profile) for. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -7283,10 +7492,13 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID to create the view (profile) for. - * @param {string} params.webPropertyId Web property ID to create the view (profile) for. + * @param {string} params.accountId Account ID to create the view (profile) + * for. + * @param {string} params.webPropertyId Web property ID to create the view + * (profile) for. * @param {().Profile} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -7353,11 +7565,20 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID for the view (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access. - * @param {integer=} params.max-results The maximum number of views (profiles) to include in this response. - * @param {integer=} params.start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * @param {string} params.webPropertyId Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Account ID for the view (profiles) to + * retrieve. Can either be a specific account ID or '~all', which refers + * to all the accounts to which the user has access. + * @param {integer=} params.max-results The maximum number of views + * (profiles) to include in this response. + * @param {integer=} params.start-index An index of the first entity to + * retrieve. Use this parameter as a pagination mechanism along with the + * max-results parameter. + * @param {string} params.webPropertyId Web property ID for the views + * (profiles) to retrieve. Can either be a specific web property ID or + * '~all', which refers to all the web properties to which the user has + * access. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -7425,11 +7646,14 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID to which the view (profile) belongs + * @param {string} params.accountId Account ID to which the view (profile) + * belongs * @param {string} params.profileId ID of the view (profile) to be updated. - * @param {string} params.webPropertyId Web property ID to which the view (profile) belongs + * @param {string} params.webPropertyId Web property ID to which the view + * (profile) belongs * @param {().Profile} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -7496,11 +7720,14 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID to which the view (profile) belongs + * @param {string} params.accountId Account ID to which the view (profile) + * belongs * @param {string} params.profileId ID of the view (profile) to be updated. - * @param {string} params.webPropertyId Web property ID to which the view (profile) belongs + * @param {string} params.webPropertyId Web property ID to which the view + * (profile) belongs * @param {().Profile} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -7717,9 +7944,12 @@ export namespace analytics_v3 { * @param {object} params Parameters for request * @param {string} params.accountId Account ID to delete the user link for. * @param {string} params.linkId Link ID to delete the user link for. - * @param {string} params.profileId View (Profile) ID to delete the user link for. - * @param {string} params.webPropertyId Web Property ID to delete the user link for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.profileId View (Profile) ID to delete the user + * link for. + * @param {string} params.webPropertyId Web Property ID to delete the user + * link for. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -7786,10 +8016,13 @@ export namespace analytics_v3 { * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to create the user link for. - * @param {string} params.profileId View (Profile) ID to create the user link for. - * @param {string} params.webPropertyId Web Property ID to create the user link for. + * @param {string} params.profileId View (Profile) ID to create the user + * link for. + * @param {string} params.webPropertyId Web Property ID to create the user + * link for. * @param {().EntityUserLink} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -7857,12 +8090,22 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID which the given view (profile) belongs to. - * @param {integer=} params.max-results The maximum number of profile-user links to include in this response. - * @param {string} params.profileId View (Profile) ID to retrieve the profile-user links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to. - * @param {integer=} params.start-index An index of the first profile-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * @param {string} params.webPropertyId Web Property ID which the given view (profile) belongs to. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Account ID which the given view + * (profile) belongs to. + * @param {integer=} params.max-results The maximum number of profile-user + * links to include in this response. + * @param {string} params.profileId View (Profile) ID to retrieve the + * profile-user links for. Can either be a specific profile ID or + * '~all', which refers to all the profiles that user has access to. + * @param {integer=} params.start-index An index of the first profile-user + * link to retrieve. Use this parameter as a pagination mechanism along + * with the max-results parameter. + * @param {string} params.webPropertyId Web Property ID which the given view + * (profile) belongs to. Can either be a specific web property ID or + * '~all', which refers to all the web properties that user has access + * to. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -7933,10 +8176,13 @@ export namespace analytics_v3 { * @param {object} params Parameters for request * @param {string} params.accountId Account ID to update the user link for. * @param {string} params.linkId Link ID to update the user link for. - * @param {string} params.profileId View (Profile ID) to update the user link for. - * @param {string} params.webPropertyId Web Property ID to update the user link for. + * @param {string} params.profileId View (Profile ID) to update the user + * link for. + * @param {string} params.webPropertyId Web Property ID to update the user + * link for. * @param {().EntityUserLink} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8125,10 +8371,14 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID to which the remarketing audience belongs. - * @param {string} params.remarketingAudienceId The ID of the remarketing audience to delete. - * @param {string} params.webPropertyId Web property ID to which the remarketing audience belongs. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Account ID to which the remarketing + * audience belongs. + * @param {string} params.remarketingAudienceId The ID of the remarketing + * audience to delete. + * @param {string} params.webPropertyId Web property ID to which the + * remarketing audience belongs. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8195,10 +8445,14 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId The account ID of the remarketing audience to retrieve. - * @param {string} params.remarketingAudienceId The ID of the remarketing audience to retrieve. - * @param {string} params.webPropertyId The web property ID of the remarketing audience to retrieve. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId The account ID of the remarketing + * audience to retrieve. + * @param {string} params.remarketingAudienceId The ID of the remarketing + * audience to retrieve. + * @param {string} params.webPropertyId The web property ID of the + * remarketing audience to retrieve. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8262,10 +8516,13 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId The account ID for which to create the remarketing audience. - * @param {string} params.webPropertyId Web property ID for which to create the remarketing audience. + * @param {string} params.accountId The account ID for which to create the + * remarketing audience. + * @param {string} params.webPropertyId Web property ID for which to create + * the remarketing audience. * @param {().RemarketingAudience} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8334,12 +8591,18 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId The account ID of the remarketing audiences to retrieve. - * @param {integer=} params.max-results The maximum number of remarketing audiences to include in this response. - * @param {integer=} params.start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. + * @param {string} params.accountId The account ID of the remarketing + * audiences to retrieve. + * @param {integer=} params.max-results The maximum number of remarketing + * audiences to include in this response. + * @param {integer=} params.start-index An index of the first entity to + * retrieve. Use this parameter as a pagination mechanism along with the + * max-results parameter. * @param {string=} params.type - * @param {string} params.webPropertyId The web property ID of the remarketing audiences to retrieve. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.webPropertyId The web property ID of the + * remarketing audiences to retrieve. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8409,11 +8672,15 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId The account ID of the remarketing audience to update. - * @param {string} params.remarketingAudienceId The ID of the remarketing audience to update. - * @param {string} params.webPropertyId The web property ID of the remarketing audience to update. + * @param {string} params.accountId The account ID of the remarketing + * audience to update. + * @param {string} params.remarketingAudienceId The ID of the remarketing + * audience to update. + * @param {string} params.webPropertyId The web property ID of the + * remarketing audience to update. * @param {().RemarketingAudience} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8481,11 +8748,15 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId The account ID of the remarketing audience to update. - * @param {string} params.remarketingAudienceId The ID of the remarketing audience to update. - * @param {string} params.webPropertyId The web property ID of the remarketing audience to update. + * @param {string} params.accountId The account ID of the remarketing + * audience to update. + * @param {string} params.remarketingAudienceId The ID of the remarketing + * audience to update. + * @param {string} params.webPropertyId The web property ID of the + * remarketing audience to update. * @param {().RemarketingAudience} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8702,9 +8973,13 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {integer=} params.max-results The maximum number of segments to include in this response. - * @param {integer=} params.start-index An index of the first segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.max-results The maximum number of segments to + * include in this response. + * @param {integer=} params.start-index An index of the first segment to + * retrieve. Use this parameter as a pagination mechanism along with the + * max-results parameter. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8799,11 +9074,16 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID to delete the unsampled report for. - * @param {string} params.profileId View (Profile) ID to delete the unsampled report for. - * @param {string} params.unsampledReportId ID of the unsampled report to be deleted. - * @param {string} params.webPropertyId Web property ID to delete the unsampled reports for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Account ID to delete the unsampled + * report for. + * @param {string} params.profileId View (Profile) ID to delete the + * unsampled report for. + * @param {string} params.unsampledReportId ID of the unsampled report to be + * deleted. + * @param {string} params.webPropertyId Web property ID to delete the + * unsampled reports for. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8871,11 +9151,16 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID to retrieve unsampled report for. - * @param {string} params.profileId View (Profile) ID to retrieve unsampled report for. - * @param {string} params.unsampledReportId ID of the unsampled report to retrieve. - * @param {string} params.webPropertyId Web property ID to retrieve unsampled reports for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Account ID to retrieve unsampled report + * for. + * @param {string} params.profileId View (Profile) ID to retrieve unsampled + * report for. + * @param {string} params.unsampledReportId ID of the unsampled report to + * retrieve. + * @param {string} params.webPropertyId Web property ID to retrieve + * unsampled reports for. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8941,11 +9226,15 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID to create the unsampled report for. - * @param {string} params.profileId View (Profile) ID to create the unsampled report for. - * @param {string} params.webPropertyId Web property ID to create the unsampled report for. + * @param {string} params.accountId Account ID to create the unsampled + * report for. + * @param {string} params.profileId View (Profile) ID to create the + * unsampled report for. + * @param {string} params.webPropertyId Web property ID to create the + * unsampled report for. * @param {().UnsampledReport} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -9013,12 +9302,21 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID to retrieve unsampled reports for. Must be a specific account ID, ~all is not supported. - * @param {integer=} params.max-results The maximum number of unsampled reports to include in this response. - * @param {string} params.profileId View (Profile) ID to retrieve unsampled reports for. Must be a specific view (profile) ID, ~all is not supported. - * @param {integer=} params.start-index An index of the first unsampled report to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * @param {string} params.webPropertyId Web property ID to retrieve unsampled reports for. Must be a specific web property ID, ~all is not supported. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Account ID to retrieve unsampled reports + * for. Must be a specific account ID, ~all is not supported. + * @param {integer=} params.max-results The maximum number of unsampled + * reports to include in this response. + * @param {string} params.profileId View (Profile) ID to retrieve unsampled + * reports for. Must be a specific view (profile) ID, ~all is not + * supported. + * @param {integer=} params.start-index An index of the first unsampled + * report to retrieve. Use this parameter as a pagination mechanism + * along with the max-results parameter. + * @param {string} params.webPropertyId Web property ID to retrieve + * unsampled reports for. Must be a specific web property ID, ~all is + * not supported. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -9201,11 +9499,16 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account Id for the uploads to be deleted. - * @param {string} params.customDataSourceId Custom data source Id for the uploads to be deleted. - * @param {string} params.webPropertyId Web property Id for the uploads to be deleted. - * @param {().AnalyticsDataimportDeleteUploadDataRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Account Id for the uploads to be + * deleted. + * @param {string} params.customDataSourceId Custom data source Id for the + * uploads to be deleted. + * @param {string} params.webPropertyId Web property Id for the uploads to + * be deleted. + * @param {().AnalyticsDataimportDeleteUploadDataRequest} params.resource + * Request body data + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -9272,10 +9575,13 @@ export namespace analytics_v3 { * * @param {object} params Parameters for request * @param {string} params.accountId Account Id for the upload to retrieve. - * @param {string} params.customDataSourceId Custom data source Id for upload to retrieve. + * @param {string} params.customDataSourceId Custom data source Id for + * upload to retrieve. * @param {string} params.uploadId Upload Id to retrieve. - * @param {string} params.webPropertyId Web property Id for the upload to retrieve. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.webPropertyId Web property Id for the upload to + * retrieve. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -9341,11 +9647,17 @@ export namespace analytics_v3 { * * @param {object} params Parameters for request * @param {string} params.accountId Account Id for the uploads to retrieve. - * @param {string} params.customDataSourceId Custom data source Id for uploads to retrieve. - * @param {integer=} params.max-results The maximum number of uploads to include in this response. - * @param {integer=} params.start-index A 1-based index of the first upload to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * @param {string} params.webPropertyId Web property Id for the uploads to retrieve. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.customDataSourceId Custom data source Id for + * uploads to retrieve. + * @param {integer=} params.max-results The maximum number of uploads to + * include in this response. + * @param {integer=} params.start-index A 1-based index of the first upload + * to retrieve. Use this parameter as a pagination mechanism along with + * the max-results parameter. + * @param {string} params.webPropertyId Web property Id for the uploads to + * retrieve. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -9413,12 +9725,15 @@ export namespace analytics_v3 { * * @param {object} params Parameters for request * @param {string} params.accountId Account Id associated with the upload. - * @param {string} params.customDataSourceId Custom data source Id to which the data being uploaded belongs. - * @param {string} params.webPropertyId Web property UA-string associated with the upload. + * @param {string} params.customDataSourceId Custom data source Id to which + * the data being uploaded belongs. + * @param {string} params.webPropertyId Web property UA-string associated + * with the upload. * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type * @param {string|object} params.media.body Media body contents - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -9613,9 +9928,11 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID to retrieve the web property for. + * @param {string} params.accountId Account ID to retrieve the web property + * for. * @param {string} params.webPropertyId ID to retrieve the web property for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -9681,9 +9998,11 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID to create the web property for. + * @param {string} params.accountId Account ID to create the web property + * for. * @param {().Webproperty} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -9751,10 +10070,16 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to. - * @param {integer=} params.max-results The maximum number of web properties to include in this response. - * @param {integer=} params.start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Account ID to retrieve web properties + * for. Can either be a specific account ID or '~all', which refers to + * all the accounts that user has access to. + * @param {integer=} params.max-results The maximum number of web properties + * to include in this response. + * @param {integer=} params.start-index An index of the first entity to + * retrieve. Use this parameter as a pagination mechanism along with the + * max-results parameter. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -9823,10 +10148,12 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID to which the web property belongs + * @param {string} params.accountId Account ID to which the web property + * belongs * @param {string} params.webPropertyId Web property ID * @param {().Webproperty} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -9894,10 +10221,12 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID to which the web property belongs + * @param {string} params.accountId Account ID to which the web property + * belongs * @param {string} params.webPropertyId Web property ID * @param {().Webproperty} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -10072,10 +10401,14 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId ID of the account which the given web property belongs to. - * @param {string} params.webPropertyAdWordsLinkId Web property AdWords link ID. - * @param {string} params.webPropertyId Web property ID to delete the AdWords link for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId ID of the account which the given web + * property belongs to. + * @param {string} params.webPropertyAdWordsLinkId Web property AdWords link + * ID. + * @param {string} params.webPropertyId Web property ID to delete the + * AdWords link for. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -10144,10 +10477,14 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId ID of the account which the given web property belongs to. - * @param {string} params.webPropertyAdWordsLinkId Web property-AdWords link ID. - * @param {string} params.webPropertyId Web property ID to retrieve the AdWords link for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId ID of the account which the given web + * property belongs to. + * @param {string} params.webPropertyAdWordsLinkId Web property-AdWords link + * ID. + * @param {string} params.webPropertyId Web property ID to retrieve the + * AdWords link for. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -10213,10 +10550,13 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId ID of the Google Analytics account to create the link for. - * @param {string} params.webPropertyId Web property ID to create the link for. + * @param {string} params.accountId ID of the Google Analytics account to + * create the link for. + * @param {string} params.webPropertyId Web property ID to create the link + * for. * @param {().EntityAdWordsLink} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -10286,11 +10626,17 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId ID of the account which the given web property belongs to. - * @param {integer=} params.max-results The maximum number of webProperty-AdWords links to include in this response. - * @param {integer=} params.start-index An index of the first webProperty-AdWords link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * @param {string} params.webPropertyId Web property ID to retrieve the AdWords links for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId ID of the account which the given web + * property belongs to. + * @param {integer=} params.max-results The maximum number of + * webProperty-AdWords links to include in this response. + * @param {integer=} params.start-index An index of the first + * webProperty-AdWords link to retrieve. Use this parameter as a + * pagination mechanism along with the max-results parameter. + * @param {string} params.webPropertyId Web property ID to retrieve the + * AdWords links for. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -10360,11 +10706,15 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId ID of the account which the given web property belongs to. - * @param {string} params.webPropertyAdWordsLinkId Web property-AdWords link ID. - * @param {string} params.webPropertyId Web property ID to retrieve the AdWords link for. + * @param {string} params.accountId ID of the account which the given web + * property belongs to. + * @param {string} params.webPropertyAdWordsLinkId Web property-AdWords link + * ID. + * @param {string} params.webPropertyId Web property ID to retrieve the + * AdWords link for. * @param {().EntityAdWordsLink} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -10434,11 +10784,15 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId ID of the account which the given web property belongs to. - * @param {string} params.webPropertyAdWordsLinkId Web property-AdWords link ID. - * @param {string} params.webPropertyId Web property ID to retrieve the AdWords link for. + * @param {string} params.accountId ID of the account which the given web + * property belongs to. + * @param {string} params.webPropertyAdWordsLinkId Web property-AdWords link + * ID. + * @param {string} params.webPropertyId Web property ID to retrieve the + * AdWords link for. * @param {().EntityAdWordsLink} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -10656,8 +11010,10 @@ export namespace analytics_v3 { * @param {object} params Parameters for request * @param {string} params.accountId Account ID to delete the user link for. * @param {string} params.linkId Link ID to delete the user link for. - * @param {string} params.webPropertyId Web Property ID to delete the user link for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.webPropertyId Web Property ID to delete the user + * link for. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -10725,9 +11081,11 @@ export namespace analytics_v3 { * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to create the user link for. - * @param {string} params.webPropertyId Web Property ID to create the user link for. + * @param {string} params.webPropertyId Web Property ID to create the user + * link for. * @param {().EntityUserLink} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -10796,11 +11154,19 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID which the given web property belongs to. - * @param {integer=} params.max-results The maximum number of webProperty-user Links to include in this response. - * @param {integer=} params.start-index An index of the first webProperty-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * @param {string} params.webPropertyId Web Property ID for the webProperty-user links to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.accountId Account ID which the given web property + * belongs to. + * @param {integer=} params.max-results The maximum number of + * webProperty-user Links to include in this response. + * @param {integer=} params.start-index An index of the first + * webProperty-user link to retrieve. Use this parameter as a pagination + * mechanism along with the max-results parameter. + * @param {string} params.webPropertyId Web Property ID for the + * webProperty-user links to retrieve. Can either be a specific web + * property ID or '~all', which refers to all the web properties that + * user has access to. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -10868,11 +11234,15 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.accountId Account ID to update the account-user link for. - * @param {string} params.linkId Link ID to update the account-user link for. - * @param {string} params.webPropertyId Web property ID to update the account-user link for. + * @param {string} params.accountId Account ID to update the account-user + * link for. + * @param {string} params.linkId Link ID to update the account-user link + * for. + * @param {string} params.webPropertyId Web property ID to update the + * account-user link for. * @param {().EntityUserLink} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -11060,8 +11430,10 @@ export namespace analytics_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.reportType Report type. Allowed Values: 'ga'. Where 'ga' corresponds to the Core Reporting API - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.reportType Report type. Allowed Values: 'ga'. + * Where 'ga' corresponds to the Core Reporting API + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -11154,7 +11526,8 @@ export namespace analytics_v3 { * * @param {object} params Parameters for request * @param {().AccountTicket} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -11222,7 +11595,8 @@ export namespace analytics_v3 { * * @param {object} params Parameters for request * @param {().AccountTreeRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -11344,7 +11718,8 @@ export namespace analytics_v3 { * * @param {object} params Parameters for request * @param {().UserDeletionRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/analyticsreporting/v4.ts b/src/apis/analyticsreporting/v4.ts index 0cf573f40fd..2a380f8eeba 100644 --- a/src/apis/analyticsreporting/v4.ts +++ b/src/apis/analyticsreporting/v4.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -971,7 +970,8 @@ export namespace analyticsreporting_v4 { * * @param {object} params Parameters for request * @param {().GetReportsRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/androiddeviceprovisioning/v1.ts b/src/apis/androiddeviceprovisioning/v1.ts index ab3986df4d7..fc639e69cda 100644 --- a/src/apis/androiddeviceprovisioning/v1.ts +++ b/src/apis/androiddeviceprovisioning/v1.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -113,7 +112,8 @@ export namespace androiddeviceprovisioning_v1 { claims?: Schema$PartnerClaim[]; } /** - * A customer resource in the zero-touch enrollment API. + * A reseller, vendor, or customer in the zero-touch reseller and customer + * APIs. */ export interface Schema$Company { /** @@ -127,12 +127,16 @@ export namespace androiddeviceprovisioning_v1 { companyId?: string; /** * Required. The name of the company. For example _XYZ Corp_. Displayed to - * the customer's employees in the zero-touch enrollment portal. + * the company's employees in the zero-touch enrollment portal. */ companyName?: string; /** - * Output only. The API resource name of the company in the format - * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]`. Assigned by the server. + * Output only. The API resource name of the company. The resource name is + * one of the following formats: * + * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]` * + * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]` * + * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]` + * Assigned by the server. */ name?: string; /** @@ -367,7 +371,8 @@ export namespace androiddeviceprovisioning_v1 { } /** * Encapsulates hardware and product IDs to identify a manufactured device. To - * learn more, read [Identifiers](/zero-touch/guides/identifiers). + * understand requirements on identifier sets, read + * [Identifiers](/zero-touch/guides/identifiers). */ export interface Schema$DeviceIdentifier { /** @@ -375,19 +380,25 @@ export namespace androiddeviceprovisioning_v1 { */ imei?: string; /** - * Required. The device manufacturer’s name. Matches the device's - * built-in value returned from `android.os.Build.MANUFACTURER`. Allowed - * values are listed in [manufacturer - * names](/zero-touch/resources/manufacturer-names). + * The device manufacturer’s name. Matches the device's built-in value + * returned from `android.os.Build.MANUFACTURER`. Allowed values are listed + * in + * [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names). */ manufacturer?: string; /** * The device’s MEID number. */ meid?: string; + /** + * The device model's name. Matches the device's built-in value + * returned from `android.os.Build.MODEL`. Allowed values are listed in + * [models](/zero-touch/resources/manufacturer-names#model-names). + */ + model?: string; /** * The manufacturer's serial number for the device. This value might not - * be unique. + * be unique across different device models. */ serialNumber?: string; } @@ -863,9 +874,12 @@ export namespace androiddeviceprovisioning_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize The maximum number of customers to show in a page of results. A number between 1 and 100 (inclusive). - * @param {string=} params.pageToken A token specifying which result page to return. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.pageSize The maximum number of customers to show + * in a page of results. A number between 1 and 100 (inclusive). + * @param {string=} params.pageToken A token specifying which result page to + * return. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -965,9 +979,12 @@ export namespace androiddeviceprovisioning_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The customer that manages the configuration. An API resource name in the format `customers/[CUSTOMER_ID]`. + * @param {string} params.parent Required. The customer that manages the + * configuration. An API resource name in the format + * `customers/[CUSTOMER_ID]`. * @param {().Configuration} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1035,8 +1052,12 @@ export namespace androiddeviceprovisioning_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The configuration to delete. An API resource name in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. If the configuration is applied to any devices, the API call fails. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.name Required. The configuration to delete. An API + * resource name in the format + * `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. If the + * configuration is applied to any devices, the API call fails. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1101,8 +1122,11 @@ export namespace androiddeviceprovisioning_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The configuration to get. An API resource name in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.name Required. The configuration to get. An API + * resource name in the format + * `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1164,8 +1188,11 @@ export namespace androiddeviceprovisioning_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The customer that manages the listed configurations. An API resource name in the format `customers/[CUSTOMER_ID]`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.parent Required. The customer that manages the + * listed configurations. An API resource name in the format + * `customers/[CUSTOMER_ID]`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1243,10 +1270,17 @@ export namespace androiddeviceprovisioning_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Output only. The API resource name in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by the server. - * @param {string=} params.updateMask Required. The field mask applied to the target `Configuration` before updating the fields. To learn more about using field masks, read [FieldMask](/protocol-buffers/docs/reference/google.protobuf#fieldmask) in the Protocol Buffers documentation. + * @param {string} params.name Output only. The API resource name in the + * format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. + * Assigned by the server. + * @param {string=} params.updateMask Required. The field mask applied to + * the target `Configuration` before updating the fields. To learn more + * about using field masks, read + * [FieldMask](/protocol-buffers/docs/reference/google.protobuf#fieldmask) + * in the Protocol Buffers documentation. * @param {().Configuration} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1408,9 +1442,12 @@ export namespace androiddeviceprovisioning_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The customer managing the device. An API resource name in the format `customers/[CUSTOMER_ID]`. - * @param {().CustomerApplyConfigurationRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.parent Required. The customer managing the device. + * An API resource name in the format `customers/[CUSTOMER_ID]`. + * @param {().CustomerApplyConfigurationRequest} params.resource Request + * body data + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1476,8 +1513,10 @@ export namespace androiddeviceprovisioning_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The device to get. An API resource name in the format `customers/[CUSTOMER_ID]/devices/[DEVICE_ID]`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.name Required. The device to get. An API resource + * name in the format `customers/[CUSTOMER_ID]/devices/[DEVICE_ID]`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1538,10 +1577,15 @@ export namespace androiddeviceprovisioning_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.pageSize The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive. - * @param {string=} params.pageToken A token specifying which result page to return. - * @param {string} params.parent Required. The customer managing the devices. An API resource name in the format `customers/[CUSTOMER_ID]`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pageSize The maximum number of devices to show in + * a page of results. Must be between 1 and 100 inclusive. + * @param {string=} params.pageToken A token specifying which result page to + * return. + * @param {string} params.parent Required. The customer managing the + * devices. An API resource name in the format + * `customers/[CUSTOMER_ID]`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1614,9 +1658,12 @@ export namespace androiddeviceprovisioning_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The customer managing the device in the format `customers/[CUSTOMER_ID]`. - * @param {().CustomerRemoveConfigurationRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.parent Required. The customer managing the device + * in the format `customers/[CUSTOMER_ID]`. + * @param {().CustomerRemoveConfigurationRequest} params.resource Request + * body data + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1685,9 +1732,12 @@ export namespace androiddeviceprovisioning_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The customer managing the device. An API resource name in the format `customers/[CUSTOMER_ID]`. - * @param {().CustomerUnclaimDeviceRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.parent Required. The customer managing the device. + * An API resource name in the format `customers/[CUSTOMER_ID]`. + * @param {().CustomerUnclaimDeviceRequest} params.resource Request body + * data + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1852,8 +1902,11 @@ export namespace androiddeviceprovisioning_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The customer that can use the DPCs in configurations. An API resource name in the format `customers/[CUSTOMER_ID]`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.parent Required. The customer that can use the + * DPCs in configurations. An API resource name in the format + * `customers/[CUSTOMER_ID]`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1950,7 +2003,8 @@ export namespace androiddeviceprovisioning_v1 { * * @param {object} params Parameters for request * @param {string} params.name The name of the operation resource. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2058,9 +2112,11 @@ export namespace androiddeviceprovisioning_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The parent resource ID in the format `partners/[PARTNER_ID]` that identifies the reseller. + * @param {string} params.parent Required. The parent resource ID in the + * format `partners/[PARTNER_ID]` that identifies the reseller. * @param {().CreateCustomerRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2128,8 +2184,10 @@ export namespace androiddeviceprovisioning_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.partnerId Required. The ID of the reseller partner. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.partnerId Required. The ID of the reseller + * partner. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2241,9 +2299,11 @@ export namespace androiddeviceprovisioning_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.partnerId Required. The ID of the reseller partner. + * @param {string} params.partnerId Required. The ID of the reseller + * partner. * @param {().ClaimDeviceRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2312,9 +2372,11 @@ export namespace androiddeviceprovisioning_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.partnerId Required. The ID of the reseller partner. + * @param {string} params.partnerId Required. The ID of the reseller + * partner. * @param {().ClaimDevicesRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2381,9 +2443,12 @@ export namespace androiddeviceprovisioning_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.partnerId Required. The ID of the reseller partner. - * @param {().FindDevicesByDeviceIdentifierRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.partnerId Required. The ID of the reseller + * partner. + * @param {().FindDevicesByDeviceIdentifierRequest} params.resource Request + * body data + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2466,9 +2531,11 @@ export namespace androiddeviceprovisioning_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.partnerId Required. The ID of the reseller partner. + * @param {string} params.partnerId Required. The ID of the reseller + * partner. * @param {().FindDevicesByOwnerRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2542,8 +2609,10 @@ export namespace androiddeviceprovisioning_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The device API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.name Required. The device API resource name in the + * format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2605,9 +2674,11 @@ export namespace androiddeviceprovisioning_v1 { * * @param {object} params Parameters for request * @param {string} params.deviceId Required. The ID of the reseller partner. - * @param {string} params.metadataOwnerId Required. The owner of the newly set metadata. Set this to the partner ID. + * @param {string} params.metadataOwnerId Required. The owner of the newly + * set metadata. Set this to the partner ID. * @param {().UpdateDeviceMetadataRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2677,9 +2748,11 @@ export namespace androiddeviceprovisioning_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.partnerId Required. The ID of the reseller partner. + * @param {string} params.partnerId Required. The ID of the reseller + * partner. * @param {().UnclaimDeviceRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2749,7 +2822,8 @@ export namespace androiddeviceprovisioning_v1 { * @param {object} params Parameters for request * @param {string} params.partnerId Required. The reseller partner ID. * @param {().UnclaimDevicesRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2820,8 +2894,10 @@ export namespace androiddeviceprovisioning_v1 { * * @param {object} params Parameters for request * @param {string} params.partnerId Required. The reseller partner ID. - * @param {().UpdateDeviceMetadataInBatchRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {().UpdateDeviceMetadataInBatchRequest} params.resource Request + * body data + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3045,15 +3121,19 @@ export namespace androiddeviceprovisioning_v1 { /** * androiddeviceprovisioning.partners.vendors.list - * @desc Lists vendors of the partner. + * @desc Lists the vendors of the partner. * @alias androiddeviceprovisioning.partners.vendors.list * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize The maximum number of results to be returned. - * @param {string=} params.pageToken A token identifying a page of results returned by the server. - * @param {string} params.parent Required. The resource name in the format `partners/[PARTNER_ID]`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.pageSize The maximum number of results to be + * returned. + * @param {string=} params.pageToken A token identifying a page of results + * returned by the server. + * @param {string} params.parent Required. The resource name in the format + * `partners/[PARTNER_ID]`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3152,10 +3232,14 @@ export namespace androiddeviceprovisioning_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize The maximum number of results to be returned. - * @param {string=} params.pageToken A token identifying a page of results returned by the server. - * @param {string} params.parent Required. The resource name in the format `partners/[PARTNER_ID]/vendors/[VENDOR_ID]`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.pageSize The maximum number of results to be + * returned. + * @param {string=} params.pageToken A token identifying a page of results + * returned by the server. + * @param {string} params.parent Required. The resource name in the format + * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/androidenterprise/v1.ts b/src/apis/androidenterprise/v1.ts index 7c9bf536c3e..aedc3141b9b 100644 --- a/src/apis/androidenterprise/v1.ts +++ b/src/apis/androidenterprise/v1.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -1290,17 +1289,18 @@ export namespace androidenterprise_v1 { * The track available to the device is based on the following order of * preference: alpha, beta, production. For example, if an app has a prod * version, a beta version and an alpha version and the enterprise has been - * granted visibility to both the alpha and beta tracks, if tracks is - * {"beta", "production"} then the beta version of the - * app is made available to the device. If there are no app versions in the - * specified track adding the "alpha" and "beta" values - * to the list of tracks will have no effect. Note that the enterprise - * requires access to alpha and/or beta tracks before users can be granted - * visibility to apps in those tracks. The allowed sets are: {} (considered - * equivalent to {"production"}) {"production"} - * {"beta", "production"} {"alpha", - * "beta", "production"} The order of elements is not - * relevant. Any other set of tracks will be rejected with an error. + * granted visibility to both the alpha and beta tracks, if tracks + * is {"beta", "production"} then the beta version of + * the app is made available to the device. If there are no app versions in + * the specified track adding the "alpha" and "beta" + * values to the list of tracks will have no effect. Note that the + * enterprise requires access to alpha and/or beta tracks before users can + * be granted visibility to apps in those tracks. The allowed sets are: {} + * (considered equivalent + * to {"production"}) {"production"} {"beta", + * "production"} {"alpha", "beta", + * "production"} The order of elements is not relevant. Any other + * set of tracks will be rejected with an error. */ tracks?: string[]; } @@ -1426,18 +1426,18 @@ export namespace androidenterprise_v1 { * The track available to the user is based on the following order of * preference: alpha, beta, production. For example, if an app has a prod * version, a beta version and an alpha version and the enterprise has been - * granted visibility to both the alpha and beta tracks, if tracks is - * {"beta", "production"} the user will be able to + * granted visibility to both the alpha and beta tracks, if tracks + * is {"beta", "production"} the user will be able to * install the app and they will get the beta version of the app. If there * are no app versions in the specified track adding the "alpha" * and "beta" values to the list of tracks will have no effect. * Note that the enterprise requires access to alpha and/or beta tracks * before users can be granted visibility to apps in those tracks. The - * allowed sets are: {} (considered equivalent to {"production"}) - * {"production"} {"beta", "production"} - * {"alpha", "beta", "production"} The order - * of elements is not relevant. Any other set of tracks will be rejected - * with an error. + * allowed sets are: {} (considered equivalent + * to {"production"}) {"production"} {"beta", + * "production"} {"alpha", "beta", + * "production"} The order of elements is not relevant. Any other + * set of tracks will be rejected with an error. */ tracks?: string[]; } @@ -1782,7 +1782,8 @@ export namespace androidenterprise_v1 { * @param {string} params.deviceId The ID of the device. * @param {string} params.enterpriseId The ID of the enterprise. * @param {string} params.userId The ID of the user. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1851,7 +1852,8 @@ export namespace androidenterprise_v1 { * @param {string} params.deviceId The ID of the device. * @param {string} params.enterpriseId The ID of the enterprise. * @param {string} params.userId The ID of the user. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1920,7 +1922,8 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. * @param {string} params.userId The ID of the user. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1988,10 +1991,14 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.deviceId The ID of the device. * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string=} params.updateMask Mask that identifies which fields to update. If not set, all modifiable fields will be modified. When set in a query parameter, this field should be specified as updateMask=,,... + * @param {string=} params.updateMask Mask that identifies which fields to + * update. If not set, all modifiable fields will be modified. When set + * in a query parameter, this field should be specified as + * updateMask=,,... * @param {string} params.userId The ID of the user. * @param {().Device} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2064,7 +2071,8 @@ export namespace androidenterprise_v1 { * @param {string} params.enterpriseId The ID of the enterprise. * @param {string} params.userId The ID of the user. * @param {().DeviceState} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2133,10 +2141,14 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.deviceId The ID of the device. * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string=} params.updateMask Mask that identifies which fields to update. If not set, all modifiable fields will be modified. When set in a query parameter, this field should be specified as updateMask=,,... + * @param {string=} params.updateMask Mask that identifies which fields to + * update. If not set, all modifiable fields will be modified. When set + * in a query parameter, this field should be specified as + * updateMask=,,... * @param {string} params.userId The ID of the user. * @param {().Device} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2354,8 +2366,10 @@ export namespace androidenterprise_v1 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {string=} params.notificationSetId The notification set ID as returned by Enterprises.PullNotificationSet. This must be provided. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.notificationSetId The notification set ID as + * returned by Enterprises.PullNotificationSet. This must be provided. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2424,9 +2438,12 @@ export namespace androidenterprise_v1 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {string=} params.completionToken The Completion token initially returned by GenerateSignupUrl. - * @param {string=} params.enterpriseToken The Enterprise token appended to the Callback URL. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.completionToken The Completion token initially + * returned by GenerateSignupUrl. + * @param {string=} params.enterpriseToken The Enterprise token appended to + * the Callback URL. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2498,7 +2515,8 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. * @param {().AdministratorWebTokenSpec} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2561,75 +2579,6 @@ export namespace androidenterprise_v1 { } - /** - * androidenterprise.enterprises.delete - * @desc Deletes the binding between the EMM and enterprise. This is now - * deprecated. Use this method only to unenroll customers that were - * previously enrolled with the insert call, then enroll them again with the - * enroll call. - * @alias androidenterprise.enterprises.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.enterpriseId The ID of the enterprise. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Enterprises$Delete, - options?: MethodOptions): AxiosPromise; - delete( - params: Params$Resource$Enterprises$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( - params: Params$Resource$Enterprises$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: Params$Resource$Enterprises$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Enterprises$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Enterprises$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + '/androidenterprise/v1/enterprises/{enterpriseId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['enterpriseId'], - pathParams: ['enterpriseId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** * androidenterprise.enterprises.enroll * @desc Enrolls an enterprise with the calling EMM. @@ -2637,9 +2586,11 @@ export namespace androidenterprise_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.token The token provided by the enterprise to register the EMM. + * @param {string} params.token The token provided by the enterprise to + * register the EMM. * @param {().Enterprise} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2705,8 +2656,16 @@ export namespace androidenterprise_v1 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {string=} params.callbackUrl The callback URL to which the Admin will be redirected after successfully creating an enterprise. Before redirecting there the system will add a single query parameter to this URL named "enterpriseToken" which will contain an opaque token to be used for the CompleteSignup request. Beware that this means that the URL will be parsed, the parameter added and then a new URL formatted, i.e. there may be some minor formatting changes and, more importantly, the URL must be well-formed so that it can be parsed. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.callbackUrl The callback URL to which the Admin + * will be redirected after successfully creating an enterprise. Before + * redirecting there the system will add a single query parameter to + * this URL named "enterpriseToken" which will contain an opaque token + * to be used for the CompleteSignup request. Beware that this means + * that the URL will be parsed, the parameter added and then a new URL + * formatted, i.e. there may be some minor formatting changes and, more + * importantly, the URL must be well-formed so that it can be parsed. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2773,7 +2732,8 @@ export namespace androidenterprise_v1 { * * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2836,7 +2796,8 @@ export namespace androidenterprise_v1 { * * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2920,8 +2881,10 @@ export namespace androidenterprise_v1 { * * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string=} params.keyType The type of credential to return with the service account. Required. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.keyType The type of credential to return with the + * service account. Required. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2993,7 +2956,8 @@ export namespace androidenterprise_v1 { * * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3054,75 +3018,6 @@ export namespace androidenterprise_v1 { } - /** - * androidenterprise.enterprises.insert - * @desc Establishes the binding between the EMM and an enterprise. This is - * now deprecated; use enroll instead. - * @alias androidenterprise.enterprises.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.token The token provided by the enterprise to register the EMM. - * @param {().Enterprise} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - insert( - params?: Params$Resource$Enterprises$Insert, - options?: MethodOptions): AxiosPromise; - insert( - params: Params$Resource$Enterprises$Insert, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - insert( - params: Params$Resource$Enterprises$Insert, - callback: BodyResponseCallback): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: Params$Resource$Enterprises$Insert| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Enterprises$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Enterprises$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/androidenterprise/v1/enterprises') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['token'], - pathParams: [], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** * androidenterprise.enterprises.list * @desc Looks up an enterprise by domain name. This is only supported for @@ -3134,8 +3029,10 @@ export namespace androidenterprise_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.domain The exact primary domain name of the enterprise to look up. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.domain The exact primary domain name of the + * enterprise to look up. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3213,8 +3110,16 @@ export namespace androidenterprise_v1 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {string=} params.requestMode The request mode for pulling notifications. Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time. Speciying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present. If omitted, defaults to waitForNotifications. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.requestMode The request mode for pulling + * notifications. Specifying waitForNotifications will cause the request + * to block and wait until one or more notifications are present, or + * return an empty notification list if no notifications are present + * after some time. Speciying returnImmediately will cause the request + * to immediately return the pending notifications, or an empty list if + * no notifications are present. If omitted, defaults to + * waitForNotifications. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3284,7 +3189,8 @@ export namespace androidenterprise_v1 { * * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3365,7 +3271,8 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. * @param {().EnterpriseAccount} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3434,7 +3341,8 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. * @param {().AndroidDevicePolicyConfig} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3516,7 +3424,8 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. * @param {().StoreLayout} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3585,7 +3494,8 @@ export namespace androidenterprise_v1 { * * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3686,17 +3596,6 @@ export namespace androidenterprise_v1 { */ requestBody?: Schema$AdministratorWebTokenSpec; } - export interface Params$Resource$Enterprises$Delete { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the enterprise. - */ - enterpriseId?: string; - } export interface Params$Resource$Enterprises$Enroll { /** * Auth client or API Key for the request @@ -3778,22 +3677,6 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; } - export interface Params$Resource$Enterprises$Insert { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The token provided by the enterprise to register the EMM. - */ - token?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Enterprise; - } export interface Params$Resource$Enterprises$List { /** * Auth client or API Key for the request @@ -3914,9 +3797,11 @@ export namespace androidenterprise_v1 { * * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string} params.entitlementId The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm". + * @param {string} params.entitlementId The ID of the entitlement (a product + * ID), e.g. "app:com.google.android.gm". * @param {string} params.userId The ID of the user. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3983,9 +3868,11 @@ export namespace androidenterprise_v1 { * * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string} params.entitlementId The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm". + * @param {string} params.entitlementId The ID of the entitlement (a product + * ID), e.g. "app:com.google.android.gm". * @param {string} params.userId The ID of the user. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4050,7 +3937,8 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. * @param {string} params.userId The ID of the user. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4120,11 +4008,17 @@ export namespace androidenterprise_v1 { * * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string} params.entitlementId The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm". - * @param {boolean=} params.install Set to true to also install the product on all the user's devices where possible. Failure to install on one or more devices will not prevent this operation from returning successfully, as long as the entitlement was successfully assigned to the user. + * @param {string} params.entitlementId The ID of the entitlement (a product + * ID), e.g. "app:com.google.android.gm". + * @param {boolean=} params.install Set to true to also install the product + * on all the user's devices where possible. Failure to install on one + * or more devices will not prevent this operation from returning + * successfully, as long as the entitlement was successfully assigned to + * the user. * @param {string} params.userId The ID of the user. * @param {().Entitlement} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4192,11 +4086,17 @@ export namespace androidenterprise_v1 { * * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string} params.entitlementId The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm". - * @param {boolean=} params.install Set to true to also install the product on all the user's devices where possible. Failure to install on one or more devices will not prevent this operation from returning successfully, as long as the entitlement was successfully assigned to the user. + * @param {string} params.entitlementId The ID of the entitlement (a product + * ID), e.g. "app:com.google.android.gm". + * @param {boolean=} params.install Set to true to also install the product + * on all the user's devices where possible. Failure to install on one + * or more devices will not prevent this operation from returning + * successfully, as long as the entitlement was successfully assigned to + * the user. * @param {string} params.userId The ID of the user. * @param {().Entitlement} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4398,8 +4298,10 @@ export namespace androidenterprise_v1 { * * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string} params.groupLicenseId The ID of the product the group license is for, e.g. "app:com.google.android.gm". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.groupLicenseId The ID of the product the group + * license is for, e.g. "app:com.google.android.gm". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4465,7 +4367,8 @@ export namespace androidenterprise_v1 { * * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4578,8 +4481,10 @@ export namespace androidenterprise_v1 { * * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string} params.groupLicenseId The ID of the product the group license is for, e.g. "app:com.google.android.gm". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.groupLicenseId The ID of the product the group + * license is for, e.g. "app:com.google.android.gm". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4688,9 +4593,11 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.deviceId The Android ID of the device. * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string} params.installId The ID of the product represented by the install, e.g. "app:com.google.android.gm". + * @param {string} params.installId The ID of the product represented by the + * install, e.g. "app:com.google.android.gm". * @param {string} params.userId The ID of the user. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4756,9 +4663,11 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.deviceId The Android ID of the device. * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string} params.installId The ID of the product represented by the install, e.g. "app:com.google.android.gm". + * @param {string} params.installId The ID of the product represented by the + * install, e.g. "app:com.google.android.gm". * @param {string} params.userId The ID of the user. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4824,7 +4733,8 @@ export namespace androidenterprise_v1 { * @param {string} params.deviceId The Android ID of the device. * @param {string} params.enterpriseId The ID of the enterprise. * @param {string} params.userId The ID of the user. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4895,10 +4805,12 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.deviceId The Android ID of the device. * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string} params.installId The ID of the product represented by the install, e.g. "app:com.google.android.gm". + * @param {string} params.installId The ID of the product represented by the + * install, e.g. "app:com.google.android.gm". * @param {string} params.userId The ID of the user. * @param {().Install} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4967,10 +4879,12 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.deviceId The Android ID of the device. * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string} params.installId The ID of the product represented by the install, e.g. "app:com.google.android.gm". + * @param {string} params.installId The ID of the product represented by the + * install, e.g. "app:com.google.android.gm". * @param {string} params.userId The ID of the user. * @param {().Install} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5177,9 +5091,12 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.deviceId The Android ID of the device. * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string} params.managedConfigurationForDeviceId The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". + * @param {string} params.managedConfigurationForDeviceId The ID of the + * managed configuration (a product ID), e.g. + * "app:com.google.android.gm". * @param {string} params.userId The ID of the user. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5254,9 +5171,12 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.deviceId The Android ID of the device. * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string} params.managedConfigurationForDeviceId The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". + * @param {string} params.managedConfigurationForDeviceId The ID of the + * managed configuration (a product ID), e.g. + * "app:com.google.android.gm". * @param {string} params.userId The ID of the user. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5331,7 +5251,8 @@ export namespace androidenterprise_v1 { * @param {string} params.deviceId The Android ID of the device. * @param {string} params.enterpriseId The ID of the enterprise. * @param {string} params.userId The ID of the user. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5410,10 +5331,13 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.deviceId The Android ID of the device. * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string} params.managedConfigurationForDeviceId The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". + * @param {string} params.managedConfigurationForDeviceId The ID of the + * managed configuration (a product ID), e.g. + * "app:com.google.android.gm". * @param {string} params.userId The ID of the user. * @param {().ManagedConfiguration} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5491,10 +5415,13 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.deviceId The Android ID of the device. * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string} params.managedConfigurationForDeviceId The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". + * @param {string} params.managedConfigurationForDeviceId The ID of the + * managed configuration (a product ID), e.g. + * "app:com.google.android.gm". * @param {string} params.userId The ID of the user. * @param {().ManagedConfiguration} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5711,9 +5638,12 @@ export namespace androidenterprise_v1 { * * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string} params.managedConfigurationForUserId The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". + * @param {string} params.managedConfigurationForUserId The ID of the + * managed configuration (a product ID), e.g. + * "app:com.google.android.gm". * @param {string} params.userId The ID of the user. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5782,9 +5712,12 @@ export namespace androidenterprise_v1 { * * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string} params.managedConfigurationForUserId The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". + * @param {string} params.managedConfigurationForUserId The ID of the + * managed configuration (a product ID), e.g. + * "app:com.google.android.gm". * @param {string} params.userId The ID of the user. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5853,7 +5786,8 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. * @param {string} params.userId The ID of the user. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5935,10 +5869,13 @@ export namespace androidenterprise_v1 { * * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string} params.managedConfigurationForUserId The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". + * @param {string} params.managedConfigurationForUserId The ID of the + * managed configuration (a product ID), e.g. + * "app:com.google.android.gm". * @param {string} params.userId The ID of the user. * @param {().ManagedConfiguration} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6014,10 +5951,13 @@ export namespace androidenterprise_v1 { * * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string} params.managedConfigurationForUserId The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". + * @param {string} params.managedConfigurationForUserId The ID of the + * managed configuration (a product ID), e.g. + * "app:com.google.android.gm". * @param {string} params.userId The ID of the user. * @param {().ManagedConfiguration} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6208,8 +6148,10 @@ export namespace androidenterprise_v1 { * * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string} params.productId The ID of the product for which the managed configurations settings applies to. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.productId The ID of the product for which the + * managed configurations settings applies to. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6316,9 +6258,11 @@ export namespace androidenterprise_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.language The BCP47 tag for the user's preferred language (e.g. "en-US", "de") + * @param {string=} params.language The BCP47 tag for the user's preferred + * language (e.g. "en-US", "de") * @param {string} params.permissionId The ID of the permission. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6416,7 +6360,8 @@ export namespace androidenterprise_v1 { * @param {string} params.enterpriseId The ID of the enterprise. * @param {string} params.productId The ID of the product. * @param {().ProductsApproveRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6488,9 +6433,12 @@ export namespace androidenterprise_v1 { * * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string=} params.languageCode The BCP 47 language code used for permission names and descriptions in the returned iframe, for instance "en-US". + * @param {string=} params.languageCode The BCP 47 language code used for + * permission names and descriptions in the returned iframe, for + * instance "en-US". * @param {string} params.productId The ID of the product. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6571,9 +6519,12 @@ export namespace androidenterprise_v1 { * * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string=} params.language The BCP47 tag for the user's preferred language (e.g. "en-US", "de"). - * @param {string} params.productId The ID of the product, e.g. "app:com.google.android.gm". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.language The BCP47 tag for the user's preferred + * language (e.g. "en-US", "de"). + * @param {string} params.productId The ID of the product, e.g. + * "app:com.google.android.gm". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6641,9 +6592,11 @@ export namespace androidenterprise_v1 { * * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string=} params.language The BCP47 tag for the user's preferred language (e.g. "en-US", "de"). + * @param {string=} params.language The BCP47 tag for the user's preferred + * language (e.g. "en-US", "de"). * @param {string} params.productId The ID of the product. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6715,7 +6668,8 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. * @param {string} params.productId The ID of the product. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6785,13 +6739,27 @@ export namespace androidenterprise_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.approved Specifies whether to search among all products (false) or among only products that have been approved (true). Only "true" is supported, and should be specified. + * @param {boolean=} params.approved Specifies whether to search among all + * products (false) or among only products that have been approved + * (true). Only "true" is supported, and should be specified. * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string=} params.language The BCP47 tag for the user's preferred language (e.g. "en-US", "de"). Results are returned in the language best matching the preferred language. - * @param {integer=} params.maxResults Specifies the maximum number of products that can be returned per request. If not specified, uses a default value of 100, which is also the maximum retrievable within a single response. - * @param {string=} params.query The search query as typed in the Google Play store search box. If omitted, all approved apps will be returned (using the pagination parameters), including apps that are not available in the store (e.g. unpublished apps). - * @param {string=} params.token A pagination token is contained in a request''s response when there are more products. The token can be used in a subsequent request to obtain more products, and so forth. This parameter cannot be used in the initial request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.language The BCP47 tag for the user's preferred + * language (e.g. "en-US", "de"). Results are returned in the language + * best matching the preferred language. + * @param {integer=} params.maxResults Specifies the maximum number of + * products that can be returned per request. If not specified, uses a + * default value of 100, which is also the maximum retrievable within a + * single response. + * @param {string=} params.query The search query as typed in the Google + * Play store search box. If omitted, all approved apps will be returned + * (using the pagination parameters), including apps that are not + * available in the store (e.g. unpublished apps). + * @param {string=} params.token A pagination token is contained in a + * request''s response when there are more products. The token can be + * used in a subsequent request to obtain more products, and so forth. + * This parameter cannot be used in the initial request. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6860,7 +6828,8 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. * @param {string} params.productId The ID of the product. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -7097,7 +7066,8 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. * @param {string} params.keyId The ID of the key. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -7169,7 +7139,8 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. * @param {().ServiceAccountKey} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -7242,7 +7213,8 @@ export namespace androidenterprise_v1 { * * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -7376,7 +7348,8 @@ export namespace androidenterprise_v1 { * @param {string} params.clusterId The ID of the cluster. * @param {string} params.enterpriseId The ID of the enterprise. * @param {string} params.pageId The ID of the page. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -7445,7 +7418,8 @@ export namespace androidenterprise_v1 { * @param {string} params.clusterId The ID of the cluster. * @param {string} params.enterpriseId The ID of the enterprise. * @param {string} params.pageId The ID of the page. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -7512,7 +7486,8 @@ export namespace androidenterprise_v1 { * @param {string} params.enterpriseId The ID of the enterprise. * @param {string} params.pageId The ID of the page. * @param {().StoreCluster} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -7582,7 +7557,8 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. * @param {string} params.pageId The ID of the page. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -7663,7 +7639,8 @@ export namespace androidenterprise_v1 { * @param {string} params.enterpriseId The ID of the enterprise. * @param {string} params.pageId The ID of the page. * @param {().StoreCluster} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -7735,7 +7712,8 @@ export namespace androidenterprise_v1 { * @param {string} params.enterpriseId The ID of the enterprise. * @param {string} params.pageId The ID of the page. * @param {().StoreCluster} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -7940,7 +7918,8 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. * @param {string} params.pageId The ID of the page. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8008,7 +7987,8 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. * @param {string} params.pageId The ID of the page. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8074,7 +8054,8 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. * @param {().StorePage} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8143,7 +8124,8 @@ export namespace androidenterprise_v1 { * * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8222,7 +8204,8 @@ export namespace androidenterprise_v1 { * @param {string} params.enterpriseId The ID of the enterprise. * @param {string} params.pageId The ID of the page. * @param {().StorePage} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8293,7 +8276,8 @@ export namespace androidenterprise_v1 { * @param {string} params.enterpriseId The ID of the enterprise. * @param {string} params.pageId The ID of the page. * @param {().StorePage} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8474,7 +8458,8 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. * @param {string} params.userId The ID of the user. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8543,7 +8528,8 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. * @param {string} params.userId The ID of the user. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8616,7 +8602,8 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. * @param {string} params.userId The ID of the user. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8686,7 +8673,8 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. * @param {string} params.userId The ID of the user. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8750,7 +8738,8 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. * @param {string} params.userId The ID of the user. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8825,7 +8814,8 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. * @param {().User} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8892,9 +8882,11 @@ export namespace androidenterprise_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.email The exact primary email address of the user to look up. + * @param {string} params.email The exact primary email address of the user + * to look up. * @param {string} params.enterpriseId The ID of the enterprise. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -8966,7 +8958,8 @@ export namespace androidenterprise_v1 { * @param {string} params.enterpriseId The ID of the enterprise. * @param {string} params.userId The ID of the user. * @param {().User} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -9035,7 +9028,8 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. * @param {string} params.userId The ID of the user. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -9104,7 +9098,8 @@ export namespace androidenterprise_v1 { * @param {object} params Parameters for request * @param {string} params.enterpriseId The ID of the enterprise. * @param {string} params.userId The ID of the user. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -9176,7 +9171,8 @@ export namespace androidenterprise_v1 { * @param {string} params.enterpriseId The ID of the enterprise. * @param {string} params.userId The ID of the user. * @param {().ProductSet} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -9252,7 +9248,8 @@ export namespace androidenterprise_v1 { * @param {string} params.enterpriseId The ID of the enterprise. * @param {string} params.userId The ID of the user. * @param {().User} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/androidmanagement/v1.ts b/src/apis/androidmanagement/v1.ts index 1ef755a8b81..38f9f45b088 100644 --- a/src/apis/androidmanagement/v1.ts +++ b/src/apis/androidmanagement/v1.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -1149,7 +1148,7 @@ export namespace androidmanagement_v1 { */ export interface Schema$PermissionGrant { /** - * The android permission or group, e.g. android.permission.READ_CALENDAR or + * The Android permission or group, e.g. android.permission.READ_CALENDAR or * android.permission_group.CALENDAR. */ permission?: string; @@ -1847,11 +1846,15 @@ export namespace androidmanagement_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.enterpriseToken The enterprise token appended to the callback URL. - * @param {string=} params.projectId The ID of the Google Cloud Platform project which will own the enterprise. - * @param {string=} params.signupUrlName The name of the SignupUrl used to sign up for the enterprise. + * @param {string=} params.enterpriseToken The enterprise token appended to + * the callback URL. + * @param {string=} params.projectId The ID of the Google Cloud Platform + * project which will own the enterprise. + * @param {string=} params.signupUrlName The name of the SignupUrl used to + * sign up for the enterprise. * @param {().Enterprise} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1917,8 +1920,10 @@ export namespace androidmanagement_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the enterprise in the form enterprises/{enterpriseId}. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.name The name of the enterprise in the form + * enterprises/{enterpriseId}. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1979,10 +1984,13 @@ export namespace androidmanagement_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the enterprise in the form enterprises/{enterpriseId}. - * @param {string=} params.updateMask The field mask indicating the fields to update. If not set, all modifiable fields will be modified. + * @param {string} params.name The name of the enterprise in the form + * enterprises/{enterpriseId}. + * @param {string=} params.updateMask The field mask indicating the fields + * to update. If not set, all modifiable fields will be modified. * @param {().Enterprise} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2117,9 +2125,13 @@ export namespace androidmanagement_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.languageCode The preferred language for localized application info, as a BCP47 tag (e.g. "en-US", "de"). If not specified the default language of the application will be used. - * @param {string} params.name The name of the application in the form enterprises/{enterpriseId}/applications/{package_name}. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.languageCode The preferred language for localized + * application info, as a BCP47 tag (e.g. "en-US", "de"). If not + * specified the default language of the application will be used. + * @param {string} params.name The name of the application in the form + * enterprises/{enterpriseId}/applications/{package_name}. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2215,9 +2227,12 @@ export namespace androidmanagement_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. - * @param {string=} params.wipeDataFlags Optional flags that control the device wiping behavior. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.name The name of the device in the form + * enterprises/{enterpriseId}/devices/{deviceId}. + * @param {string=} params.wipeDataFlags Optional flags that control the + * device wiping behavior. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2282,8 +2297,10 @@ export namespace androidmanagement_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.name The name of the device in the form + * enterprises/{enterpriseId}/devices/{deviceId}. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2346,9 +2363,11 @@ export namespace androidmanagement_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. + * @param {string} params.name The name of the device in the form + * enterprises/{enterpriseId}/devices/{deviceId}. * @param {().Command} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2415,10 +2434,14 @@ export namespace androidmanagement_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize The requested page size. The actual page size may be fixed to a min or max value. - * @param {string=} params.pageToken A token identifying a page of results returned by the server. - * @param {string} params.parent The name of the enterprise in the form enterprises/{enterpriseId}. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.pageSize The requested page size. The actual + * page size may be fixed to a min or max value. + * @param {string=} params.pageToken A token identifying a page of results + * returned by the server. + * @param {string} params.parent The name of the enterprise in the form + * enterprises/{enterpriseId}. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2485,10 +2508,13 @@ export namespace androidmanagement_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. - * @param {string=} params.updateMask The field mask indicating the fields to update. If not set, all modifiable fields will be modified. + * @param {string} params.name The name of the device in the form + * enterprises/{enterpriseId}/devices/{deviceId}. + * @param {string=} params.updateMask The field mask indicating the fields + * to update. If not set, all modifiable fields will be modified. * @param {().Device} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2661,8 +2687,10 @@ export namespace androidmanagement_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the operation resource to be cancelled. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.name The name of the operation resource to be + * cancelled. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2732,8 +2760,10 @@ export namespace androidmanagement_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the operation resource to be deleted. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.name The name of the operation resource to be + * deleted. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2802,7 +2832,8 @@ export namespace androidmanagement_v1 { * * @param {object} params Parameters for request * @param {string} params.name The name of the operation resource. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2876,7 +2907,8 @@ export namespace androidmanagement_v1 { * @param {string} params.name The name of the operation's parent resource. * @param {integer=} params.pageSize The standard list page size. * @param {string=} params.pageToken The standard list page token. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3014,9 +3046,11 @@ export namespace androidmanagement_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The name of the enterprise in the form enterprises/{enterpriseId}. + * @param {string} params.parent The name of the enterprise in the form + * enterprises/{enterpriseId}. * @param {().EnrollmentToken} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3084,8 +3118,10 @@ export namespace androidmanagement_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the enrollment token in the form enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.name The name of the enrollment token in the form + * enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3193,8 +3229,10 @@ export namespace androidmanagement_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.name The name of the policy in the form + * enterprises/{enterpriseId}/policies/{policyId}. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3259,8 +3297,10 @@ export namespace androidmanagement_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.name The name of the policy in the form + * enterprises/{enterpriseId}/policies/{policyId}. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3321,10 +3361,14 @@ export namespace androidmanagement_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize The requested page size. The actual page size may be fixed to a min or max value. - * @param {string=} params.pageToken A token identifying a page of results returned by the server. - * @param {string} params.parent The name of the enterprise in the form enterprises/{enterpriseId}. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.pageSize The requested page size. The actual + * page size may be fixed to a min or max value. + * @param {string=} params.pageToken A token identifying a page of results + * returned by the server. + * @param {string} params.parent The name of the enterprise in the form + * enterprises/{enterpriseId}. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3392,10 +3436,13 @@ export namespace androidmanagement_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}. - * @param {string=} params.updateMask The field mask indicating the fields to update. If not set, all modifiable fields will be modified. + * @param {string} params.name The name of the policy in the form + * enterprises/{enterpriseId}/policies/{policyId}. + * @param {string=} params.updateMask The field mask indicating the fields + * to update. If not set, all modifiable fields will be modified. * @param {().Policy} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3541,9 +3588,11 @@ export namespace androidmanagement_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The name of the enterprise in the form enterprises/{enterpriseId}. + * @param {string} params.parent The name of the enterprise in the form + * enterprises/{enterpriseId}. * @param {().WebToken} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3640,9 +3689,17 @@ export namespace androidmanagement_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.callbackUrl The callback URL that the admin will be redirected to after successfully creating an enterprise. Before redirecting there the system will add a query parameter to this URL named enterpriseToken which will contain an opaque token to be used for the create enterprise request. The URL will be parsed then reformatted in order to add the enterpriseToken parameter, so there may be some minor formatting changes. - * @param {string=} params.projectId The ID of the Google Cloud Platform project which will own the enterprise. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.callbackUrl The callback URL that the admin will + * be redirected to after successfully creating an enterprise. Before + * redirecting there the system will add a query parameter to this URL + * named enterpriseToken which will contain an opaque token to be used + * for the create enterprise request. The URL will be parsed then + * reformatted in order to add the enterpriseToken parameter, so there + * may be some minor formatting changes. + * @param {string=} params.projectId The ID of the Google Cloud Platform + * project which will own the enterprise. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/androidpublisher/v1.1.ts b/src/apis/androidpublisher/v1.1.ts index 513bc24f583..693be73e777 100644 --- a/src/apis/androidpublisher/v1.1.ts +++ b/src/apis/androidpublisher/v1.1.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -156,10 +155,14 @@ export namespace androidpublisher_v1_1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.packageName The package name of the application the inapp product was sold in (for example, 'com.some.thing'). - * @param {string} params.productId The inapp product SKU (for example, 'com.some.thing.inapp1'). - * @param {string} params.token The token provided to the user's device when the inapp product was purchased. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName The package name of the application + * the inapp product was sold in (for example, 'com.some.thing'). + * @param {string} params.productId The inapp product SKU (for example, + * 'com.some.thing.inapp1'). + * @param {string} params.token The token provided to the user's device when + * the inapp product was purchased. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -259,10 +262,15 @@ export namespace androidpublisher_v1_1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.packageName The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). - * @param {string} params.subscriptionId The purchased subscription ID (for example, 'monthly001'). - * @param {string} params.token The token provided to the user's device when the subscription was purchased. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName The package name of the application + * for which this subscription was purchased (for example, + * 'com.some.thing'). + * @param {string} params.subscriptionId The purchased subscription ID (for + * example, 'monthly001'). + * @param {string} params.token The token provided to the user's device when + * the subscription was purchased. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -327,10 +335,15 @@ export namespace androidpublisher_v1_1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.packageName The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). - * @param {string} params.subscriptionId The purchased subscription ID (for example, 'monthly001'). - * @param {string} params.token The token provided to the user's device when the subscription was purchased. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName The package name of the application + * for which this subscription was purchased (for example, + * 'com.some.thing'). + * @param {string} params.subscriptionId The purchased subscription ID (for + * example, 'monthly001'). + * @param {string} params.token The token provided to the user's device when + * the subscription was purchased. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/androidpublisher/v1.ts b/src/apis/androidpublisher/v1.ts index a48accb25eb..c51a2c4f30b 100644 --- a/src/apis/androidpublisher/v1.ts +++ b/src/apis/androidpublisher/v1.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -113,10 +112,15 @@ export namespace androidpublisher_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.packageName The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). - * @param {string} params.subscriptionId The purchased subscription ID (for example, 'monthly001'). - * @param {string} params.token The token provided to the user's device when the subscription was purchased. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName The package name of the application + * for which this subscription was purchased (for example, + * 'com.some.thing'). + * @param {string} params.subscriptionId The purchased subscription ID (for + * example, 'monthly001'). + * @param {string} params.token The token provided to the user's device when + * the subscription was purchased. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -181,10 +185,15 @@ export namespace androidpublisher_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.packageName The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). - * @param {string} params.subscriptionId The purchased subscription ID (for example, 'monthly001'). - * @param {string} params.token The token provided to the user's device when the subscription was purchased. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName The package name of the application + * for which this subscription was purchased (for example, + * 'com.some.thing'). + * @param {string} params.subscriptionId The purchased subscription ID (for + * example, 'monthly001'). + * @param {string} params.token The token provided to the user's device when + * the subscription was purchased. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/androidpublisher/v2.ts b/src/apis/androidpublisher/v2.ts index 2bdaf5839ef..63c6c5021eb 100644 --- a/src/apis/androidpublisher/v2.ts +++ b/src/apis/androidpublisher/v2.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -1002,8 +1001,10 @@ export namespace androidpublisher_v2 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1071,8 +1072,10 @@ export namespace androidpublisher_v2 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1139,8 +1142,10 @@ export namespace androidpublisher_v2 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1203,9 +1208,11 @@ export namespace androidpublisher_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". * @param {().AppEdit} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1271,8 +1278,10 @@ export namespace androidpublisher_v2 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1432,11 +1441,16 @@ export namespace androidpublisher_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer} params.apkVersionCode The APK version code whose APK-specific listings should be read or modified. + * @param {integer} params.apkVersionCode The APK version code whose + * APK-specific listings should be read or modified. * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.language The language code (a BCP-47 language tag) of the APK-specific localized listing to read or modify. For example, to select Austrian German, pass "de-AT". - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.language The language code (a BCP-47 language tag) + * of the APK-specific localized listing to read or modify. For example, + * to select Austrian German, pass "de-AT". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1503,10 +1517,13 @@ export namespace androidpublisher_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer} params.apkVersionCode The APK version code whose APK-specific listings should be read or modified. + * @param {integer} params.apkVersionCode The APK version code whose + * APK-specific listings should be read or modified. * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1573,11 +1590,16 @@ export namespace androidpublisher_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer} params.apkVersionCode The APK version code whose APK-specific listings should be read or modified. + * @param {integer} params.apkVersionCode The APK version code whose + * APK-specific listings should be read or modified. * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.language The language code (a BCP-47 language tag) of the APK-specific localized listing to read or modify. For example, to select Austrian German, pass "de-AT". - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.language The language code (a BCP-47 language tag) + * of the APK-specific localized listing to read or modify. For example, + * to select Austrian German, pass "de-AT". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1641,10 +1663,13 @@ export namespace androidpublisher_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer} params.apkVersionCode The APK version code whose APK-specific listings should be read or modified. + * @param {integer} params.apkVersionCode The APK version code whose + * APK-specific listings should be read or modified. * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1714,12 +1739,17 @@ export namespace androidpublisher_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer} params.apkVersionCode The APK version code whose APK-specific listings should be read or modified. + * @param {integer} params.apkVersionCode The APK version code whose + * APK-specific listings should be read or modified. * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.language The language code (a BCP-47 language tag) of the APK-specific localized listing to read or modify. For example, to select Austrian German, pass "de-AT". - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.language The language code (a BCP-47 language tag) + * of the APK-specific localized listing to read or modify. For example, + * to select Austrian German, pass "de-AT". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". * @param {().ApkListing} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1788,12 +1818,17 @@ export namespace androidpublisher_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer} params.apkVersionCode The APK version code whose APK-specific listings should be read or modified. + * @param {integer} params.apkVersionCode The APK version code whose + * APK-specific listings should be read or modified. * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.language The language code (a BCP-47 language tag) of the APK-specific localized listing to read or modify. For example, to select Austrian German, pass "de-AT". - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.language The language code (a BCP-47 language tag) + * of the APK-specific localized listing to read or modify. For example, + * to select Austrian German, pass "de-AT". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". * @param {().ApkListing} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2039,9 +2074,12 @@ export namespace androidpublisher_v2 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {().ApksAddExternallyHostedRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {().ApksAddExternallyHostedRequest} params.resource Request body + * data + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2118,8 +2156,10 @@ export namespace androidpublisher_v2 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2185,11 +2225,13 @@ export namespace androidpublisher_v2 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type * @param {string|object} params.media.body Media body contents - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2342,8 +2384,10 @@ export namespace androidpublisher_v2 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2416,11 +2460,13 @@ export namespace androidpublisher_v2 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type * @param {string|object} params.media.body Media body contents - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2554,14 +2600,18 @@ export namespace androidpublisher_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer} params.apkVersionCode The version code of the APK whose deobfuscation file is being uploaded. + * @param {integer} params.apkVersionCode The version code of the APK whose + * deobfuscation file is being uploaded. * @param {string} params.deobfuscationFileType * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier of the Android app for which the deobfuscatiuon files are being uploaded; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier of the Android app + * for which the deobfuscatiuon files are being uploaded; for example, + * "com.spiffygame". * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type * @param {string|object} params.media.body Media body contents - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2704,8 +2754,10 @@ export namespace androidpublisher_v2 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2771,9 +2823,11 @@ export namespace androidpublisher_v2 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". * @param {().AppDetails} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2842,9 +2896,11 @@ export namespace androidpublisher_v2 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". * @param {().AppDetails} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2984,11 +3040,14 @@ export namespace androidpublisher_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer} params.apkVersionCode The version code of the APK whose Expansion File configuration is being read or modified. + * @param {integer} params.apkVersionCode The version code of the APK whose + * Expansion File configuration is being read or modified. * @param {string} params.editId Unique identifier for this edit. * @param {string} params.expansionFileType - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3056,12 +3115,15 @@ export namespace androidpublisher_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer} params.apkVersionCode The version code of the APK whose Expansion File configuration is being read or modified. + * @param {integer} params.apkVersionCode The version code of the APK whose + * Expansion File configuration is being read or modified. * @param {string} params.editId Unique identifier for this edit. * @param {string} params.expansionFileType - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". * @param {().ExpansionFile} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3132,12 +3194,15 @@ export namespace androidpublisher_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer} params.apkVersionCode The version code of the APK whose Expansion File configuration is being read or modified. + * @param {integer} params.apkVersionCode The version code of the APK whose + * Expansion File configuration is being read or modified. * @param {string} params.editId Unique identifier for this edit. * @param {string} params.expansionFileType - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". * @param {().ExpansionFile} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3207,14 +3272,17 @@ export namespace androidpublisher_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer} params.apkVersionCode The version code of the APK whose Expansion File configuration is being read or modified. + * @param {integer} params.apkVersionCode The version code of the APK whose + * Expansion File configuration is being read or modified. * @param {string} params.editId Unique identifier for this edit. * @param {string} params.expansionFileType - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type * @param {string|object} params.media.body Media body contents - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3436,11 +3504,16 @@ export namespace androidpublisher_v2 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.imageId Unique identifier an image within the set of images attached to this edit. + * @param {string} params.imageId Unique identifier an image within the set + * of images attached to this edit. * @param {string} params.imageType - * @param {string} params.language The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.language The language code (a BCP-47 language tag) + * of the localized listing whose images are to read or modified. For + * example, to select Austrian German, pass "de-AT". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3510,9 +3583,13 @@ export namespace androidpublisher_v2 { * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. * @param {string} params.imageType - * @param {string} params.language The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.language The language code (a BCP-47 language tag) + * of the localized listing whose images are to read or modified. For + * example, to select Austrian German, pass "de-AT". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3584,9 +3661,13 @@ export namespace androidpublisher_v2 { * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. * @param {string} params.imageType - * @param {string} params.language The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.language The language code (a BCP-47 language tag) + * of the localized listing whose images are to read or modified. For + * example, to select Austrian German, pass "de-AT". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3656,12 +3737,16 @@ export namespace androidpublisher_v2 { * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. * @param {string} params.imageType - * @param {string} params.language The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.language The language code (a BCP-47 language tag) + * of the localized listing whose images are to read or modified. For + * example, to select Austrian German, pass "de-AT". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type * @param {string|object} params.media.body Media body contents - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3874,9 +3959,13 @@ export namespace androidpublisher_v2 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.language The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT". - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.language The language code (a BCP-47 language tag) + * of the localized listing to read or modify. For example, to select + * Austrian German, pass "de-AT". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3943,8 +4032,10 @@ export namespace androidpublisher_v2 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4011,9 +4102,13 @@ export namespace androidpublisher_v2 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.language The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT". - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.language The language code (a BCP-47 language tag) + * of the localized listing to read or modify. For example, to select + * Austrian German, pass "de-AT". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4077,8 +4172,10 @@ export namespace androidpublisher_v2 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4148,10 +4245,14 @@ export namespace androidpublisher_v2 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.language The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT". - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.language The language code (a BCP-47 language tag) + * of the localized listing to read or modify. For example, to select + * Austrian German, pass "de-AT". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". * @param {().Listing} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4219,10 +4320,14 @@ export namespace androidpublisher_v2 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.language The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT". - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.language The language code (a BCP-47 language tag) + * of the localized listing to read or modify. For example, to select + * Austrian German, pass "de-AT". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". * @param {().Listing} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4429,9 +4534,12 @@ export namespace androidpublisher_v2 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {string} params.track The track to read or modify. Acceptable values are: "alpha", "beta", "production", "rollout" or "internal". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {string} params.track The track to read or modify. Acceptable + * values are: "alpha", "beta", "production", "rollout" or "internal". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4494,10 +4602,13 @@ export namespace androidpublisher_v2 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {string} params.track The track to read or modify. Acceptable values are: "alpha", "beta", "production", "rollout" or "internal". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {string} params.track The track to read or modify. Acceptable + * values are: "alpha", "beta", "production", "rollout" or "internal". * @param {().Testers} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4564,10 +4675,13 @@ export namespace androidpublisher_v2 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {string} params.track The track to read or modify. Acceptable values are: "alpha", "beta", "production", "rollout" or "internal". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {string} params.track The track to read or modify. Acceptable + * values are: "alpha", "beta", "production", "rollout" or "internal". * @param {().Testers} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4723,9 +4837,11 @@ export namespace androidpublisher_v2 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". * @param {string} params.track The track to read or modify. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4788,8 +4904,10 @@ export namespace androidpublisher_v2 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4860,10 +4978,12 @@ export namespace androidpublisher_v2 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". * @param {string} params.track The track to read or modify. * @param {().Track} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4932,10 +5052,12 @@ export namespace androidpublisher_v2 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". * @param {string} params.track The track to read or modify. * @param {().Track} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5103,9 +5225,11 @@ export namespace androidpublisher_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.packageName Unique identifier for the Android app with the in-app product; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app + * with the in-app product; for example, "com.spiffygame". * @param {string} params.sku Unique identifier for the in-app product. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5173,7 +5297,8 @@ export namespace androidpublisher_v2 { * @param {object} params Parameters for request * @param {string} params.packageName * @param {string} params.sku Unique identifier for the in-app product. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5237,10 +5362,15 @@ export namespace androidpublisher_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.autoConvertMissingPrices If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false. - * @param {string} params.packageName Unique identifier for the Android app; for example, "com.spiffygame". + * @param {boolean=} params.autoConvertMissingPrices If true the prices for + * all regions targeted by the parent app that don't have a price + * specified for this in-app product will be auto converted to the + * target currency based on the default price. Defaults to false. + * @param {string} params.packageName Unique identifier for the Android app; + * for example, "com.spiffygame". * @param {().InAppProduct} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5310,10 +5440,12 @@ export namespace androidpublisher_v2 { * * @param {object} params Parameters for request * @param {integer=} params.maxResults - * @param {string} params.packageName Unique identifier for the Android app with in-app products; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app + * with in-app products; for example, "com.spiffygame". * @param {integer=} params.startIndex * @param {string=} params.token - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5384,11 +5516,16 @@ export namespace androidpublisher_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.autoConvertMissingPrices If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false. - * @param {string} params.packageName Unique identifier for the Android app with the in-app product; for example, "com.spiffygame". + * @param {boolean=} params.autoConvertMissingPrices If true the prices for + * all regions targeted by the parent app that don't have a price + * specified for this in-app product will be auto converted to the + * target currency based on the default price. Defaults to false. + * @param {string} params.packageName Unique identifier for the Android app + * with the in-app product; for example, "com.spiffygame". * @param {string} params.sku Unique identifier for the in-app product. * @param {().InAppProduct} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5456,11 +5593,16 @@ export namespace androidpublisher_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.autoConvertMissingPrices If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false. - * @param {string} params.packageName Unique identifier for the Android app with the in-app product; for example, "com.spiffygame". + * @param {boolean=} params.autoConvertMissingPrices If true the prices for + * all regions targeted by the parent app that don't have a price + * specified for this in-app product will be auto converted to the + * target currency based on the default price. Defaults to false. + * @param {string} params.packageName Unique identifier for the Android app + * with the in-app product; for example, "com.spiffygame". * @param {string} params.sku Unique identifier for the in-app product. * @param {().InAppProduct} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5673,10 +5815,18 @@ export namespace androidpublisher_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.orderId The order ID provided to the user when the subscription or in-app order was purchased. - * @param {string} params.packageName The package name of the application for which this subscription or in-app item was purchased (for example, 'com.some.thing'). - * @param {boolean=} params.revoke Whether to revoke the purchased item. If set to true, access to the subscription or in-app item will be terminated immediately. If the item is a recurring subscription, all future payments will also be terminated. Consumed in-app items need to be handled by developer's app. (optional) - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.orderId The order ID provided to the user when the + * subscription or in-app order was purchased. + * @param {string} params.packageName The package name of the application + * for which this subscription or in-app item was purchased (for + * example, 'com.some.thing'). + * @param {boolean=} params.revoke Whether to revoke the purchased item. If + * set to true, access to the subscription or in-app item will be + * terminated immediately. If the item is a recurring subscription, all + * future payments will also be terminated. Consumed in-app items need + * to be handled by developer's app. (optional) + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5797,10 +5947,14 @@ export namespace androidpublisher_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.packageName The package name of the application the inapp product was sold in (for example, 'com.some.thing'). - * @param {string} params.productId The inapp product SKU (for example, 'com.some.thing.inapp1'). - * @param {string} params.token The token provided to the user's device when the inapp product was purchased. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName The package name of the application + * the inapp product was sold in (for example, 'com.some.thing'). + * @param {string} params.productId The inapp product SKU (for example, + * 'com.some.thing.inapp1'). + * @param {string} params.token The token provided to the user's device when + * the inapp product was purchased. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5900,10 +6054,15 @@ export namespace androidpublisher_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.packageName The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). - * @param {string} params.subscriptionId The purchased subscription ID (for example, 'monthly001'). - * @param {string} params.token The token provided to the user's device when the subscription was purchased. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName The package name of the application + * for which this subscription was purchased (for example, + * 'com.some.thing'). + * @param {string} params.subscriptionId The purchased subscription ID (for + * example, 'monthly001'). + * @param {string} params.token The token provided to the user's device when + * the subscription was purchased. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5970,11 +6129,17 @@ export namespace androidpublisher_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.packageName The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). - * @param {string} params.subscriptionId The purchased subscription ID (for example, 'monthly001'). - * @param {string} params.token The token provided to the user's device when the subscription was purchased. - * @param {().SubscriptionPurchasesDeferRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName The package name of the application + * for which this subscription was purchased (for example, + * 'com.some.thing'). + * @param {string} params.subscriptionId The purchased subscription ID (for + * example, 'monthly001'). + * @param {string} params.token The token provided to the user's device when + * the subscription was purchased. + * @param {().SubscriptionPurchasesDeferRequest} params.resource Request + * body data + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6054,10 +6219,15 @@ export namespace androidpublisher_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.packageName The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). - * @param {string} params.subscriptionId The purchased subscription ID (for example, 'monthly001'). - * @param {string} params.token The token provided to the user's device when the subscription was purchased. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName The package name of the application + * for which this subscription was purchased (for example, + * 'com.some.thing'). + * @param {string} params.subscriptionId The purchased subscription ID (for + * example, 'monthly001'). + * @param {string} params.token The token provided to the user's device when + * the subscription was purchased. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6123,10 +6293,15 @@ export namespace androidpublisher_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.packageName The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). - * @param {string} params.subscriptionId The purchased subscription ID (for example, 'monthly001'). - * @param {string} params.token The token provided to the user's device when the subscription was purchased. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName The package name of the application + * for which this subscription was purchased (for example, + * 'com.some.thing'). + * @param {string} params.subscriptionId The purchased subscription ID (for + * example, 'monthly001'). + * @param {string} params.token The token provided to the user's device when + * the subscription was purchased. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6194,10 +6369,15 @@ export namespace androidpublisher_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.packageName The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). - * @param {string} params.subscriptionId The purchased subscription ID (for example, 'monthly001'). - * @param {string} params.token The token provided to the user's device when the subscription was purchased. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName The package name of the application + * for which this subscription was purchased (for example, + * 'com.some.thing'). + * @param {string} params.subscriptionId The purchased subscription ID (for + * example, 'monthly001'). + * @param {string} params.token The token provided to the user's device when + * the subscription was purchased. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6387,13 +6567,28 @@ export namespace androidpublisher_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.endTime The time, in milliseconds since the Epoch, of the newest voided in-app product purchase that you want to see in the response. The value of this parameter cannot be greater than the current time and is ignored if a pagination token is set. Default value is current time. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response. + * @param {string=} params.endTime The time, in milliseconds since the + * Epoch, of the newest voided in-app product purchase that you want to + * see in the response. The value of this parameter cannot be greater + * than the current time and is ignored if a pagination token is set. + * Default value is current time. Note: This filter is applied on the + * time at which the record is seen as voided by our systems and not the + * actual voided time returned in the response. * @param {integer=} params.maxResults - * @param {string} params.packageName The package name of the application for which voided purchases need to be returned (for example, 'com.some.thing'). + * @param {string} params.packageName The package name of the application + * for which voided purchases need to be returned (for example, + * 'com.some.thing'). * @param {integer=} params.startIndex - * @param {string=} params.startTime The time, in milliseconds since the Epoch, of the oldest voided in-app product purchase that you want to see in the response. The value of this parameter cannot be older than 30 days and is ignored if a pagination token is set. Default value is current time minus 30 days. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response. + * @param {string=} params.startTime The time, in milliseconds since the + * Epoch, of the oldest voided in-app product purchase that you want to + * see in the response. The value of this parameter cannot be older than + * 30 days and is ignored if a pagination token is set. Default value is + * current time minus 30 days. Note: This filter is applied on the time + * at which the record is seen as voided by our systems and not the + * actual voided time returned in the response. * @param {string=} params.token - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6524,10 +6719,12 @@ export namespace androidpublisher_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.packageName Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app + * for which we want reviews; for example, "com.spiffygame". * @param {string} params.reviewId * @param {string=} params.translationLanguage - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6591,11 +6788,13 @@ export namespace androidpublisher_v2 { * * @param {object} params Parameters for request * @param {integer=} params.maxResults - * @param {string} params.packageName Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app + * for which we want reviews; for example, "com.spiffygame". * @param {integer=} params.startIndex * @param {string=} params.token * @param {string=} params.translationLanguage - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6660,10 +6859,12 @@ export namespace androidpublisher_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.packageName Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app + * for which we want reviews; for example, "com.spiffygame". * @param {string} params.reviewId * @param {().ReviewsReplyRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/androidpublisher/v3.ts b/src/apis/androidpublisher/v3.ts index 77569c6a6fd..6c6691c40d6 100644 --- a/src/apis/androidpublisher/v3.ts +++ b/src/apis/androidpublisher/v3.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -1019,8 +1018,10 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1088,8 +1089,10 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1156,8 +1159,10 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1220,9 +1225,11 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". * @param {().AppEdit} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1288,8 +1295,10 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1452,9 +1461,12 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {().ApksAddExternallyHostedRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {().ApksAddExternallyHostedRequest} params.resource Request body + * data + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1531,8 +1543,10 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1598,11 +1612,13 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type * @param {string|object} params.media.body Media body contents - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1755,8 +1771,10 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1829,11 +1847,13 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type * @param {string|object} params.media.body Media body contents - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1967,14 +1987,18 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer} params.apkVersionCode The version code of the APK whose deobfuscation file is being uploaded. + * @param {integer} params.apkVersionCode The version code of the APK whose + * deobfuscation file is being uploaded. * @param {string} params.deobfuscationFileType * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier of the Android app for which the deobfuscatiuon files are being uploaded; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier of the Android app + * for which the deobfuscatiuon files are being uploaded; for example, + * "com.spiffygame". * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type * @param {string|object} params.media.body Media body contents - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2117,8 +2141,10 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2184,9 +2210,11 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". * @param {().AppDetails} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2255,9 +2283,11 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". * @param {().AppDetails} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2397,11 +2427,14 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer} params.apkVersionCode The version code of the APK whose Expansion File configuration is being read or modified. + * @param {integer} params.apkVersionCode The version code of the APK whose + * Expansion File configuration is being read or modified. * @param {string} params.editId Unique identifier for this edit. * @param {string} params.expansionFileType - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2469,12 +2502,15 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer} params.apkVersionCode The version code of the APK whose Expansion File configuration is being read or modified. + * @param {integer} params.apkVersionCode The version code of the APK whose + * Expansion File configuration is being read or modified. * @param {string} params.editId Unique identifier for this edit. * @param {string} params.expansionFileType - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". * @param {().ExpansionFile} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2545,12 +2581,15 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer} params.apkVersionCode The version code of the APK whose Expansion File configuration is being read or modified. + * @param {integer} params.apkVersionCode The version code of the APK whose + * Expansion File configuration is being read or modified. * @param {string} params.editId Unique identifier for this edit. * @param {string} params.expansionFileType - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". * @param {().ExpansionFile} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2620,14 +2659,17 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer} params.apkVersionCode The version code of the APK whose Expansion File configuration is being read or modified. + * @param {integer} params.apkVersionCode The version code of the APK whose + * Expansion File configuration is being read or modified. * @param {string} params.editId Unique identifier for this edit. * @param {string} params.expansionFileType - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type * @param {string|object} params.media.body Media body contents - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2849,11 +2891,16 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.imageId Unique identifier an image within the set of images attached to this edit. + * @param {string} params.imageId Unique identifier an image within the set + * of images attached to this edit. * @param {string} params.imageType - * @param {string} params.language The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.language The language code (a BCP-47 language tag) + * of the localized listing whose images are to read or modified. For + * example, to select Austrian German, pass "de-AT". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2923,9 +2970,13 @@ export namespace androidpublisher_v3 { * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. * @param {string} params.imageType - * @param {string} params.language The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.language The language code (a BCP-47 language tag) + * of the localized listing whose images are to read or modified. For + * example, to select Austrian German, pass "de-AT". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2997,9 +3048,13 @@ export namespace androidpublisher_v3 { * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. * @param {string} params.imageType - * @param {string} params.language The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.language The language code (a BCP-47 language tag) + * of the localized listing whose images are to read or modified. For + * example, to select Austrian German, pass "de-AT". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3069,12 +3124,16 @@ export namespace androidpublisher_v3 { * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. * @param {string} params.imageType - * @param {string} params.language The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.language The language code (a BCP-47 language tag) + * of the localized listing whose images are to read or modified. For + * example, to select Austrian German, pass "de-AT". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type * @param {string|object} params.media.body Media body contents - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3287,9 +3346,13 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.language The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT". - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.language The language code (a BCP-47 language tag) + * of the localized listing to read or modify. For example, to select + * Austrian German, pass "de-AT". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3356,8 +3419,10 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3424,9 +3489,13 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.language The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT". - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.language The language code (a BCP-47 language tag) + * of the localized listing to read or modify. For example, to select + * Austrian German, pass "de-AT". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3490,8 +3559,10 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3561,10 +3632,14 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.language The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT". - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.language The language code (a BCP-47 language tag) + * of the localized listing to read or modify. For example, to select + * Austrian German, pass "de-AT". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". * @param {().Listing} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3632,10 +3707,14 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.language The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT". - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.language The language code (a BCP-47 language tag) + * of the localized listing to read or modify. For example, to select + * Austrian German, pass "de-AT". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". * @param {().Listing} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3842,9 +3921,12 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {string} params.track The track to read or modify. Acceptable values are: "alpha", "beta", "production", "rollout" or "internal". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {string} params.track The track to read or modify. Acceptable + * values are: "alpha", "beta", "production", "rollout" or "internal". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3907,10 +3989,13 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {string} params.track The track to read or modify. Acceptable values are: "alpha", "beta", "production", "rollout" or "internal". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {string} params.track The track to read or modify. Acceptable + * values are: "alpha", "beta", "production", "rollout" or "internal". * @param {().Testers} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3977,10 +4062,13 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {string} params.track The track to read or modify. Acceptable values are: "alpha", "beta", "production", "rollout" or "internal". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {string} params.track The track to read or modify. Acceptable + * values are: "alpha", "beta", "production", "rollout" or "internal". * @param {().Testers} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4136,9 +4224,11 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". * @param {string} params.track The track to read or modify. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4201,8 +4291,10 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4273,10 +4365,12 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". * @param {string} params.track The track to read or modify. * @param {().Track} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4345,10 +4439,12 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app + * that is being updated; for example, "com.spiffygame". * @param {string} params.track The track to read or modify. * @param {().Track} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4516,9 +4612,11 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.packageName Unique identifier for the Android app with the in-app product; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app + * with the in-app product; for example, "com.spiffygame". * @param {string} params.sku Unique identifier for the in-app product. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4586,7 +4684,8 @@ export namespace androidpublisher_v3 { * @param {object} params Parameters for request * @param {string} params.packageName * @param {string} params.sku Unique identifier for the in-app product. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4650,10 +4749,15 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.autoConvertMissingPrices If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false. - * @param {string} params.packageName Unique identifier for the Android app; for example, "com.spiffygame". + * @param {boolean=} params.autoConvertMissingPrices If true the prices for + * all regions targeted by the parent app that don't have a price + * specified for this in-app product will be auto converted to the + * target currency based on the default price. Defaults to false. + * @param {string} params.packageName Unique identifier for the Android app; + * for example, "com.spiffygame". * @param {().InAppProduct} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4723,10 +4827,12 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {integer=} params.maxResults - * @param {string} params.packageName Unique identifier for the Android app with in-app products; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app + * with in-app products; for example, "com.spiffygame". * @param {integer=} params.startIndex * @param {string=} params.token - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4797,11 +4903,16 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.autoConvertMissingPrices If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false. - * @param {string} params.packageName Unique identifier for the Android app with the in-app product; for example, "com.spiffygame". + * @param {boolean=} params.autoConvertMissingPrices If true the prices for + * all regions targeted by the parent app that don't have a price + * specified for this in-app product will be auto converted to the + * target currency based on the default price. Defaults to false. + * @param {string} params.packageName Unique identifier for the Android app + * with the in-app product; for example, "com.spiffygame". * @param {string} params.sku Unique identifier for the in-app product. * @param {().InAppProduct} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4869,11 +4980,16 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.autoConvertMissingPrices If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false. - * @param {string} params.packageName Unique identifier for the Android app with the in-app product; for example, "com.spiffygame". + * @param {boolean=} params.autoConvertMissingPrices If true the prices for + * all regions targeted by the parent app that don't have a price + * specified for this in-app product will be auto converted to the + * target currency based on the default price. Defaults to false. + * @param {string} params.packageName Unique identifier for the Android app + * with the in-app product; for example, "com.spiffygame". * @param {string} params.sku Unique identifier for the in-app product. * @param {().InAppProduct} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5086,10 +5202,18 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.orderId The order ID provided to the user when the subscription or in-app order was purchased. - * @param {string} params.packageName The package name of the application for which this subscription or in-app item was purchased (for example, 'com.some.thing'). - * @param {boolean=} params.revoke Whether to revoke the purchased item. If set to true, access to the subscription or in-app item will be terminated immediately. If the item is a recurring subscription, all future payments will also be terminated. Consumed in-app items need to be handled by developer's app. (optional) - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.orderId The order ID provided to the user when the + * subscription or in-app order was purchased. + * @param {string} params.packageName The package name of the application + * for which this subscription or in-app item was purchased (for + * example, 'com.some.thing'). + * @param {boolean=} params.revoke Whether to revoke the purchased item. If + * set to true, access to the subscription or in-app item will be + * terminated immediately. If the item is a recurring subscription, all + * future payments will also be terminated. Consumed in-app items need + * to be handled by developer's app. (optional) + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5210,10 +5334,14 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.packageName The package name of the application the inapp product was sold in (for example, 'com.some.thing'). - * @param {string} params.productId The inapp product SKU (for example, 'com.some.thing.inapp1'). - * @param {string} params.token The token provided to the user's device when the inapp product was purchased. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName The package name of the application + * the inapp product was sold in (for example, 'com.some.thing'). + * @param {string} params.productId The inapp product SKU (for example, + * 'com.some.thing.inapp1'). + * @param {string} params.token The token provided to the user's device when + * the inapp product was purchased. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5313,10 +5441,15 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.packageName The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). - * @param {string} params.subscriptionId The purchased subscription ID (for example, 'monthly001'). - * @param {string} params.token The token provided to the user's device when the subscription was purchased. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName The package name of the application + * for which this subscription was purchased (for example, + * 'com.some.thing'). + * @param {string} params.subscriptionId The purchased subscription ID (for + * example, 'monthly001'). + * @param {string} params.token The token provided to the user's device when + * the subscription was purchased. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5383,11 +5516,17 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.packageName The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). - * @param {string} params.subscriptionId The purchased subscription ID (for example, 'monthly001'). - * @param {string} params.token The token provided to the user's device when the subscription was purchased. - * @param {().SubscriptionPurchasesDeferRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName The package name of the application + * for which this subscription was purchased (for example, + * 'com.some.thing'). + * @param {string} params.subscriptionId The purchased subscription ID (for + * example, 'monthly001'). + * @param {string} params.token The token provided to the user's device when + * the subscription was purchased. + * @param {().SubscriptionPurchasesDeferRequest} params.resource Request + * body data + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5467,10 +5606,15 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.packageName The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). - * @param {string} params.subscriptionId The purchased subscription ID (for example, 'monthly001'). - * @param {string} params.token The token provided to the user's device when the subscription was purchased. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName The package name of the application + * for which this subscription was purchased (for example, + * 'com.some.thing'). + * @param {string} params.subscriptionId The purchased subscription ID (for + * example, 'monthly001'). + * @param {string} params.token The token provided to the user's device when + * the subscription was purchased. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5536,10 +5680,15 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.packageName The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). - * @param {string} params.subscriptionId The purchased subscription ID (for example, 'monthly001'). - * @param {string} params.token The token provided to the user's device when the subscription was purchased. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName The package name of the application + * for which this subscription was purchased (for example, + * 'com.some.thing'). + * @param {string} params.subscriptionId The purchased subscription ID (for + * example, 'monthly001'). + * @param {string} params.token The token provided to the user's device when + * the subscription was purchased. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5607,10 +5756,15 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.packageName The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). - * @param {string} params.subscriptionId The purchased subscription ID (for example, 'monthly001'). - * @param {string} params.token The token provided to the user's device when the subscription was purchased. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.packageName The package name of the application + * for which this subscription was purchased (for example, + * 'com.some.thing'). + * @param {string} params.subscriptionId The purchased subscription ID (for + * example, 'monthly001'). + * @param {string} params.token The token provided to the user's device when + * the subscription was purchased. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5800,13 +5954,28 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.endTime The time, in milliseconds since the Epoch, of the newest voided in-app product purchase that you want to see in the response. The value of this parameter cannot be greater than the current time and is ignored if a pagination token is set. Default value is current time. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response. + * @param {string=} params.endTime The time, in milliseconds since the + * Epoch, of the newest voided in-app product purchase that you want to + * see in the response. The value of this parameter cannot be greater + * than the current time and is ignored if a pagination token is set. + * Default value is current time. Note: This filter is applied on the + * time at which the record is seen as voided by our systems and not the + * actual voided time returned in the response. * @param {integer=} params.maxResults - * @param {string} params.packageName The package name of the application for which voided purchases need to be returned (for example, 'com.some.thing'). + * @param {string} params.packageName The package name of the application + * for which voided purchases need to be returned (for example, + * 'com.some.thing'). * @param {integer=} params.startIndex - * @param {string=} params.startTime The time, in milliseconds since the Epoch, of the oldest voided in-app product purchase that you want to see in the response. The value of this parameter cannot be older than 30 days and is ignored if a pagination token is set. Default value is current time minus 30 days. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response. + * @param {string=} params.startTime The time, in milliseconds since the + * Epoch, of the oldest voided in-app product purchase that you want to + * see in the response. The value of this parameter cannot be older than + * 30 days and is ignored if a pagination token is set. Default value is + * current time minus 30 days. Note: This filter is applied on the time + * at which the record is seen as voided by our systems and not the + * actual voided time returned in the response. * @param {string=} params.token - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5937,10 +6106,12 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.packageName Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app + * for which we want reviews; for example, "com.spiffygame". * @param {string} params.reviewId * @param {string=} params.translationLanguage - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6004,11 +6175,13 @@ export namespace androidpublisher_v3 { * * @param {object} params Parameters for request * @param {integer=} params.maxResults - * @param {string} params.packageName Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app + * for which we want reviews; for example, "com.spiffygame". * @param {integer=} params.startIndex * @param {string=} params.token * @param {string=} params.translationLanguage - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6073,10 +6246,12 @@ export namespace androidpublisher_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.packageName Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier for the Android app + * for which we want reviews; for example, "com.spiffygame". * @param {string} params.reviewId * @param {().ReviewsReplyRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/appengine/v1.ts b/src/apis/appengine/v1.ts index 7b73891b9fd..0fda2643064 100644 --- a/src/apis/appengine/v1.ts +++ b/src/apis/appengine/v1.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -463,7 +462,8 @@ export namespace appengine_v1 { export interface Schema$DebugInstanceRequest { /** * Public SSH key to add to the instance. Examples: [USERNAME]:ssh-rsa - * [KEY_VALUE] [USERNAME] [USERNAME]:ssh-rsa [KEY_VALUE] google-ssh + * [KEY_VALUE] [USERNAME] [USERNAME]:ssh-rsa [KEY_VALUE] + * google-ssh * {"userName":"[USERNAME]","expireOn":"[EXPIRE_TIME]"}For * more information, see Adding and Removing SSH Keys * (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys). @@ -475,11 +475,11 @@ export namespace appengine_v1 { */ export interface Schema$Deployment { /** - * Options for any Google Cloud Container Builder builds created as a part - * of this deployment.Note that this is orthogonal to the build parameter, - * where the deployment depends on an already existing cloud build. These - * options will only be used if a new build is created, such as when - * deploying to the App Engine flexible environment using files or zip. + * Options for any Google Cloud Build builds created as a part of this + * deployment.Note that this is orthogonal to the build parameter, where the + * deployment depends on an already existing cloud build. These options will + * only be used if a new build is created, such as when deploying to the App + * Engine flexible environment using files or zip. */ cloudBuildOptions?: Schema$CloudBuildOptions; /** @@ -1005,8 +1005,8 @@ export namespace appengine_v1 { */ displayName?: string; /** - * Cross-service attributes for the location. For example - * {"cloud.googleapis.com/region": "us-east1"} + * Cross-service attributes for the location. For + * example {"cloud.googleapis.com/region": "us-east1"} */ labels?: any; /** @@ -1985,7 +1985,8 @@ export namespace appengine_v1 { * * @param {object} params Parameters for request * @param {().Application} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2048,8 +2049,10 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the Application resource to get. Example: apps/myapp. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the Application + * resource to get. Example: apps/myapp. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2113,10 +2116,13 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the Application resource to update. Example: apps/myapp. - * @param {string=} params.updateMask Standard field mask for the set of fields to be updated. + * @param {string} params.appsId Part of `name`. Name of the Application + * resource to update. Example: apps/myapp. + * @param {string=} params.updateMask Standard field mask for the set of + * fields to be updated. * @param {().Application} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2184,9 +2190,11 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the application to repair. Example: apps/myapp + * @param {string} params.appsId Part of `name`. Name of the application to + * repair. Example: apps/myapp * @param {().RepairApplicationRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2324,9 +2332,11 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `parent`. Name of the parent Application resource. Example: apps/myapp. + * @param {string} params.appsId Part of `parent`. Name of the parent + * Application resource. Example: apps/myapp. * @param {().AuthorizedCertificate} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2393,9 +2403,12 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345. - * @param {string} params.authorizedCertificatesId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource to + * delete. Example: apps/myapp/authorizedCertificates/12345. + * @param {string} params.authorizedCertificatesId Part of `name`. See + * documentation of `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2462,10 +2475,14 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345. - * @param {string} params.authorizedCertificatesId Part of `name`. See documentation of `appsId`. - * @param {string=} params.view Controls the set of fields returned in the GET response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: apps/myapp/authorizedCertificates/12345. + * @param {string} params.authorizedCertificatesId Part of `name`. See + * documentation of `appsId`. + * @param {string=} params.view Controls the set of fields returned in the + * GET response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2530,11 +2547,15 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `parent`. Name of the parent Application resource. Example: apps/myapp. + * @param {string} params.appsId Part of `parent`. Name of the parent + * Application resource. Example: apps/myapp. * @param {integer=} params.pageSize Maximum results to return per page. - * @param {string=} params.pageToken Continuation token for fetching the next page of results. - * @param {string=} params.view Controls the set of fields returned in the LIST response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pageToken Continuation token for fetching the + * next page of results. + * @param {string=} params.view Controls the set of fields returned in the + * LIST response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2615,11 +2636,16 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345. - * @param {string} params.authorizedCertificatesId Part of `name`. See documentation of `appsId`. - * @param {string=} params.updateMask Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields. + * @param {string} params.appsId Part of `name`. Name of the resource to + * update. Example: apps/myapp/authorizedCertificates/12345. + * @param {string} params.authorizedCertificatesId Part of `name`. See + * documentation of `appsId`. + * @param {string=} params.updateMask Standard field mask for the set of + * fields to be updated. Updates are only supported on the + * certificate_raw_data and display_name fields. * @param {().AuthorizedCertificate} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2805,10 +2831,13 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `parent`. Name of the parent Application resource. Example: apps/myapp. + * @param {string} params.appsId Part of `parent`. Name of the parent + * Application resource. Example: apps/myapp. * @param {integer=} params.pageSize Maximum results to return per page. - * @param {string=} params.pageToken Continuation token for fetching the next page of results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pageToken Continuation token for fetching the + * next page of results. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2918,10 +2947,14 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `parent`. Name of the parent Application resource. Example: apps/myapp. - * @param {string=} params.overrideStrategy Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected. + * @param {string} params.appsId Part of `parent`. Name of the parent + * Application resource. Example: apps/myapp. + * @param {string=} params.overrideStrategy Whether the domain creation + * should override any existing mappings for this domain. By default, + * overrides are rejected. * @param {().DomainMapping} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2989,9 +3022,12 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com. - * @param {string} params.domainMappingsId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource to + * delete. Example: apps/myapp/domainMappings/example.com. + * @param {string} params.domainMappingsId Part of `name`. See documentation + * of `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3058,9 +3094,12 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com. - * @param {string} params.domainMappingsId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: apps/myapp/domainMappings/example.com. + * @param {string} params.domainMappingsId Part of `name`. See documentation + * of `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3123,10 +3162,13 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `parent`. Name of the parent Application resource. Example: apps/myapp. + * @param {string} params.appsId Part of `parent`. Name of the parent + * Application resource. Example: apps/myapp. * @param {integer=} params.pageSize Maximum results to return per page. - * @param {string=} params.pageToken Continuation token for fetching the next page of results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pageToken Continuation token for fetching the + * next page of results. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3201,11 +3243,15 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com. - * @param {string} params.domainMappingsId Part of `name`. See documentation of `appsId`. - * @param {string=} params.updateMask Standard field mask for the set of fields to be updated. + * @param {string} params.appsId Part of `name`. Name of the resource to + * update. Example: apps/myapp/domainMappings/example.com. + * @param {string} params.domainMappingsId Part of `name`. See documentation + * of `appsId`. + * @param {string=} params.updateMask Standard field mask for the set of + * fields to be updated. * @param {().DomainMapping} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3404,9 +3450,12 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules. - * @param {().BatchUpdateIngressRulesRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the Firewall + * collection to set. Example: apps/myapp/firewall/ingressRules. + * @param {().BatchUpdateIngressRulesRequest} params.resource Request body + * data + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3483,9 +3532,12 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `parent`. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules. + * @param {string} params.appsId Part of `parent`. Name of the parent + * Firewall collection in which to create a new rule. Example: + * apps/myapp/firewall/ingressRules. * @param {().FirewallRule} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3551,9 +3603,12 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the Firewall resource to delete. Example: apps/myapp/firewall/ingressRules/100. - * @param {string} params.ingressRulesId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the Firewall + * resource to delete. Example: apps/myapp/firewall/ingressRules/100. + * @param {string} params.ingressRulesId Part of `name`. See documentation + * of `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3619,9 +3674,12 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100. - * @param {string} params.ingressRulesId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the Firewall + * resource to retrieve. Example: apps/myapp/firewall/ingressRules/100. + * @param {string} params.ingressRulesId Part of `name`. See documentation + * of `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3684,11 +3742,16 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules. - * @param {string=} params.matchingAddress A valid IP Address. If set, only rules matching this address will be returned. The first returned rule will be the rule that fires on requests from this IP. + * @param {string} params.appsId Part of `parent`. Name of the Firewall + * collection to retrieve. Example: apps/myapp/firewall/ingressRules. + * @param {string=} params.matchingAddress A valid IP Address. If set, only + * rules matching this address will be returned. The first returned rule + * will be the rule that fires on requests from this IP. * @param {integer=} params.pageSize Maximum results to return per page. - * @param {string=} params.pageToken Continuation token for fetching the next page of results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pageToken Continuation token for fetching the + * next page of results. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3755,11 +3818,15 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100. - * @param {string} params.ingressRulesId Part of `name`. See documentation of `appsId`. - * @param {string=} params.updateMask Standard field mask for the set of fields to be updated. + * @param {string} params.appsId Part of `name`. Name of the Firewall + * resource to update. Example: apps/myapp/firewall/ingressRules/100. + * @param {string} params.ingressRulesId Part of `name`. See documentation + * of `appsId`. + * @param {string=} params.updateMask Standard field mask for the set of + * fields to be updated. * @param {().FirewallRule} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3958,9 +4025,12 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Resource name for the location. - * @param {string} params.locationsId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Resource name for the + * location. + * @param {string} params.locationsId Part of `name`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4021,11 +4091,13 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. The resource that owns the locations collection, if applicable. + * @param {string} params.appsId Part of `name`. The resource that owns the + * locations collection, if applicable. * @param {string=} params.filter The standard list filter. * @param {integer=} params.pageSize The standard list page size. * @param {string=} params.pageToken The standard list page token. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4146,9 +4218,12 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. The name of the operation resource. - * @param {string} params.operationsId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. The name of the operation + * resource. + * @param {string} params.operationsId Part of `name`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4218,11 +4293,13 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. The name of the operation's parent resource. + * @param {string} params.appsId Part of `name`. The name of the operation's + * parent resource. * @param {string=} params.filter The standard list filter. * @param {integer=} params.pageSize The standard list page size. * @param {string=} params.pageToken The standard list page token. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4343,9 +4420,12 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/services/default. - * @param {string} params.servicesId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: apps/myapp/services/default. + * @param {string} params.servicesId Part of `name`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4411,9 +4491,12 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/services/default. - * @param {string} params.servicesId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: apps/myapp/services/default. + * @param {string} params.servicesId Part of `name`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4474,10 +4557,13 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `parent`. Name of the parent Application resource. Example: apps/myapp. + * @param {string} params.appsId Part of `parent`. Name of the parent + * Application resource. Example: apps/myapp. * @param {integer=} params.pageSize Maximum results to return per page. - * @param {string=} params.pageToken Continuation token for fetching the next page of results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pageToken Continuation token for fetching the + * next page of results. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4543,12 +4629,29 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource to update. Example: apps/myapp/services/default. - * @param {boolean=} params.migrateTraffic Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic). - * @param {string} params.servicesId Part of `name`. See documentation of `appsId`. - * @param {string=} params.updateMask Standard field mask for the set of fields to be updated. + * @param {string} params.appsId Part of `name`. Name of the resource to + * update. Example: apps/myapp/services/default. + * @param {boolean=} params.migrateTraffic Set to true to gradually shift + * traffic to one or more versions that you specify. By default, traffic + * is shifted immediately. For gradual traffic migration, the target + * versions must be located within instances that are configured for + * both warmup requests + * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#inboundservicetype) + * and automatic scaling + * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#automaticscaling). + * You must specify the shardBy + * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services#shardby) + * field in the Service resource. Gradual traffic migration is not + * supported in the App Engine flexible environment. For examples, see + * Migrating and Splitting Traffic + * (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic). + * @param {string} params.servicesId Part of `name`. See documentation of + * `appsId`. + * @param {string=} params.updateMask Standard field mask for the set of + * fields to be updated. * @param {().Service} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4722,10 +4825,14 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default. - * @param {string} params.servicesId Part of `parent`. See documentation of `appsId`. + * @param {string} params.appsId Part of `parent`. Name of the parent + * resource to create this version under. Example: + * apps/myapp/services/default. + * @param {string} params.servicesId Part of `parent`. See documentation of + * `appsId`. * @param {().Version} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4792,10 +4899,14 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1. - * @param {string} params.servicesId Part of `name`. See documentation of `appsId`. - * @param {string} params.versionsId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: apps/myapp/services/default/versions/v1. + * @param {string} params.servicesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.versionsId Part of `name`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4865,11 +4976,16 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1. - * @param {string} params.servicesId Part of `name`. See documentation of `appsId`. - * @param {string} params.versionsId Part of `name`. See documentation of `appsId`. - * @param {string=} params.view Controls the set of fields returned in the Get response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: apps/myapp/services/default/versions/v1. + * @param {string} params.servicesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.versionsId Part of `name`. See documentation of + * `appsId`. + * @param {string=} params.view Controls the set of fields returned in the + * Get response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4932,12 +5048,17 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default. + * @param {string} params.appsId Part of `parent`. Name of the parent + * Service resource. Example: apps/myapp/services/default. * @param {integer=} params.pageSize Maximum results to return per page. - * @param {string=} params.pageToken Continuation token for fetching the next page of results. - * @param {string} params.servicesId Part of `parent`. See documentation of `appsId`. - * @param {string=} params.view Controls the set of fields returned in the List response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pageToken Continuation token for fetching the + * next page of results. + * @param {string} params.servicesId Part of `parent`. See documentation of + * `appsId`. + * @param {string=} params.view Controls the set of fields returned in the + * List response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5034,12 +5155,17 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1. - * @param {string} params.servicesId Part of `name`. See documentation of `appsId`. - * @param {string=} params.updateMask Standard field mask for the set of fields to be updated. - * @param {string} params.versionsId Part of `name`. See documentation of `appsId`. + * @param {string} params.appsId Part of `name`. Name of the resource to + * update. Example: apps/myapp/services/default/versions/1. + * @param {string} params.servicesId Part of `name`. See documentation of + * `appsId`. + * @param {string=} params.updateMask Standard field mask for the set of + * fields to be updated. + * @param {string} params.versionsId Part of `name`. See documentation of + * `appsId`. * @param {().Version} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5247,12 +5373,18 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1. - * @param {string} params.instancesId Part of `name`. See documentation of `appsId`. - * @param {string} params.servicesId Part of `name`. See documentation of `appsId`. - * @param {string} params.versionsId Part of `name`. See documentation of `appsId`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: + * apps/myapp/services/default/versions/v1/instances/instance-1. + * @param {string} params.instancesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.servicesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.versionsId Part of `name`. See documentation of + * `appsId`. * @param {().DebugInstanceRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5321,11 +5453,17 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1. - * @param {string} params.instancesId Part of `name`. See documentation of `appsId`. - * @param {string} params.servicesId Part of `name`. See documentation of `appsId`. - * @param {string} params.versionsId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: + * apps/myapp/services/default/versions/v1/instances/instance-1. + * @param {string} params.instancesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.servicesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.versionsId Part of `name`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5394,11 +5532,17 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1. - * @param {string} params.instancesId Part of `name`. See documentation of `appsId`. - * @param {string} params.servicesId Part of `name`. See documentation of `appsId`. - * @param {string} params.versionsId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: + * apps/myapp/services/default/versions/v1/instances/instance-1. + * @param {string} params.instancesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.servicesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.versionsId Part of `name`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5463,12 +5607,17 @@ export namespace appengine_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1. + * @param {string} params.appsId Part of `parent`. Name of the parent + * Version resource. Example: apps/myapp/services/default/versions/v1. * @param {integer=} params.pageSize Maximum results to return per page. - * @param {string=} params.pageToken Continuation token for fetching the next page of results. - * @param {string} params.servicesId Part of `parent`. See documentation of `appsId`. - * @param {string} params.versionsId Part of `parent`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pageToken Continuation token for fetching the + * next page of results. + * @param {string} params.servicesId Part of `parent`. See documentation of + * `appsId`. + * @param {string} params.versionsId Part of `parent`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/appengine/v1alpha.ts b/src/apis/appengine/v1alpha.ts index b05b7fcd655..b724c6101e0 100644 --- a/src/apis/appengine/v1alpha.ts +++ b/src/apis/appengine/v1alpha.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -308,8 +307,8 @@ export namespace appengine_v1alpha { */ displayName?: string; /** - * Cross-service attributes for the location. For example - * {"cloud.googleapis.com/region": "us-east1"} + * Cross-service attributes for the location. For + * example {"cloud.googleapis.com/region": "us-east1"} */ labels?: any; /** @@ -706,9 +705,11 @@ export namespace appengine_v1alpha { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `parent`. Name of the parent Application resource. Example: apps/myapp. + * @param {string} params.appsId Part of `parent`. Name of the parent + * Application resource. Example: apps/myapp. * @param {().AuthorizedCertificate} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -775,9 +776,12 @@ export namespace appengine_v1alpha { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345. - * @param {string} params.authorizedCertificatesId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource to + * delete. Example: apps/myapp/authorizedCertificates/12345. + * @param {string} params.authorizedCertificatesId Part of `name`. See + * documentation of `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -844,10 +848,14 @@ export namespace appengine_v1alpha { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345. - * @param {string} params.authorizedCertificatesId Part of `name`. See documentation of `appsId`. - * @param {string=} params.view Controls the set of fields returned in the GET response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: apps/myapp/authorizedCertificates/12345. + * @param {string} params.authorizedCertificatesId Part of `name`. See + * documentation of `appsId`. + * @param {string=} params.view Controls the set of fields returned in the + * GET response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -912,11 +920,15 @@ export namespace appengine_v1alpha { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `parent`. Name of the parent Application resource. Example: apps/myapp. + * @param {string} params.appsId Part of `parent`. Name of the parent + * Application resource. Example: apps/myapp. * @param {integer=} params.pageSize Maximum results to return per page. - * @param {string=} params.pageToken Continuation token for fetching the next page of results. - * @param {string=} params.view Controls the set of fields returned in the LIST response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pageToken Continuation token for fetching the + * next page of results. + * @param {string=} params.view Controls the set of fields returned in the + * LIST response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -997,11 +1009,16 @@ export namespace appengine_v1alpha { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345. - * @param {string} params.authorizedCertificatesId Part of `name`. See documentation of `appsId`. - * @param {string=} params.updateMask Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields. + * @param {string} params.appsId Part of `name`. Name of the resource to + * update. Example: apps/myapp/authorizedCertificates/12345. + * @param {string} params.authorizedCertificatesId Part of `name`. See + * documentation of `appsId`. + * @param {string=} params.updateMask Standard field mask for the set of + * fields to be updated. Updates are only supported on the + * certificate_raw_data and display_name fields. * @param {().AuthorizedCertificate} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1187,10 +1204,13 @@ export namespace appengine_v1alpha { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `parent`. Name of the parent Application resource. Example: apps/myapp. + * @param {string} params.appsId Part of `parent`. Name of the parent + * Application resource. Example: apps/myapp. * @param {integer=} params.pageSize Maximum results to return per page. - * @param {string=} params.pageToken Continuation token for fetching the next page of results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pageToken Continuation token for fetching the + * next page of results. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1300,11 +1320,19 @@ export namespace appengine_v1alpha { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `parent`. Name of the parent Application resource. Example: apps/myapp. - * @param {boolean=} params.noManagedCertificate Whether a managed certificate should be provided by App Engine. If true, a certificate ID must be manaually set in the DomainMapping resource to configure SSL for this domain. If false, a managed certificate will be provisioned and a certificate ID will be automatically populated. - * @param {string=} params.overrideStrategy Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected. + * @param {string} params.appsId Part of `parent`. Name of the parent + * Application resource. Example: apps/myapp. + * @param {boolean=} params.noManagedCertificate Whether a managed + * certificate should be provided by App Engine. If true, a certificate + * ID must be manaually set in the DomainMapping resource to configure + * SSL for this domain. If false, a managed certificate will be + * provisioned and a certificate ID will be automatically populated. + * @param {string=} params.overrideStrategy Whether the domain creation + * should override any existing mappings for this domain. By default, + * overrides are rejected. * @param {().DomainMapping} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1372,9 +1400,12 @@ export namespace appengine_v1alpha { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com. - * @param {string} params.domainMappingsId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource to + * delete. Example: apps/myapp/domainMappings/example.com. + * @param {string} params.domainMappingsId Part of `name`. See documentation + * of `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1441,9 +1472,12 @@ export namespace appengine_v1alpha { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com. - * @param {string} params.domainMappingsId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: apps/myapp/domainMappings/example.com. + * @param {string} params.domainMappingsId Part of `name`. See documentation + * of `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1506,10 +1540,13 @@ export namespace appengine_v1alpha { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `parent`. Name of the parent Application resource. Example: apps/myapp. + * @param {string} params.appsId Part of `parent`. Name of the parent + * Application resource. Example: apps/myapp. * @param {integer=} params.pageSize Maximum results to return per page. - * @param {string=} params.pageToken Continuation token for fetching the next page of results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pageToken Continuation token for fetching the + * next page of results. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1584,12 +1621,22 @@ export namespace appengine_v1alpha { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com. - * @param {string} params.domainMappingsId Part of `name`. See documentation of `appsId`. - * @param {boolean=} params.noManagedCertificate Whether a managed certificate should be provided by App Engine. If true, a certificate ID must be manually set in the DomainMapping resource to configure SSL for this domain. If false, a managed certificate will be provisioned and a certificate ID will be automatically populated. Only applicable if ssl_settings.certificate_id is specified in the update mask. - * @param {string=} params.updateMask Standard field mask for the set of fields to be updated. + * @param {string} params.appsId Part of `name`. Name of the resource to + * update. Example: apps/myapp/domainMappings/example.com. + * @param {string} params.domainMappingsId Part of `name`. See documentation + * of `appsId`. + * @param {boolean=} params.noManagedCertificate Whether a managed + * certificate should be provided by App Engine. If true, a certificate + * ID must be manually set in the DomainMapping resource to configure + * SSL for this domain. If false, a managed certificate will be + * provisioned and a certificate ID will be automatically populated. + * Only applicable if ssl_settings.certificate_id is specified in the + * update mask. + * @param {string=} params.updateMask Standard field mask for the set of + * fields to be updated. * @param {().DomainMapping} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1785,9 +1832,12 @@ export namespace appengine_v1alpha { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Resource name for the location. - * @param {string} params.locationsId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Resource name for the + * location. + * @param {string} params.locationsId Part of `name`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1848,11 +1898,13 @@ export namespace appengine_v1alpha { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. The resource that owns the locations collection, if applicable. + * @param {string} params.appsId Part of `name`. The resource that owns the + * locations collection, if applicable. * @param {string=} params.filter The standard list filter. * @param {integer=} params.pageSize The standard list page size. * @param {string=} params.pageToken The standard list page token. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1973,9 +2025,12 @@ export namespace appengine_v1alpha { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. The name of the operation resource. - * @param {string} params.operationsId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. The name of the operation + * resource. + * @param {string} params.operationsId Part of `name`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2046,11 +2101,13 @@ export namespace appengine_v1alpha { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. The name of the operation's parent resource. + * @param {string} params.appsId Part of `name`. The name of the operation's + * parent resource. * @param {string=} params.filter The standard list filter. * @param {integer=} params.pageSize The standard list page size. * @param {string=} params.pageToken The standard list page token. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/appengine/v1beta.ts b/src/apis/appengine/v1beta.ts index 2879acf0ce5..d9eb2bb4e56 100644 --- a/src/apis/appengine/v1beta.ts +++ b/src/apis/appengine/v1beta.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -362,11 +361,11 @@ export namespace appengine_v1beta { ingressRules?: Schema$FirewallRule[]; } /** - * Google Cloud Container Builder build information. + * Google Cloud Build information. */ export interface Schema$BuildInfo { /** - * The Google Cloud Container Builder build id. Example: + * The Google Cloud Build id. Example: * "f966068f-08b2-42c8-bdfe-74137dff2bf9" */ cloudBuildId?: string; @@ -507,7 +506,8 @@ export namespace appengine_v1beta { export interface Schema$DebugInstanceRequest { /** * Public SSH key to add to the instance. Examples: [USERNAME]:ssh-rsa - * [KEY_VALUE] [USERNAME] [USERNAME]:ssh-rsa [KEY_VALUE] google-ssh + * [KEY_VALUE] [USERNAME] [USERNAME]:ssh-rsa [KEY_VALUE] + * google-ssh * {"userName":"[USERNAME]","expireOn":"[EXPIRE_TIME]"}For * more information, see Adding and Removing SSH Keys * (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys). @@ -519,16 +519,16 @@ export namespace appengine_v1beta { */ export interface Schema$Deployment { /** - * Google Cloud Container Builder build information. Only applicable for - * instances running in the App Engine flexible environment. + * Google Cloud Build build information. Only applicable for instances + * running in the App Engine flexible environment. */ build?: Schema$BuildInfo; /** - * Options for any Google Cloud Container Builder builds created as a part - * of this deployment.Note that this is orthogonal to the build parameter, - * where the deployment depends on an already existing cloud build. These - * options will only be used if a new build is created, such as when - * deploying to the App Engine flexible environment using files or zip. + * Options for any Google Cloud Build builds created as a part of this + * deployment.Note that this is orthogonal to the build parameter, where the + * deployment depends on an already existing cloud build. These options will + * only be used if a new build is created, such as when deploying to the App + * Engine flexible environment using files or zip. */ cloudBuildOptions?: Schema$CloudBuildOptions; /** @@ -1070,8 +1070,8 @@ export namespace appengine_v1beta { */ displayName?: string; /** - * Cross-service attributes for the location. For example - * {"cloud.googleapis.com/region": "us-east1"} + * Cross-service attributes for the location. For + * example {"cloud.googleapis.com/region": "us-east1"} */ labels?: any; /** @@ -2069,7 +2069,8 @@ export namespace appengine_v1beta { * * @param {object} params Parameters for request * @param {().Application} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2132,8 +2133,10 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the Application resource to get. Example: apps/myapp. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the Application + * resource to get. Example: apps/myapp. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2197,10 +2200,13 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the Application resource to update. Example: apps/myapp. - * @param {string=} params.updateMask Standard field mask for the set of fields to be updated. + * @param {string} params.appsId Part of `name`. Name of the Application + * resource to update. Example: apps/myapp. + * @param {string=} params.updateMask Standard field mask for the set of + * fields to be updated. * @param {().Application} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2268,9 +2274,11 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the application to repair. Example: apps/myapp + * @param {string} params.appsId Part of `name`. Name of the application to + * repair. Example: apps/myapp * @param {().RepairApplicationRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2408,9 +2416,11 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `parent`. Name of the parent Application resource. Example: apps/myapp. + * @param {string} params.appsId Part of `parent`. Name of the parent + * Application resource. Example: apps/myapp. * @param {().AuthorizedCertificate} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2477,9 +2487,12 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345. - * @param {string} params.authorizedCertificatesId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource to + * delete. Example: apps/myapp/authorizedCertificates/12345. + * @param {string} params.authorizedCertificatesId Part of `name`. See + * documentation of `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2546,10 +2559,14 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345. - * @param {string} params.authorizedCertificatesId Part of `name`. See documentation of `appsId`. - * @param {string=} params.view Controls the set of fields returned in the GET response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: apps/myapp/authorizedCertificates/12345. + * @param {string} params.authorizedCertificatesId Part of `name`. See + * documentation of `appsId`. + * @param {string=} params.view Controls the set of fields returned in the + * GET response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2614,11 +2631,15 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `parent`. Name of the parent Application resource. Example: apps/myapp. + * @param {string} params.appsId Part of `parent`. Name of the parent + * Application resource. Example: apps/myapp. * @param {integer=} params.pageSize Maximum results to return per page. - * @param {string=} params.pageToken Continuation token for fetching the next page of results. - * @param {string=} params.view Controls the set of fields returned in the LIST response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pageToken Continuation token for fetching the + * next page of results. + * @param {string=} params.view Controls the set of fields returned in the + * LIST response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2699,11 +2720,16 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345. - * @param {string} params.authorizedCertificatesId Part of `name`. See documentation of `appsId`. - * @param {string=} params.updateMask Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields. + * @param {string} params.appsId Part of `name`. Name of the resource to + * update. Example: apps/myapp/authorizedCertificates/12345. + * @param {string} params.authorizedCertificatesId Part of `name`. See + * documentation of `appsId`. + * @param {string=} params.updateMask Standard field mask for the set of + * fields to be updated. Updates are only supported on the + * certificate_raw_data and display_name fields. * @param {().AuthorizedCertificate} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2889,10 +2915,13 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `parent`. Name of the parent Application resource. Example: apps/myapp. + * @param {string} params.appsId Part of `parent`. Name of the parent + * Application resource. Example: apps/myapp. * @param {integer=} params.pageSize Maximum results to return per page. - * @param {string=} params.pageToken Continuation token for fetching the next page of results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pageToken Continuation token for fetching the + * next page of results. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3002,10 +3031,14 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `parent`. Name of the parent Application resource. Example: apps/myapp. - * @param {string=} params.overrideStrategy Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected. + * @param {string} params.appsId Part of `parent`. Name of the parent + * Application resource. Example: apps/myapp. + * @param {string=} params.overrideStrategy Whether the domain creation + * should override any existing mappings for this domain. By default, + * overrides are rejected. * @param {().DomainMapping} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3073,9 +3106,12 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com. - * @param {string} params.domainMappingsId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource to + * delete. Example: apps/myapp/domainMappings/example.com. + * @param {string} params.domainMappingsId Part of `name`. See documentation + * of `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3142,9 +3178,12 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com. - * @param {string} params.domainMappingsId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: apps/myapp/domainMappings/example.com. + * @param {string} params.domainMappingsId Part of `name`. See documentation + * of `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3207,10 +3246,13 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `parent`. Name of the parent Application resource. Example: apps/myapp. + * @param {string} params.appsId Part of `parent`. Name of the parent + * Application resource. Example: apps/myapp. * @param {integer=} params.pageSize Maximum results to return per page. - * @param {string=} params.pageToken Continuation token for fetching the next page of results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pageToken Continuation token for fetching the + * next page of results. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3285,11 +3327,15 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com. - * @param {string} params.domainMappingsId Part of `name`. See documentation of `appsId`. - * @param {string=} params.updateMask Standard field mask for the set of fields to be updated. + * @param {string} params.appsId Part of `name`. Name of the resource to + * update. Example: apps/myapp/domainMappings/example.com. + * @param {string} params.domainMappingsId Part of `name`. See documentation + * of `appsId`. + * @param {string=} params.updateMask Standard field mask for the set of + * fields to be updated. * @param {().DomainMapping} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3488,9 +3534,12 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules. - * @param {().BatchUpdateIngressRulesRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the Firewall + * collection to set. Example: apps/myapp/firewall/ingressRules. + * @param {().BatchUpdateIngressRulesRequest} params.resource Request body + * data + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3567,9 +3616,12 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `parent`. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules. + * @param {string} params.appsId Part of `parent`. Name of the parent + * Firewall collection in which to create a new rule. Example: + * apps/myapp/firewall/ingressRules. * @param {().FirewallRule} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3635,9 +3687,12 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the Firewall resource to delete. Example: apps/myapp/firewall/ingressRules/100. - * @param {string} params.ingressRulesId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the Firewall + * resource to delete. Example: apps/myapp/firewall/ingressRules/100. + * @param {string} params.ingressRulesId Part of `name`. See documentation + * of `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3704,9 +3759,12 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100. - * @param {string} params.ingressRulesId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the Firewall + * resource to retrieve. Example: apps/myapp/firewall/ingressRules/100. + * @param {string} params.ingressRulesId Part of `name`. See documentation + * of `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3770,11 +3828,16 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules. - * @param {string=} params.matchingAddress A valid IP Address. If set, only rules matching this address will be returned. The first returned rule will be the rule that fires on requests from this IP. + * @param {string} params.appsId Part of `parent`. Name of the Firewall + * collection to retrieve. Example: apps/myapp/firewall/ingressRules. + * @param {string=} params.matchingAddress A valid IP Address. If set, only + * rules matching this address will be returned. The first returned rule + * will be the rule that fires on requests from this IP. * @param {integer=} params.pageSize Maximum results to return per page. - * @param {string=} params.pageToken Continuation token for fetching the next page of results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pageToken Continuation token for fetching the + * next page of results. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3841,11 +3904,15 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100. - * @param {string} params.ingressRulesId Part of `name`. See documentation of `appsId`. - * @param {string=} params.updateMask Standard field mask for the set of fields to be updated. + * @param {string} params.appsId Part of `name`. Name of the Firewall + * resource to update. Example: apps/myapp/firewall/ingressRules/100. + * @param {string} params.ingressRulesId Part of `name`. See documentation + * of `appsId`. + * @param {string=} params.updateMask Standard field mask for the set of + * fields to be updated. * @param {().FirewallRule} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4045,9 +4112,12 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Resource name for the location. - * @param {string} params.locationsId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Resource name for the + * location. + * @param {string} params.locationsId Part of `name`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4108,11 +4178,13 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. The resource that owns the locations collection, if applicable. + * @param {string} params.appsId Part of `name`. The resource that owns the + * locations collection, if applicable. * @param {string=} params.filter The standard list filter. * @param {integer=} params.pageSize The standard list page size. * @param {string=} params.pageToken The standard list page token. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4233,9 +4305,12 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. The name of the operation resource. - * @param {string} params.operationsId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. The name of the operation + * resource. + * @param {string} params.operationsId Part of `name`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4305,11 +4380,13 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. The name of the operation's parent resource. + * @param {string} params.appsId Part of `name`. The name of the operation's + * parent resource. * @param {string=} params.filter The standard list filter. * @param {integer=} params.pageSize The standard list page size. * @param {string=} params.pageToken The standard list page token. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4430,9 +4507,12 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/services/default. - * @param {string} params.servicesId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: apps/myapp/services/default. + * @param {string} params.servicesId Part of `name`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4498,9 +4578,12 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/services/default. - * @param {string} params.servicesId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: apps/myapp/services/default. + * @param {string} params.servicesId Part of `name`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4561,10 +4644,13 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `parent`. Name of the parent Application resource. Example: apps/myapp. + * @param {string} params.appsId Part of `parent`. Name of the parent + * Application resource. Example: apps/myapp. * @param {integer=} params.pageSize Maximum results to return per page. - * @param {string=} params.pageToken Continuation token for fetching the next page of results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pageToken Continuation token for fetching the + * next page of results. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4630,12 +4716,29 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource to update. Example: apps/myapp/services/default. - * @param {boolean=} params.migrateTraffic Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic). - * @param {string} params.servicesId Part of `name`. See documentation of `appsId`. - * @param {string=} params.updateMask Standard field mask for the set of fields to be updated. + * @param {string} params.appsId Part of `name`. Name of the resource to + * update. Example: apps/myapp/services/default. + * @param {boolean=} params.migrateTraffic Set to true to gradually shift + * traffic to one or more versions that you specify. By default, traffic + * is shifted immediately. For gradual traffic migration, the target + * versions must be located within instances that are configured for + * both warmup requests + * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#inboundservicetype) + * and automatic scaling + * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#automaticscaling). + * You must specify the shardBy + * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services#shardby) + * field in the Service resource. Gradual traffic migration is not + * supported in the App Engine flexible environment. For examples, see + * Migrating and Splitting Traffic + * (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic). + * @param {string} params.servicesId Part of `name`. See documentation of + * `appsId`. + * @param {string=} params.updateMask Standard field mask for the set of + * fields to be updated. * @param {().Service} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4809,10 +4912,14 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default. - * @param {string} params.servicesId Part of `parent`. See documentation of `appsId`. + * @param {string} params.appsId Part of `parent`. Name of the parent + * resource to create this version under. Example: + * apps/myapp/services/default. + * @param {string} params.servicesId Part of `parent`. See documentation of + * `appsId`. * @param {().Version} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4879,10 +4986,14 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1. - * @param {string} params.servicesId Part of `name`. See documentation of `appsId`. - * @param {string} params.versionsId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: apps/myapp/services/default/versions/v1. + * @param {string} params.servicesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.versionsId Part of `name`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4952,11 +5063,16 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1. - * @param {string} params.servicesId Part of `name`. See documentation of `appsId`. - * @param {string} params.versionsId Part of `name`. See documentation of `appsId`. - * @param {string=} params.view Controls the set of fields returned in the Get response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: apps/myapp/services/default/versions/v1. + * @param {string} params.servicesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.versionsId Part of `name`. See documentation of + * `appsId`. + * @param {string=} params.view Controls the set of fields returned in the + * Get response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5019,12 +5135,17 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default. + * @param {string} params.appsId Part of `parent`. Name of the parent + * Service resource. Example: apps/myapp/services/default. * @param {integer=} params.pageSize Maximum results to return per page. - * @param {string=} params.pageToken Continuation token for fetching the next page of results. - * @param {string} params.servicesId Part of `parent`. See documentation of `appsId`. - * @param {string=} params.view Controls the set of fields returned in the List response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pageToken Continuation token for fetching the + * next page of results. + * @param {string} params.servicesId Part of `parent`. See documentation of + * `appsId`. + * @param {string=} params.view Controls the set of fields returned in the + * List response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5121,12 +5242,17 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1. - * @param {string} params.servicesId Part of `name`. See documentation of `appsId`. - * @param {string=} params.updateMask Standard field mask for the set of fields to be updated. - * @param {string} params.versionsId Part of `name`. See documentation of `appsId`. + * @param {string} params.appsId Part of `name`. Name of the resource to + * update. Example: apps/myapp/services/default/versions/1. + * @param {string} params.servicesId Part of `name`. See documentation of + * `appsId`. + * @param {string=} params.updateMask Standard field mask for the set of + * fields to be updated. + * @param {string} params.versionsId Part of `name`. See documentation of + * `appsId`. * @param {().Version} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5334,12 +5460,18 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1. - * @param {string} params.instancesId Part of `name`. See documentation of `appsId`. - * @param {string} params.servicesId Part of `name`. See documentation of `appsId`. - * @param {string} params.versionsId Part of `name`. See documentation of `appsId`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: + * apps/myapp/services/default/versions/v1/instances/instance-1. + * @param {string} params.instancesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.servicesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.versionsId Part of `name`. See documentation of + * `appsId`. * @param {().DebugInstanceRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5408,11 +5540,17 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1. - * @param {string} params.instancesId Part of `name`. See documentation of `appsId`. - * @param {string} params.servicesId Part of `name`. See documentation of `appsId`. - * @param {string} params.versionsId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: + * apps/myapp/services/default/versions/v1/instances/instance-1. + * @param {string} params.instancesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.servicesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.versionsId Part of `name`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5481,11 +5619,17 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1. - * @param {string} params.instancesId Part of `name`. See documentation of `appsId`. - * @param {string} params.servicesId Part of `name`. See documentation of `appsId`. - * @param {string} params.versionsId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: + * apps/myapp/services/default/versions/v1/instances/instance-1. + * @param {string} params.instancesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.servicesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.versionsId Part of `name`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5550,12 +5694,17 @@ export namespace appengine_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1. + * @param {string} params.appsId Part of `parent`. Name of the parent + * Version resource. Example: apps/myapp/services/default/versions/v1. * @param {integer=} params.pageSize Maximum results to return per page. - * @param {string=} params.pageToken Continuation token for fetching the next page of results. - * @param {string} params.servicesId Part of `parent`. See documentation of `appsId`. - * @param {string} params.versionsId Part of `parent`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pageToken Continuation token for fetching the + * next page of results. + * @param {string} params.servicesId Part of `parent`. See documentation of + * `appsId`. + * @param {string} params.versionsId Part of `parent`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/appengine/v1beta4.ts b/src/apis/appengine/v1beta4.ts index e47ad7b0de3..8d9f3e6e641 100644 --- a/src/apis/appengine/v1beta4.ts +++ b/src/apis/appengine/v1beta4.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -307,7 +306,8 @@ export namespace appengine_v1beta4 { export interface Schema$DebugInstanceRequest { /** * Public SSH key to add to the instance. Examples: [USERNAME]:ssh-rsa - * [KEY_VALUE] [USERNAME] [USERNAME]:ssh-rsa [KEY_VALUE] google-ssh + * [KEY_VALUE] [USERNAME] [USERNAME]:ssh-rsa [KEY_VALUE] + * google-ssh * {"userName":"[USERNAME]","expireOn":"[EXPIRE_TIME]"}For * more information, see Adding and Removing SSH Keys * (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys). @@ -659,8 +659,8 @@ export namespace appengine_v1beta4 { */ displayName?: string; /** - * Cross-service attributes for the location. For example - * {"cloud.googleapis.com/region": "us-east1"} + * Cross-service attributes for the location. For + * example {"cloud.googleapis.com/region": "us-east1"} */ labels?: any; /** @@ -1479,7 +1479,8 @@ export namespace appengine_v1beta4 { * * @param {object} params Parameters for request * @param {().Application} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1542,9 +1543,16 @@ export namespace appengine_v1beta4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the application to get. Example: apps/myapp. - * @param {boolean=} params.ensureResourcesExist Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the GET operation. If specified and any resources could not be created, the request will fail with an error code. Additionally, this parameter can cause the request to take longer to complete. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the application to + * get. Example: apps/myapp. + * @param {boolean=} params.ensureResourcesExist Certain resources + * associated with an application are created on-demand. Controls + * whether these resources should be created when performing the GET + * operation. If specified and any resources could not be created, the + * request will fail with an error code. Additionally, this parameter + * can cause the request to take longer to complete. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1609,10 +1617,13 @@ export namespace appengine_v1beta4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the Application resource to update. Example: apps/myapp. - * @param {string=} params.mask Standard field mask for the set of fields to be updated. + * @param {string} params.appsId Part of `name`. Name of the Application + * resource to update. Example: apps/myapp. + * @param {string=} params.mask Standard field mask for the set of fields to + * be updated. * @param {().Application} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1741,9 +1752,12 @@ export namespace appengine_v1beta4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Resource name for the location. - * @param {string} params.locationsId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Resource name for the + * location. + * @param {string} params.locationsId Part of `name`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1804,11 +1818,13 @@ export namespace appengine_v1beta4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. The resource that owns the locations collection, if applicable. + * @param {string} params.appsId Part of `name`. The resource that owns the + * locations collection, if applicable. * @param {string=} params.filter The standard list filter. * @param {integer=} params.pageSize The standard list page size. * @param {string=} params.pageToken The standard list page token. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1929,9 +1945,12 @@ export namespace appengine_v1beta4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default. - * @param {string} params.modulesId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: apps/myapp/modules/default. + * @param {string} params.modulesId Part of `name`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1997,9 +2016,12 @@ export namespace appengine_v1beta4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default. - * @param {string} params.modulesId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: apps/myapp/modules/default. + * @param {string} params.modulesId Part of `name`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2059,10 +2081,13 @@ export namespace appengine_v1beta4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: apps/myapp. * @param {integer=} params.pageSize Maximum results to return per page. - * @param {string=} params.pageToken Continuation token for fetching the next page of results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pageToken Continuation token for fetching the + * next page of results. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2127,12 +2152,29 @@ export namespace appengine_v1beta4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default. - * @param {string=} params.mask Standard field mask for the set of fields to be updated. - * @param {boolean=} params.migrateTraffic Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules#shardby) field in the Module resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic). - * @param {string} params.modulesId Part of `name`. See documentation of `appsId`. + * @param {string} params.appsId Part of `name`. Name of the resource to + * update. Example: apps/myapp/modules/default. + * @param {string=} params.mask Standard field mask for the set of fields to + * be updated. + * @param {boolean=} params.migrateTraffic Set to true to gradually shift + * traffic to one or more versions that you specify. By default, traffic + * is shifted immediately. For gradual traffic migration, the target + * versions must be located within instances that are configured for + * both warmup requests + * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#inboundservicetype) + * and automatic scaling + * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#automaticscaling). + * You must specify the shardBy + * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules#shardby) + * field in the Module resource. Gradual traffic migration is not + * supported in the App Engine flexible environment. For examples, see + * Migrating and Splitting Traffic + * (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic). + * @param {string} params.modulesId Part of `name`. See documentation of + * `appsId`. * @param {().Module} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2304,10 +2346,13 @@ export namespace appengine_v1beta4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default. - * @param {string} params.modulesId Part of `name`. See documentation of `appsId`. + * @param {string} params.appsId Part of `name`. Name of the resource to + * update. Example: apps/myapp/modules/default. + * @param {string} params.modulesId Part of `name`. See documentation of + * `appsId`. * @param {().Version} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2374,10 +2419,14 @@ export namespace appengine_v1beta4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1. - * @param {string} params.modulesId Part of `name`. See documentation of `appsId`. - * @param {string} params.versionsId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: apps/myapp/modules/default/versions/v1. + * @param {string} params.modulesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.versionsId Part of `name`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2447,11 +2496,16 @@ export namespace appengine_v1beta4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1. - * @param {string} params.modulesId Part of `name`. See documentation of `appsId`. - * @param {string} params.versionsId Part of `name`. See documentation of `appsId`. - * @param {string=} params.view Controls the set of fields returned in the Get response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: apps/myapp/modules/default/versions/v1. + * @param {string} params.modulesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.versionsId Part of `name`. See documentation of + * `appsId`. + * @param {string=} params.view Controls the set of fields returned in the + * Get response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2514,12 +2568,17 @@ export namespace appengine_v1beta4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default. - * @param {string} params.modulesId Part of `name`. See documentation of `appsId`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: apps/myapp/modules/default. + * @param {string} params.modulesId Part of `name`. See documentation of + * `appsId`. * @param {integer=} params.pageSize Maximum results to return per page. - * @param {string=} params.pageToken Continuation token for fetching the next page of results. - * @param {string=} params.view Controls the set of fields returned in the List response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pageToken Continuation token for fetching the + * next page of results. + * @param {string=} params.view Controls the set of fields returned in the + * List response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2601,12 +2660,17 @@ export namespace appengine_v1beta4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default/versions/1. - * @param {string=} params.mask Standard field mask for the set of fields to be updated. - * @param {string} params.modulesId Part of `name`. See documentation of `appsId`. - * @param {string} params.versionsId Part of `name`. See documentation of `appsId`. + * @param {string} params.appsId Part of `name`. Name of the resource to + * update. Example: apps/myapp/modules/default/versions/1. + * @param {string=} params.mask Standard field mask for the set of fields to + * be updated. + * @param {string} params.modulesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.versionsId Part of `name`. See documentation of + * `appsId`. * @param {().Version} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2814,12 +2878,18 @@ export namespace appengine_v1beta4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1. - * @param {string} params.instancesId Part of `name`. See documentation of `appsId`. - * @param {string} params.modulesId Part of `name`. See documentation of `appsId`. - * @param {string} params.versionsId Part of `name`. See documentation of `appsId`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: + * apps/myapp/modules/default/versions/v1/instances/instance-1. + * @param {string} params.instancesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.modulesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.versionsId Part of `name`. See documentation of + * `appsId`. * @param {().DebugInstanceRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2888,11 +2958,17 @@ export namespace appengine_v1beta4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1. - * @param {string} params.instancesId Part of `name`. See documentation of `appsId`. - * @param {string} params.modulesId Part of `name`. See documentation of `appsId`. - * @param {string} params.versionsId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: + * apps/myapp/modules/default/versions/v1/instances/instance-1. + * @param {string} params.instancesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.modulesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.versionsId Part of `name`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2961,11 +3037,17 @@ export namespace appengine_v1beta4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1. - * @param {string} params.instancesId Part of `name`. See documentation of `appsId`. - * @param {string} params.modulesId Part of `name`. See documentation of `appsId`. - * @param {string} params.versionsId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: + * apps/myapp/modules/default/versions/v1/instances/instance-1. + * @param {string} params.instancesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.modulesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.versionsId Part of `name`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3030,12 +3112,17 @@ export namespace appengine_v1beta4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1. - * @param {string} params.modulesId Part of `name`. See documentation of `appsId`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: apps/myapp/modules/default/versions/v1. + * @param {string} params.modulesId Part of `name`. See documentation of + * `appsId`. * @param {integer=} params.pageSize Maximum results to return per page. - * @param {string=} params.pageToken Continuation token for fetching the next page of results. - * @param {string} params.versionsId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pageToken Continuation token for fetching the + * next page of results. + * @param {string} params.versionsId Part of `name`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3226,9 +3313,12 @@ export namespace appengine_v1beta4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. The name of the operation resource. - * @param {string} params.operationsId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. The name of the operation + * resource. + * @param {string} params.operationsId Part of `name`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3299,11 +3389,13 @@ export namespace appengine_v1beta4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. The name of the operation's parent resource. + * @param {string} params.appsId Part of `name`. The name of the operation's + * parent resource. * @param {string=} params.filter The standard list filter. * @param {integer=} params.pageSize The standard list page size. * @param {string=} params.pageToken The standard list page token. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/appengine/v1beta5.ts b/src/apis/appengine/v1beta5.ts index 331177b0382..2a9f9473db8 100644 --- a/src/apis/appengine/v1beta5.ts +++ b/src/apis/appengine/v1beta5.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -307,7 +306,8 @@ export namespace appengine_v1beta5 { export interface Schema$DebugInstanceRequest { /** * Public SSH key to add to the instance. Examples: [USERNAME]:ssh-rsa - * [KEY_VALUE] [USERNAME] [USERNAME]:ssh-rsa [KEY_VALUE] google-ssh + * [KEY_VALUE] [USERNAME] [USERNAME]:ssh-rsa [KEY_VALUE] + * google-ssh * {"userName":"[USERNAME]","expireOn":"[EXPIRE_TIME]"}For * more information, see Adding and Removing SSH Keys * (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys). @@ -659,8 +659,8 @@ export namespace appengine_v1beta5 { */ displayName?: string; /** - * Cross-service attributes for the location. For example - * {"cloud.googleapis.com/region": "us-east1"} + * Cross-service attributes for the location. For + * example {"cloud.googleapis.com/region": "us-east1"} */ labels?: any; /** @@ -1455,7 +1455,8 @@ export namespace appengine_v1beta5 { * * @param {object} params Parameters for request * @param {().Application} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1518,9 +1519,17 @@ export namespace appengine_v1beta5 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the application to get. Example: apps/myapp. - * @param {boolean=} params.ensureResourcesExist Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the GET operation. If specified and any resources could not be created, the request will fail with an error code. Additionally, this parameter can cause the request to take longer to complete. Note: This parameter will be deprecated in a future version of the API. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the application to + * get. Example: apps/myapp. + * @param {boolean=} params.ensureResourcesExist Certain resources + * associated with an application are created on-demand. Controls + * whether these resources should be created when performing the GET + * operation. If specified and any resources could not be created, the + * request will fail with an error code. Additionally, this parameter + * can cause the request to take longer to complete. Note: This + * parameter will be deprecated in a future version of the API. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1585,10 +1594,13 @@ export namespace appengine_v1beta5 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the Application resource to update. Example: apps/myapp. - * @param {string=} params.mask Standard field mask for the set of fields to be updated. + * @param {string} params.appsId Part of `name`. Name of the Application + * resource to update. Example: apps/myapp. + * @param {string=} params.mask Standard field mask for the set of fields to + * be updated. * @param {().Application} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1718,9 +1730,12 @@ export namespace appengine_v1beta5 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Resource name for the location. - * @param {string} params.locationsId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Resource name for the + * location. + * @param {string} params.locationsId Part of `name`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1781,11 +1796,13 @@ export namespace appengine_v1beta5 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. The resource that owns the locations collection, if applicable. + * @param {string} params.appsId Part of `name`. The resource that owns the + * locations collection, if applicable. * @param {string=} params.filter The standard list filter. * @param {integer=} params.pageSize The standard list page size. * @param {string=} params.pageToken The standard list page token. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1906,9 +1923,12 @@ export namespace appengine_v1beta5 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. The name of the operation resource. - * @param {string} params.operationsId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. The name of the operation + * resource. + * @param {string} params.operationsId Part of `name`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1979,11 +1999,13 @@ export namespace appengine_v1beta5 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. The name of the operation's parent resource. + * @param {string} params.appsId Part of `name`. The name of the operation's + * parent resource. * @param {string=} params.filter The standard list filter. * @param {integer=} params.pageSize The standard list page size. * @param {string=} params.pageToken The standard list page token. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2104,9 +2126,12 @@ export namespace appengine_v1beta5 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/services/default. - * @param {string} params.servicesId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: apps/myapp/services/default. + * @param {string} params.servicesId Part of `name`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2172,9 +2197,12 @@ export namespace appengine_v1beta5 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/services/default. - * @param {string} params.servicesId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: apps/myapp/services/default. + * @param {string} params.servicesId Part of `name`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2235,10 +2263,13 @@ export namespace appengine_v1beta5 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: apps/myapp. * @param {integer=} params.pageSize Maximum results to return per page. - * @param {string=} params.pageToken Continuation token for fetching the next page of results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pageToken Continuation token for fetching the + * next page of results. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2304,12 +2335,29 @@ export namespace appengine_v1beta5 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource to update. Example: apps/myapp/services/default. - * @param {string=} params.mask Standard field mask for the set of fields to be updated. - * @param {boolean=} params.migrateTraffic Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic). - * @param {string} params.servicesId Part of `name`. See documentation of `appsId`. + * @param {string} params.appsId Part of `name`. Name of the resource to + * update. Example: apps/myapp/services/default. + * @param {string=} params.mask Standard field mask for the set of fields to + * be updated. + * @param {boolean=} params.migrateTraffic Set to true to gradually shift + * traffic to one or more versions that you specify. By default, traffic + * is shifted immediately. For gradual traffic migration, the target + * versions must be located within instances that are configured for + * both warmup requests + * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#inboundservicetype) + * and automatic scaling + * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#automaticscaling). + * You must specify the shardBy + * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services#shardby) + * field in the Service resource. Gradual traffic migration is not + * supported in the App Engine flexible environment. For examples, see + * Migrating and Splitting Traffic + * (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic). + * @param {string} params.servicesId Part of `name`. See documentation of + * `appsId`. * @param {().Service} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2482,10 +2530,13 @@ export namespace appengine_v1beta5 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource to update. For example: "apps/myapp/services/default". - * @param {string} params.servicesId Part of `name`. See documentation of `appsId`. + * @param {string} params.appsId Part of `name`. Name of the resource to + * update. For example: "apps/myapp/services/default". + * @param {string} params.servicesId Part of `name`. See documentation of + * `appsId`. * @param {().Version} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2552,10 +2603,14 @@ export namespace appengine_v1beta5 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1. - * @param {string} params.servicesId Part of `name`. See documentation of `appsId`. - * @param {string} params.versionsId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: apps/myapp/services/default/versions/v1. + * @param {string} params.servicesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.versionsId Part of `name`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2625,11 +2680,16 @@ export namespace appengine_v1beta5 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1. - * @param {string} params.servicesId Part of `name`. See documentation of `appsId`. - * @param {string} params.versionsId Part of `name`. See documentation of `appsId`. - * @param {string=} params.view Controls the set of fields returned in the Get response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: apps/myapp/services/default/versions/v1. + * @param {string} params.servicesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.versionsId Part of `name`. See documentation of + * `appsId`. + * @param {string=} params.view Controls the set of fields returned in the + * Get response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2692,12 +2752,17 @@ export namespace appengine_v1beta5 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/services/default. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: apps/myapp/services/default. * @param {integer=} params.pageSize Maximum results to return per page. - * @param {string=} params.pageToken Continuation token for fetching the next page of results. - * @param {string} params.servicesId Part of `name`. See documentation of `appsId`. - * @param {string=} params.view Controls the set of fields returned in the List response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pageToken Continuation token for fetching the + * next page of results. + * @param {string} params.servicesId Part of `name`. See documentation of + * `appsId`. + * @param {string=} params.view Controls the set of fields returned in the + * List response. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2779,12 +2844,17 @@ export namespace appengine_v1beta5 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1. - * @param {string=} params.mask Standard field mask for the set of fields to be updated. - * @param {string} params.servicesId Part of `name`. See documentation of `appsId`. - * @param {string} params.versionsId Part of `name`. See documentation of `appsId`. + * @param {string} params.appsId Part of `name`. Name of the resource to + * update. Example: apps/myapp/services/default/versions/1. + * @param {string=} params.mask Standard field mask for the set of fields to + * be updated. + * @param {string} params.servicesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.versionsId Part of `name`. See documentation of + * `appsId`. * @param {().Version} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2992,12 +3062,18 @@ export namespace appengine_v1beta5 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1. - * @param {string} params.instancesId Part of `name`. See documentation of `appsId`. - * @param {string} params.servicesId Part of `name`. See documentation of `appsId`. - * @param {string} params.versionsId Part of `name`. See documentation of `appsId`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: + * apps/myapp/services/default/versions/v1/instances/instance-1. + * @param {string} params.instancesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.servicesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.versionsId Part of `name`. See documentation of + * `appsId`. * @param {().DebugInstanceRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3066,11 +3142,17 @@ export namespace appengine_v1beta5 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. For example: "apps/myapp/services/default/versions/v1/instances/instance-1". - * @param {string} params.instancesId Part of `name`. See documentation of `appsId`. - * @param {string} params.servicesId Part of `name`. See documentation of `appsId`. - * @param {string} params.versionsId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. For example: + * "apps/myapp/services/default/versions/v1/instances/instance-1". + * @param {string} params.instancesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.servicesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.versionsId Part of `name`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3139,11 +3221,17 @@ export namespace appengine_v1beta5 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1. - * @param {string} params.instancesId Part of `name`. See documentation of `appsId`. - * @param {string} params.servicesId Part of `name`. See documentation of `appsId`. - * @param {string} params.versionsId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: + * apps/myapp/services/default/versions/v1/instances/instance-1. + * @param {string} params.instancesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.servicesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.versionsId Part of `name`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3208,12 +3296,17 @@ export namespace appengine_v1beta5 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1. + * @param {string} params.appsId Part of `name`. Name of the resource + * requested. Example: apps/myapp/services/default/versions/v1. * @param {integer=} params.pageSize Maximum results to return per page. - * @param {string=} params.pageToken Continuation token for fetching the next page of results. - * @param {string} params.servicesId Part of `name`. See documentation of `appsId`. - * @param {string} params.versionsId Part of `name`. See documentation of `appsId`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pageToken Continuation token for fetching the + * next page of results. + * @param {string} params.servicesId Part of `name`. See documentation of + * `appsId`. + * @param {string} params.versionsId Part of `name`. See documentation of + * `appsId`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/appsactivity/v1.ts b/src/apis/appsactivity/v1.ts index 5fd138ef676..03cef0768be 100644 --- a/src/apis/appsactivity/v1.ts +++ b/src/apis/appsactivity/v1.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -31,7 +30,7 @@ export namespace appsactivity_v1 { } /** - * G Suite Activity API + * Drive Activity API * * Provides a historical view of activity. * @@ -315,14 +314,25 @@ export namespace appsactivity_v1 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {string=} params.drive.ancestorId Identifies the Drive folder containing the items for which to return activities. - * @param {string=} params.drive.fileId Identifies the Drive item to return activities for. - * @param {string=} params.groupingStrategy Indicates the strategy to use when grouping singleEvents items in the associated combinedEvent object. - * @param {integer=} params.pageSize The maximum number of events to return on a page. The response includes a continuation token if there are more events. - * @param {string=} params.pageToken A token to retrieve a specific page of results. - * @param {string=} params.source The Google service from which to return activities. Possible values of source are: - drive.google.com - * @param {string=} params.userId Indicates the user to return activity for. Use the special value me to indicate the currently authenticated user. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.drive.ancestorId Identifies the Drive folder + * containing the items for which to return activities. + * @param {string=} params.drive.fileId Identifies the Drive item to return + * activities for. + * @param {string=} params.groupingStrategy Indicates the strategy to use + * when grouping singleEvents items in the associated combinedEvent + * object. + * @param {integer=} params.pageSize The maximum number of events to return + * on a page. The response includes a continuation token if there are + * more events. + * @param {string=} params.pageToken A token to retrieve a specific page of + * results. + * @param {string=} params.source The Google service from which to return + * activities. Possible values of source are: - drive.google.com + * @param {string=} params.userId Indicates the user to return activity for. + * Use the special value me to indicate the currently authenticated + * user. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/appstate/v1.ts b/src/apis/appstate/v1.ts index 54370c01629..8d42258bcd1 100644 --- a/src/apis/appstate/v1.ts +++ b/src/apis/appstate/v1.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -160,9 +159,11 @@ export namespace appstate_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.currentDataVersion The version of the data to be cleared. Version strings are returned by the server. + * @param {string=} params.currentDataVersion The version of the data to be + * cleared. Version strings are returned by the server. * @param {integer} params.stateKey The key for the data to be retrieved. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -231,7 +232,8 @@ export namespace appstate_v1 { * * @param {object} params Parameters for request * @param {integer} params.stateKey The key for the data to be retrieved. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -295,7 +297,8 @@ export namespace appstate_v1 { * * @param {object} params Parameters for request * @param {integer} params.stateKey The key for the data to be retrieved. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -356,8 +359,10 @@ export namespace appstate_v1 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {boolean=} params.includeData Whether to include the full data in addition to the version number - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {boolean=} params.includeData Whether to include the full data in + * addition to the version number + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -423,10 +428,15 @@ export namespace appstate_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.currentStateVersion The version of the app state your application is attempting to update. If this does not match the current version, this method will return a conflict error. If there is no data stored on the server for this key, the update will succeed irrespective of the value of this parameter. + * @param {string=} params.currentStateVersion The version of the app state + * your application is attempting to update. If this does not match the + * current version, this method will return a conflict error. If there + * is no data stored on the server for this key, the update will succeed + * irrespective of the value of this parameter. * @param {integer} params.stateKey The key for the data to be retrieved. * @param {().UpdateRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/bigquery/v2.ts b/src/apis/bigquery/v2.ts index c11542ac058..917810a5f58 100644 --- a/src/apis/bigquery/v2.ts +++ b/src/apis/bigquery/v2.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -73,6 +72,20 @@ export namespace bigquery_v2 { } } + export interface Schema$BigQueryModelTraining { + /** + * [Output-only, Beta] Index of current ML training iteration. Updated + * during create model query job to show job progress. + */ + currentIteration?: number; + /** + * [Output-only, Beta] Expected number of iterations for the create model + * query job specified as num_iterations in the input query. The actual + * total number of iterations may be less than this number due to early + * stop. + */ + expectedTotalIterations?: string; + } export interface Schema$BigtableColumn { /** * [Optional] The encoding of the values when the type is not STRING. @@ -185,9 +198,10 @@ export namespace bigquery_v2 { export interface Schema$Clustering { /** * [Repeated] One or more fields on which data should be clustered. Only - * top-level, non-repeated, simple-type fields are supported. The order of - * the fields will determine how clusters will be generated, so it is - * important. + * top-level, non-repeated, simple-type fields are supported. When you + * cluster a table using multiple columns, the order of columns you specify + * is important. The order of the specified columns determines the sort + * order of the data. */ fields?: string[]; } @@ -313,7 +327,8 @@ export namespace bigquery_v2 { /** * The labels associated with this dataset. You can use these to organize * and group your datasets. You can set this property when inserting or - * updating a dataset. See Labeling Datasets for more information. + * updating a dataset. See Creating and Updating Dataset Labels for more + * information. */ labels?: any; /** @@ -581,9 +596,10 @@ export namespace bigquery_v2 { /** * [Optional] The maximum number of bad records that BigQuery can ignore * when reading data. If the number of bad records exceeds this value, an - * invalid error is returned in the job result. The default value is 0, - * which requires that all records are valid. This setting is ignored for - * Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats. + * invalid error is returned in the job result. This is only valid for CSV, + * JSON, and Google Sheets. The default value is 0, which requires that all + * records are valid. This setting is ignored for Google Cloud Bigtable, + * Google Cloud Datastore backups and Avro formats. */ maxBadRecords?: number; /** @@ -692,7 +708,7 @@ export namespace bigquery_v2 { } export interface Schema$GoogleSheetsOptions { /** - * [Experimental] [Optional] Range of a sheet to query from. Only used when + * [Beta] [Optional] Range of a sheet to query from. Only used when * non-empty. Typical format: !: */ range?: string; @@ -890,9 +906,9 @@ export namespace bigquery_v2 { */ autodetect?: boolean; /** - * [Experimental] Clustering specification for the destination table. Must - * be specified with time-based partitioning, data in the table will be - * first partitioned and subsequently clustered. + * [Beta] Clustering specification for the destination table. Must be + * specified with time-based partitioning, data in the table will be first + * partitioned and subsequently clustered. */ clustering?: Schema$Clustering; /** @@ -913,8 +929,8 @@ export namespace bigquery_v2 { */ destinationTable?: Schema$TableReference; /** - * [Experimental] [Optional] Properties with which to create the destination - * table if it is new. + * [Beta] [Optional] Properties with which to create the destination table + * if it is new. */ destinationTableProperties?: Schema$DestinationTableProperties; /** @@ -947,8 +963,9 @@ export namespace bigquery_v2 { /** * [Optional] The maximum number of bad records that BigQuery can ignore * when running the job. If the number of bad records exceeds this value, an - * invalid error is returned in the job result. The default value is 0, - * which requires that all records are valid. + * invalid error is returned in the job result. This is only valid for CSV + * and JSON. The default value is 0, which requires that all records are + * valid. */ maxBadRecords?: number; /** @@ -1064,9 +1081,9 @@ export namespace bigquery_v2 { */ allowLargeResults?: boolean; /** - * [Experimental] Clustering specification for the destination table. Must - * be specified with time-based partitioning, data in the table will be - * first partitioned and subsequently clustered. + * [Beta] Clustering specification for the destination table. Must be + * specified with time-based partitioning, data in the table will be first + * partitioned and subsequently clustered. */ clustering?: Schema$Clustering; /** @@ -1260,8 +1277,8 @@ export namespace bigquery_v2 { */ jobId?: string; /** - * [Experimental] The geographic location of the job. Required except for US - * and EU. See details at + * The geographic location of the job. Required except for US and EU. See + * details at * https://cloud.google.com/bigquery/docs/dataset-locations#specifying_your_location. */ location?: string; @@ -1272,7 +1289,7 @@ export namespace bigquery_v2 { } export interface Schema$JobStatistics { /** - * [Experimental] [Output-only] Job progress (0.0 -> 1.0) for LOAD and + * [TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and * EXTRACT jobs. */ completionRatio?: number; @@ -1298,6 +1315,10 @@ export namespace bigquery_v2 { * [Output-only] Statistics for a query job. */ query?: Schema$JobStatistics2; + /** + * [Output-only] Quotas which delayed this job's start time. + */ + quotaDeferments?: string[]; /** * [Output-only] Start time of this job, in milliseconds since the epoch. * This field will be present when the job transitions from the PENDING @@ -1320,20 +1341,20 @@ export namespace bigquery_v2 { */ cacheHit?: boolean; /** - * [Output-only, Experimental] The DDL operation performed, possibly - * dependent on the pre-existence of the DDL target. Possible values (new - * values might be added in the future): "CREATE": The query - * created the DDL target. "SKIP": No-op. Example cases: the query - * is CREATE TABLE IF NOT EXISTS while the table already exists, or the - * query is DROP TABLE IF EXISTS while the table does not exist. - * "REPLACE": The query replaced the DDL target. Example case: the - * query is CREATE OR REPLACE TABLE, and the table already exists. - * "DROP": The query deleted the DDL target. + * [Output-only, Beta] The DDL operation performed, possibly dependent on + * the pre-existence of the DDL target. Possible values (new values might be + * added in the future): "CREATE": The query created the DDL + * target. "SKIP": No-op. Example cases: the query is CREATE TABLE + * IF NOT EXISTS while the table already exists, or the query is DROP TABLE + * IF EXISTS while the table does not exist. "REPLACE": The query + * replaced the DDL target. Example case: the query is CREATE OR REPLACE + * TABLE, and the table already exists. "DROP": The query deleted + * the DDL target. */ ddlOperationPerformed?: string; /** - * [Output-only, Experimental] The DDL target table. Present only for - * CREATE/DROP TABLE/VIEW queries. + * [Output-only, Beta] The DDL target table. Present only for CREATE/DROP + * TABLE/VIEW queries. */ ddlTargetTable?: Schema$TableReference; /** @@ -1341,15 +1362,15 @@ export namespace bigquery_v2 { */ estimatedBytesProcessed?: string; /** - * [Output-only, Beta] Index of current ML training iteration. Updated - * during create model query job to show job progress. + * [Output-only, Beta] Information about create model query job progress. + */ + modelTraining?: Schema$BigQueryModelTraining; + /** + * [Output-only, Beta] Deprecated; do not use. */ modelTrainingCurrentIteration?: number; /** - * [Output-only, Beta] Expected number of iterations for the create model - * query job specified as num_iterations in the input query. The actual - * total number of iterations may be less than this number due to early - * stop. + * [Output-only, Beta] Deprecated; do not use. */ modelTrainingExpectedTotalIteration?: string; /** @@ -1376,9 +1397,9 @@ export namespace bigquery_v2 { */ schema?: Schema$TableSchema; /** - * [Output-only, Experimental] The type of query statement, if valid. - * Possible values (new values might be added in the future): - * "SELECT": SELECT query. "INSERT": INSERT query; see + * [Output-only, Beta] The type of query statement, if valid. Possible + * values (new values might be added in the future): "SELECT": + * SELECT query. "INSERT": INSERT query; see * https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language * "UPDATE": UPDATE query; see * https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language @@ -1394,7 +1415,7 @@ export namespace bigquery_v2 { */ statementType?: string; /** - * [Output-only] [Experimental] Describes a timeline of job execution. + * [Output-only] [Beta] Describes a timeline of job execution. */ timeline?: Schema$QueryTimelineSample[]; /** @@ -1415,7 +1436,7 @@ export namespace bigquery_v2 { */ totalSlotMs?: string; /** - * [Output-only, Experimental] Standard SQL only: list of undeclared query + * [Output-only, Beta] Standard SQL only: list of undeclared query * parameters detected during a dry run validation. */ undeclaredQueryParameters?: Schema$QueryParameter[]; @@ -1587,8 +1608,8 @@ export namespace bigquery_v2 { */ kind?: string; /** - * [Experimental] The geographic location where the job should run. Required - * except for US and EU. + * The geographic location where the job should run. Required except for US + * and EU. */ location?: string; /** @@ -1751,9 +1772,9 @@ export namespace bigquery_v2 { } export interface Schema$Table { /** - * [Experimental] Clustering specification for the table. Must be specified - * with time-based partitioning, data in the table will be first partitioned - * and subsequently clustered. + * [Beta] Clustering specification for the table. Must be specified with + * time-based partitioning, data in the table will be first partitioned and + * subsequently clustered. */ clustering?: Schema$Clustering; /** @@ -1770,7 +1791,10 @@ export namespace bigquery_v2 { */ encryptionConfiguration?: Schema$EncryptionConfiguration; /** - * [Output-only] A hash of this resource. + * [Output-only] A hash of the table metadata. Used to ensure there were no + * concurrent modifications to the resource when attempting an update. Not + * guaranteed to change when the table contents or the fields numRows, + * numBytes, numLongTermBytes or lastModifiedTime change. */ etag?: string; /** @@ -2031,16 +2055,16 @@ export namespace bigquery_v2 { */ expirationMs?: string; /** - * [Experimental] [Optional] If not set, the table is partitioned by pseudo - * column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, - * or '_PARTITIONDATE' as DATE type. If field is specified, the - * table is instead partitioned by this field. The field must be a top-level + * [Beta] [Optional] If not set, the table is partitioned by pseudo column, + * referenced via either '_PARTITIONTIME' as TIMESTAMP type, or + * '_PARTITIONDATE' as DATE type. If field is specified, the table + * is instead partitioned by this field. The field must be a top-level * TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. */ field?: string; /** - * [Experimental] [Optional] If set to true, queries over this table require - * a partition filter that can be used for partition elimination to be + * [Beta] [Optional] If set to true, queries over this table require a + * partition filter that can be used for partition elimination to be * specified. */ requirePartitionFilter?: boolean; @@ -2185,9 +2209,12 @@ export namespace bigquery_v2 { * * @param {object} params Parameters for request * @param {string} params.datasetId Dataset ID of dataset being deleted - * @param {boolean=} params.deleteContents If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False + * @param {boolean=} params.deleteContents If True, delete all the tables in + * the dataset. If False and the dataset contains tables, the request + * will fail. Default is False * @param {string} params.projectId Project ID of the dataset being deleted - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2308,7 +2335,8 @@ export namespace bigquery_v2 { * @param {object} params Parameters for request * @param {string} params.datasetId Dataset ID of the requested dataset * @param {string} params.projectId Project ID of the requested dataset - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2428,7 +2456,8 @@ export namespace bigquery_v2 { * @param {object} params Parameters for request * @param {string} params.projectId Project ID of the new dataset * @param {().Dataset} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2558,12 +2587,20 @@ export namespace bigquery_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.all Whether to list all datasets, including hidden ones - * @param {string=} params.filter An expression for filtering the results of the request by label. The syntax is "labels.[:]". Multiple filters can be ANDed together by connecting with a space. Example: "labels.department:receiving labels.active". See Filtering datasets using labels for details. - * @param {integer=} params.maxResults The maximum number of results to return - * @param {string=} params.pageToken Page token, returned by a previous call, to request the next page of results + * @param {boolean=} params.all Whether to list all datasets, including + * hidden ones + * @param {string=} params.filter An expression for filtering the results of + * the request by label. The syntax is "labels.[:]". + * Multiple filters can be ANDed together by connecting with a space. + * Example: "labels.department:receiving labels.active". See Filtering + * datasets using labels for details. + * @param {integer=} params.maxResults The maximum number of results to + * return + * @param {string=} params.pageToken Page token, returned by a previous + * call, to request the next page of results * @param {string} params.projectId Project ID of the datasets to be listed - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2695,7 +2732,8 @@ export namespace bigquery_v2 { * @param {string} params.datasetId Dataset ID of the dataset being updated * @param {string} params.projectId Project ID of the dataset being updated * @param {().Dataset} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2826,7 +2864,8 @@ export namespace bigquery_v2 { * @param {string} params.datasetId Dataset ID of the dataset being updated * @param {string} params.projectId Project ID of the dataset being updated * @param {().Dataset} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3087,9 +3126,13 @@ export namespace bigquery_v2 { * * @param {object} params Parameters for request * @param {string} params.jobId [Required] Job ID of the job to cancel - * @param {string=} params.location [Experimental] The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/dataset-locations#specifying_your_location. - * @param {string} params.projectId [Required] Project ID of the job to cancel - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.location [Experimental] The geographic location + * of the job. Required except for US and EU. See details at + * https://cloud.google.com/bigquery/docs/dataset-locations#specifying_your_location. + * @param {string} params.projectId [Required] Project ID of the job to + * cancel + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3213,9 +3256,13 @@ export namespace bigquery_v2 { * * @param {object} params Parameters for request * @param {string} params.jobId [Required] Job ID of the requested job - * @param {string=} params.location [Experimental] The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/dataset-locations#specifying_your_location. - * @param {string} params.projectId [Required] Project ID of the requested job - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.location [Experimental] The geographic location + * of the job. Required except for US and EU. See details at + * https://cloud.google.com/bigquery/docs/dataset-locations#specifying_your_location. + * @param {string} params.projectId [Required] Project ID of the requested + * job + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3345,13 +3392,21 @@ export namespace bigquery_v2 { * * @param {object} params Parameters for request * @param {string} params.jobId [Required] Job ID of the query job - * @param {string=} params.location [Experimental] The geographic location where the job should run. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/dataset-locations#specifying_your_location. + * @param {string=} params.location [Experimental] The geographic location + * where the job should run. Required except for US and EU. See details + * at + * https://cloud.google.com/bigquery/docs/dataset-locations#specifying_your_location. * @param {integer=} params.maxResults Maximum number of results to read - * @param {string=} params.pageToken Page token, returned by a previous call, to request the next page of results + * @param {string=} params.pageToken Page token, returned by a previous + * call, to request the next page of results * @param {string} params.projectId [Required] Project ID of the query job * @param {string=} params.startIndex Zero-based index of the starting row - * @param {integer=} params.timeoutMs How long to wait for the query to complete, in milliseconds, before returning. Default is 10 seconds. If the timeout passes before the job completes, the 'jobComplete' field in the response will be false - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.timeoutMs How long to wait for the query to + * complete, in milliseconds, before returning. Default is 10 seconds. + * If the timeout passes before the job completes, the 'jobComplete' + * field in the response will be false + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3484,12 +3539,14 @@ export namespace bigquery_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.projectId Project ID of the project that will be billed for the job + * @param {string} params.projectId Project ID of the project that will be + * billed for the job * @param {object} params.resource Media resource metadata * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type * @param {string|object} params.media.body Media body contents - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3624,15 +3681,23 @@ export namespace bigquery_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.allUsers Whether to display jobs owned by all users in the project. Default false - * @param {string=} params.maxCreationTime Max value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created before or at this timestamp are returned + * @param {boolean=} params.allUsers Whether to display jobs owned by all + * users in the project. Default false + * @param {string=} params.maxCreationTime Max value for job creation time, + * in milliseconds since the POSIX epoch. If set, only jobs created + * before or at this timestamp are returned * @param {integer=} params.maxResults Maximum number of results to return - * @param {string=} params.minCreationTime Min value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created after or at this timestamp are returned - * @param {string=} params.pageToken Page token, returned by a previous call, to request the next page of results + * @param {string=} params.minCreationTime Min value for job creation time, + * in milliseconds since the POSIX epoch. If set, only jobs created + * after or at this timestamp are returned + * @param {string=} params.pageToken Page token, returned by a previous + * call, to request the next page of results * @param {string} params.projectId Project ID of the jobs to list - * @param {string=} params.projection Restrict information returned to a set of selected fields + * @param {string=} params.projection Restrict information returned to a set + * of selected fields * @param {string=} params.stateFilter Filter for job state - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3753,9 +3818,11 @@ export namespace bigquery_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.projectId Project ID of the project billed for the query + * @param {string} params.projectId Project ID of the project billed for the + * query * @param {().QueryRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4058,8 +4125,10 @@ export namespace bigquery_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.projectId Project ID for which the service account is requested. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.projectId Project ID for which the service account + * is requested. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4194,8 +4263,10 @@ export namespace bigquery_v2 { * * @param {object=} params Parameters for request * @param {integer=} params.maxResults Maximum number of results to return - * @param {string=} params.pageToken Page token, returned by a previous call, to request the next page of results - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pageToken Page token, returned by a previous + * call, to request the next page of results + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4368,7 +4439,8 @@ export namespace bigquery_v2 { * @param {string} params.projectId Project ID of the destination table. * @param {string} params.tableId Table ID of the destination table. * @param {().TableDataInsertAllRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4517,12 +4589,16 @@ export namespace bigquery_v2 { * @param {object} params Parameters for request * @param {string} params.datasetId Dataset ID of the table to read * @param {integer=} params.maxResults Maximum number of results to return - * @param {string=} params.pageToken Page token, returned by a previous call, identifying the result set + * @param {string=} params.pageToken Page token, returned by a previous + * call, identifying the result set * @param {string} params.projectId Project ID of the table to read - * @param {string=} params.selectedFields List of fields to return (comma-separated). If unspecified, all fields are returned - * @param {string=} params.startIndex Zero-based index of the starting row to read + * @param {string=} params.selectedFields List of fields to return + * (comma-separated). If unspecified, all fields are returned + * @param {string=} params.startIndex Zero-based index of the starting row + * to read * @param {string} params.tableId Table ID of the table to read - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4722,7 +4798,8 @@ export namespace bigquery_v2 { * @param {string} params.datasetId Dataset ID of the table to delete * @param {string} params.projectId Project ID of the table to delete * @param {string} params.tableId Table ID of the table to delete - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4849,9 +4926,11 @@ export namespace bigquery_v2 { * @param {object} params Parameters for request * @param {string} params.datasetId Dataset ID of the requested table * @param {string} params.projectId Project ID of the requested table - * @param {string=} params.selectedFields List of fields to return (comma-separated). If unspecified, all fields are returned + * @param {string=} params.selectedFields List of fields to return + * (comma-separated). If unspecified, all fields are returned * @param {string} params.tableId Table ID of the requested table - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4976,7 +5055,8 @@ export namespace bigquery_v2 { * @param {string} params.datasetId Dataset ID of the new table * @param {string} params.projectId Project ID of the new table * @param {().Table} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5113,9 +5193,11 @@ export namespace bigquery_v2 { * @param {object} params Parameters for request * @param {string} params.datasetId Dataset ID of the tables to list * @param {integer=} params.maxResults Maximum number of results to return - * @param {string=} params.pageToken Page token, returned by a previous call, to request the next page of results + * @param {string=} params.pageToken Page token, returned by a previous + * call, to request the next page of results * @param {string} params.projectId Project ID of the tables to list - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5253,7 +5335,8 @@ export namespace bigquery_v2 { * @param {string} params.projectId Project ID of the table to update * @param {string} params.tableId Table ID of the table to update * @param {().Table} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5389,7 +5472,8 @@ export namespace bigquery_v2 { * @param {string} params.projectId Project ID of the table to update * @param {string} params.tableId Table ID of the table to update * @param {().Table} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/bigquerydatatransfer/v1.ts b/src/apis/bigquerydatatransfer/v1.ts index f5fb95e0166..043b3cfe9dc 100644 --- a/src/apis/bigquerydatatransfer/v1.ts +++ b/src/apis/bigquerydatatransfer/v1.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -642,9 +641,11 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` + * @param {string} params.name The data source in the form: + * `projects/{project_id}/dataSources/{data_source_id}` * @param {().CheckValidCredsRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -714,8 +715,11 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}` - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.name The field will contain name of the resource + * requested, for example: + * `projects/{project_id}/dataSources/{data_source_id}` + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -778,10 +782,18 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results. - * @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListDataSourcesRequest` list results. For multiple-page results, `ListDataSourcesResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. - * @param {string} params.parent The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.pageSize Page size. The default page size is the + * maximum value of 1000 results. + * @param {string=} params.pageToken Pagination token, which can be used to + * request a specific page of `ListDataSourcesRequest` list results. For + * multiple-page results, `ListDataSourcesResponse` outputs a + * `next_page` token, which can be used as the `page_token` value to + * request the next page of list results. + * @param {string} params.parent The BigQuery project id for which data + * sources should be returned. Must be in the form: + * `projects/{project_id}` + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -921,7 +933,8 @@ export namespace bigquerydatatransfer_v1 { * * @param {object} params Parameters for request * @param {string} params.name Resource name for the location. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -983,10 +996,12 @@ export namespace bigquerydatatransfer_v1 { * * @param {object} params Parameters for request * @param {string=} params.filter The standard list filter. - * @param {string} params.name The resource that owns the locations collection, if applicable. + * @param {string} params.name The resource that owns the locations + * collection, if applicable. * @param {integer=} params.pageSize The standard list page size. * @param {string=} params.pageToken The standard list page token. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1106,9 +1121,11 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` + * @param {string} params.name The data source in the form: + * `projects/{project_id}/dataSources/{data_source_id}` * @param {().CheckValidCredsRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1180,8 +1197,11 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}` - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.name The field will contain name of the resource + * requested, for example: + * `projects/{project_id}/dataSources/{data_source_id}` + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1244,10 +1264,18 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results. - * @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListDataSourcesRequest` list results. For multiple-page results, `ListDataSourcesResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. - * @param {string} params.parent The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.pageSize Page size. The default page size is the + * maximum value of 1000 results. + * @param {string=} params.pageToken Pagination token, which can be used to + * request a specific page of `ListDataSourcesRequest` list results. For + * multiple-page results, `ListDataSourcesResponse` outputs a + * `next_page` token, which can be used as the `page_token` value to + * request the next page of list results. + * @param {string} params.parent The BigQuery project id for which data + * sources should be returned. Must be in the form: + * `projects/{project_id}` + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1383,10 +1411,29 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.authorizationCode Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. - * @param {string} params.parent The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} If specified location and location of the destination bigquery dataset do not match - the request will fail. + * @param {string=} params.authorizationCode Optional OAuth2 authorization + * code to use with this transfer configuration. This is required if new + * credentials are needed, as indicated by `CheckValidCreds`. In order + * to obtain authorization_code, please make a request to + * https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= + * * client_id should be OAuth client_id of BigQuery DTS API for the + * given data source returned by ListDataSources method. * + * data_source_scopes are the scopes returned by ListDataSources method. + * * redirect_uri is an optional parameter. If not specified, then + * authorization code is posted to the opener of authorization flow + * window. Otherwise it will be sent to the redirect uri. A special + * value of urn:ietf:wg:oauth:2.0:oob means that authorization code + * should be returned in the title bar of the browser, with the page + * text prompting the user to copy the code and paste it in the + * application. + * @param {string} params.parent The BigQuery project id where the transfer + * configuration should be created. Must be in the format + * projects/{project_id}/locations/{location_id} If specified location + * and location of the destination bigquery dataset do not match - the + * request will fail. * @param {().TransferConfig} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1456,8 +1503,11 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.name The field will contain name of the resource + * requested, for example: + * `projects/{project_id}/transferConfigs/{config_id}` + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1524,8 +1574,11 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.name The field will contain name of the resource + * requested, for example: + * `projects/{project_id}/transferConfigs/{config_id}` + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1588,11 +1641,19 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.dataSourceIds When specified, only configurations of requested data sources are returned. - * @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results. - * @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListTransfersRequest` list results. For multiple-page results, `ListTransfersResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. - * @param {string} params.parent The BigQuery project id for which data sources should be returned: `projects/{project_id}`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.dataSourceIds When specified, only configurations + * of requested data sources are returned. + * @param {integer=} params.pageSize Page size. The default page size is the + * maximum value of 1000 results. + * @param {string=} params.pageToken Pagination token, which can be used to + * request a specific page of `ListTransfersRequest` list results. For + * multiple-page results, `ListTransfersResponse` outputs a `next_page` + * token, which can be used as the `page_token` value to request the + * next page of list results. + * @param {string} params.parent The BigQuery project id for which data + * sources should be returned: `projects/{project_id}`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1667,11 +1728,31 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.authorizationCode Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. - * @param {string} params.name The resource name of the transfer config. Transfer config names have the form `projects/{project_id}/transferConfigs/{config_id}`. Where `config_id` is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config. - * @param {string=} params.updateMask Required list of fields to be updated in this request. + * @param {string=} params.authorizationCode Optional OAuth2 authorization + * code to use with this transfer configuration. If it is provided, the + * transfer configuration will be associated with the authorizing user. + * In order to obtain authorization_code, please make a request to + * https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= + * * client_id should be OAuth client_id of BigQuery DTS API for the + * given data source returned by ListDataSources method. * + * data_source_scopes are the scopes returned by ListDataSources method. + * * redirect_uri is an optional parameter. If not specified, then + * authorization code is posted to the opener of authorization flow + * window. Otherwise it will be sent to the redirect uri. A special + * value of urn:ietf:wg:oauth:2.0:oob means that authorization code + * should be returned in the title bar of the browser, with the page + * text prompting the user to copy the code and paste it in the + * application. + * @param {string} params.name The resource name of the transfer config. + * Transfer config names have the form + * `projects/{project_id}/transferConfigs/{config_id}`. Where + * `config_id` is usually a uuid, even though it is not guaranteed or + * required. The name is ignored when creating a transfer config. + * @param {string=} params.updateMask Required list of fields to be updated + * in this request. * @param {().TransferConfig} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1742,9 +1823,11 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`. + * @param {string} params.parent Transfer configuration name in the form: + * `projects/{project_id}/transferConfigs/{config_id}`. * @param {().ScheduleTransferRunsRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1986,8 +2069,11 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.name The field will contain name of the resource + * requested, for example: + * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2054,8 +2140,11 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.name The field will contain name of the resource + * requested, for example: + * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2119,12 +2208,23 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results. - * @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. - * @param {string} params.parent Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}`. - * @param {string=} params.runAttempt Indicates how run attempts are to be pulled. - * @param {string=} params.states When specified, only transfer runs with requested states are returned. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.pageSize Page size. The default page size is the + * maximum value of 1000 results. + * @param {string=} params.pageToken Pagination token, which can be used to + * request a specific page of `ListTransferRunsRequest` list results. + * For multiple-page results, `ListTransferRunsResponse` outputs a + * `next_page` token, which can be used as the `page_token` value to + * request the next page of list results. + * @param {string} params.parent Name of transfer configuration for which + * transfer runs should be retrieved. Format of transfer configuration + * resource name is: + * `projects/{project_id}/transferConfigs/{config_id}`. + * @param {string=} params.runAttempt Indicates how run attempts are to be + * pulled. + * @param {string=} params.states When specified, only transfer runs with + * requested states are returned. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2264,11 +2364,19 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.messageTypes Message types to return. If not populated - INFO, WARNING and ERROR messages are returned. - * @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results. - * @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListTransferLogsRequest` list results. For multiple-page results, `ListTransferLogsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. - * @param {string} params.parent Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.messageTypes Message types to return. If not + * populated - INFO, WARNING and ERROR messages are returned. + * @param {integer=} params.pageSize Page size. The default page size is the + * maximum value of 1000 results. + * @param {string=} params.pageToken Pagination token, which can be used to + * request a specific page of `ListTransferLogsRequest` list results. + * For multiple-page results, `ListTransferLogsResponse` outputs a + * `next_page` token, which can be used as the `page_token` value to + * request the next page of list results. + * @param {string} params.parent Transfer run name in the form: + * `projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2386,10 +2494,29 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.authorizationCode Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. - * @param {string} params.parent The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} If specified location and location of the destination bigquery dataset do not match - the request will fail. + * @param {string=} params.authorizationCode Optional OAuth2 authorization + * code to use with this transfer configuration. This is required if new + * credentials are needed, as indicated by `CheckValidCreds`. In order + * to obtain authorization_code, please make a request to + * https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= + * * client_id should be OAuth client_id of BigQuery DTS API for the + * given data source returned by ListDataSources method. * + * data_source_scopes are the scopes returned by ListDataSources method. + * * redirect_uri is an optional parameter. If not specified, then + * authorization code is posted to the opener of authorization flow + * window. Otherwise it will be sent to the redirect uri. A special + * value of urn:ietf:wg:oauth:2.0:oob means that authorization code + * should be returned in the title bar of the browser, with the page + * text prompting the user to copy the code and paste it in the + * application. + * @param {string} params.parent The BigQuery project id where the transfer + * configuration should be created. Must be in the format + * projects/{project_id}/locations/{location_id} If specified location + * and location of the destination bigquery dataset do not match - the + * request will fail. * @param {().TransferConfig} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2457,8 +2584,11 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.name The field will contain name of the resource + * requested, for example: + * `projects/{project_id}/transferConfigs/{config_id}` + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2523,8 +2653,11 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.name The field will contain name of the resource + * requested, for example: + * `projects/{project_id}/transferConfigs/{config_id}` + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2586,11 +2719,19 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.dataSourceIds When specified, only configurations of requested data sources are returned. - * @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results. - * @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListTransfersRequest` list results. For multiple-page results, `ListTransfersResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. - * @param {string} params.parent The BigQuery project id for which data sources should be returned: `projects/{project_id}`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.dataSourceIds When specified, only configurations + * of requested data sources are returned. + * @param {integer=} params.pageSize Page size. The default page size is the + * maximum value of 1000 results. + * @param {string=} params.pageToken Pagination token, which can be used to + * request a specific page of `ListTransfersRequest` list results. For + * multiple-page results, `ListTransfersResponse` outputs a `next_page` + * token, which can be used as the `page_token` value to request the + * next page of list results. + * @param {string} params.parent The BigQuery project id for which data + * sources should be returned: `projects/{project_id}`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2664,11 +2805,31 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.authorizationCode Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. - * @param {string} params.name The resource name of the transfer config. Transfer config names have the form `projects/{project_id}/transferConfigs/{config_id}`. Where `config_id` is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config. - * @param {string=} params.updateMask Required list of fields to be updated in this request. + * @param {string=} params.authorizationCode Optional OAuth2 authorization + * code to use with this transfer configuration. If it is provided, the + * transfer configuration will be associated with the authorizing user. + * In order to obtain authorization_code, please make a request to + * https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= + * * client_id should be OAuth client_id of BigQuery DTS API for the + * given data source returned by ListDataSources method. * + * data_source_scopes are the scopes returned by ListDataSources method. + * * redirect_uri is an optional parameter. If not specified, then + * authorization code is posted to the opener of authorization flow + * window. Otherwise it will be sent to the redirect uri. A special + * value of urn:ietf:wg:oauth:2.0:oob means that authorization code + * should be returned in the title bar of the browser, with the page + * text prompting the user to copy the code and paste it in the + * application. + * @param {string} params.name The resource name of the transfer config. + * Transfer config names have the form + * `projects/{project_id}/transferConfigs/{config_id}`. Where + * `config_id` is usually a uuid, even though it is not guaranteed or + * required. The name is ignored when creating a transfer config. + * @param {string=} params.updateMask Required list of fields to be updated + * in this request. * @param {().TransferConfig} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2737,9 +2898,11 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`. + * @param {string} params.parent Transfer configuration name in the form: + * `projects/{project_id}/transferConfigs/{config_id}`. * @param {().ScheduleTransferRunsRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2977,8 +3140,11 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.name The field will contain name of the resource + * requested, for example: + * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3043,8 +3209,11 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.name The field will contain name of the resource + * requested, for example: + * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3106,12 +3275,23 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results. - * @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. - * @param {string} params.parent Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}`. - * @param {string=} params.runAttempt Indicates how run attempts are to be pulled. - * @param {string=} params.states When specified, only transfer runs with requested states are returned. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.pageSize Page size. The default page size is the + * maximum value of 1000 results. + * @param {string=} params.pageToken Pagination token, which can be used to + * request a specific page of `ListTransferRunsRequest` list results. + * For multiple-page results, `ListTransferRunsResponse` outputs a + * `next_page` token, which can be used as the `page_token` value to + * request the next page of list results. + * @param {string} params.parent Name of transfer configuration for which + * transfer runs should be retrieved. Format of transfer configuration + * resource name is: + * `projects/{project_id}/transferConfigs/{config_id}`. + * @param {string=} params.runAttempt Indicates how run attempts are to be + * pulled. + * @param {string=} params.states When specified, only transfer runs with + * requested states are returned. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3249,11 +3429,19 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.messageTypes Message types to return. If not populated - INFO, WARNING and ERROR messages are returned. - * @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results. - * @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListTransferLogsRequest` list results. For multiple-page results, `ListTransferLogsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. - * @param {string} params.parent Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.messageTypes Message types to return. If not + * populated - INFO, WARNING and ERROR messages are returned. + * @param {integer=} params.pageSize Page size. The default page size is the + * maximum value of 1000 results. + * @param {string=} params.pageToken Pagination token, which can be used to + * request a specific page of `ListTransferLogsRequest` list results. + * For multiple-page results, `ListTransferLogsResponse` outputs a + * `next_page` token, which can be used as the `page_token` value to + * request the next page of list results. + * @param {string} params.parent Transfer run name in the form: + * `projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/spectrum/README.md b/src/apis/binaryauthorization/README.md similarity index 83% rename from src/apis/spectrum/README.md rename to src/apis/binaryauthorization/README.md index 1bd6eb65999..380af7c71eb 100644 --- a/src/apis/spectrum/README.md +++ b/src/apis/binaryauthorization/README.md @@ -1,13 +1,13 @@ Google Inc. logo -# @google/spectrum +# @google/binaryauthorization -> API for spectrum-management functions. +> The management interface for Binary Authorization, a system providing policy control for images deployed to Kubernetes Engine clusters. ## Installation ```sh -$ npm install @google/spectrum +$ npm install @google/binaryauthorization ``` ## Usage diff --git a/src/apis/spectrum/index.ts b/src/apis/binaryauthorization/index.ts similarity index 55% rename from src/apis/spectrum/index.ts rename to src/apis/binaryauthorization/index.ts index be0a6fc44bc..de19a8eaf46 100644 --- a/src/apis/spectrum/index.ts +++ b/src/apis/binaryauthorization/index.ts @@ -14,17 +14,20 @@ /*! THIS FILE IS AUTO-GENERATED */ import {getAPI, GoogleConfigurable} from 'googleapis-common'; -import {spectrum_v1explorer} from './v1explorer'; +import {binaryauthorization_v1beta1} from './v1beta1'; export const VERSIONS = { - 'v1explorer': spectrum_v1explorer.Spectrum, + 'v1beta1': binaryauthorization_v1beta1.Binaryauthorization, }; -export function spectrum(version: 'v1explorer'): spectrum_v1explorer.Spectrum; -export function spectrum(options: spectrum_v1explorer.Options): - spectrum_v1explorer.Spectrum; -export function spectrum( +export function binaryauthorization(version: 'v1beta1'): + binaryauthorization_v1beta1.Binaryauthorization; +export function binaryauthorization( + options: binaryauthorization_v1beta1.Options): + binaryauthorization_v1beta1.Binaryauthorization; +export function +binaryauthorization( this: GoogleConfigurable, - versionOrOptions: 'v1explorer'|spectrum_v1explorer.Options) { - return getAPI('spectrum', versionOrOptions, VERSIONS, this); + versionOrOptions: 'v1beta1'|binaryauthorization_v1beta1.Options) { + return getAPI('binaryauthorization', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/spectrum/package.json b/src/apis/binaryauthorization/package.json similarity index 86% rename from src/apis/spectrum/package.json rename to src/apis/binaryauthorization/package.json index 30dfab18da3..86157a551ea 100644 --- a/src/apis/spectrum/package.json +++ b/src/apis/binaryauthorization/package.json @@ -1,7 +1,7 @@ { - "name": "@google/spectrum", + "name": "@google/binaryauthorization", "version": "0.1.0", - "description": "spectrum", + "description": "binaryauthorization", "main": "index.js", "types": "index.d.ts", "keywords": ["google"], diff --git a/src/apis/binaryauthorization/v1beta1.ts b/src/apis/binaryauthorization/v1beta1.ts new file mode 100644 index 00000000000..5e096913059 --- /dev/null +++ b/src/apis/binaryauthorization/v1beta1.ts @@ -0,0 +1,1590 @@ +/** + * Copyright 2015 Google Inc. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import {AxiosPromise} from 'axios'; +import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; +import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace binaryauthorization_v1beta1 { + export interface Options extends GlobalOptions { + version: 'v1beta1'; + } + + /** + * Binary Authorization API + * + * The management interface for Binary Authorization, a system providing + * policy control for images deployed to Kubernetes Engine clusters. + * + * @example + * const {google} = require('googleapis'); + * const binaryauthorization = google.binaryauthorization('v1beta1'); + * + * @namespace binaryauthorization + * @type {Function} + * @version v1beta1 + * @variation v1beta1 + * @param {object=} options Options for Binaryauthorization + */ + export class Binaryauthorization { + _options: GlobalOptions; + google?: GoogleConfigurable; + root = this; + + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this._options = options || {}; + this.google = google; + this.getRoot.bind(this); + + this.projects = new Resource$Projects(this); + } + + getRoot() { + return this.root; + } + } + + /** + * An admission rule specifies either that all container images used in a pod + * creation request must be attested to by one or more attestors, that all pod + * creations will be allowed, or that all pod creations will be denied. Images + * matching an admission whitelist pattern are exempted from admission rules + * and will never block a pod creation. + */ + export interface Schema$AdmissionRule { + /** + * Required. The action when a pod creation is denied by the admission rule. + */ + enforcementMode?: string; + /** + * Required. How this admission rule will be evaluated. + */ + evaluationMode?: string; + /** + * Optional. The resource names of the attestors that must attest to a + * container image, in the format `projects/x/attestors/x. Each attestor + * must exist before a policy can reference it. To add an attestor to a + * policy the principal issuing the policy change request must be able to + * read the attestor resource. Note: this field must be non-empty when the + * evaluation_mode field specifies REQUIRE_ATTESTATION, otherwise it must be + * empty. + */ + requireAttestationsBy?: string[]; + } + /** + * An admission whitelist pattern exempts images from checks by admission + * rules. + */ + export interface Schema$AdmissionWhitelistPattern { + /** + * An image name pattern to whitelist, in the form `registry/path/to/image`. + * This supports a trailing `*` as a wildcard, but this is allowed only in + * text after the `registry/` part. + */ + namePattern?: string; + } + /** + * An attestor that attests to container image artifacts. An existing attestor + * cannot be modified except where indicated. + */ + export interface Schema$Attestor { + /** + * Optional. A descriptive comment. This field may be updated. The field + * may be displayed in chooser dialogs. + */ + description?: string; + /** + * Required. The resource name, in the format: `projects/x/attestors/x. This + * field may not be updated. + */ + name?: string; + /** + * Output only. Time when the attestor was last updated. + */ + updateTime?: string; + /** + * A Drydock ATTESTATION_AUTHORITY Note, created by the user. + */ + userOwnedDrydockNote?: Schema$UserOwnedDrydockNote; + } + /** + * An attestator public key that will be used to verify attestations signed by + * this attestor. + */ + export interface Schema$AttestorPublicKey { + /** + * ASCII-armored representation of a PGP public key, as the entire output by + * the command `gpg --export --armor foo@example.com` (either LF or CRLF + * line endings). + */ + asciiArmoredPgpPublicKey?: string; + /** + * Optional. A descriptive comment. This field may be updated. + */ + comment?: string; + /** + * Output only. This field will be overwritten with key ID information, for + * example, an identifier extracted from a PGP public key. This field may + * not be updated. + */ + id?: string; + } + /** + * Associates `members` with a `role`. + */ + export interface Schema$Binding { + /** + * Unimplemented. The condition that is associated with this binding. NOTE: + * an unsatisfied condition will not allow user access via current binding. + * Different bindings, including their conditions, are examined + * independently. + */ + condition?: Schema$Expr; + /** + * Specifies the identities requesting access for a Cloud Platform resource. + * `members` can have the following values: * `allUsers`: A special + * identifier that represents anyone who is on the internet; with or + * without a Google account. * `allAuthenticatedUsers`: A special + * identifier that represents anyone who is authenticated with a Google + * account or a service account. * `user:{emailid}`: An email address that + * represents a specific Google account. For example, `alice@gmail.com` . + * * `serviceAccount:{emailid}`: An email address that represents a service + * account. For example, `my-other-app@appspot.gserviceaccount.com`. * + * `group:{emailid}`: An email address that represents a Google group. For + * example, `admins@example.com`. * `domain:{domain}`: A Google Apps + * domain name that represents all the users of that domain. For example, + * `google.com` or `example.com`. + */ + members?: string[]; + /** + * Role that is assigned to `members`. For example, `roles/viewer`, + * `roles/editor`, or `roles/owner`. + */ + role?: string; + } + /** + * A generic empty message that you can re-use to avoid defining duplicated + * empty messages in your APIs. A typical example is to use it as the request + * or the response type of an API method. For instance: service Foo { rpc + * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON + * representation for `Empty` is empty JSON object `{}`. + */ + export interface Schema$Empty {} + /** + * Represents an expression text. Example: title: "User account + * presence" description: "Determines whether the request has a + * user account" expression: "size(request.user) > 0" + */ + export interface Schema$Expr { + /** + * An optional description of the expression. This is a longer text which + * describes the expression, e.g. when hovered over it in a UI. + */ + description?: string; + /** + * Textual representation of an expression in Common Expression Language + * syntax. The application context of the containing message determines + * which well-known feature set of CEL is supported. + */ + expression?: string; + /** + * An optional string indicating the location of the expression for error + * reporting, e.g. a file name and a position in the file. + */ + location?: string; + /** + * An optional title for the expression, i.e. a short string describing its + * purpose. This can be used e.g. in UIs which allow to enter the + * expression. + */ + title?: string; + } + /** + * Defines an Identity and Access Management (IAM) policy. It is used to + * specify access control policies for Cloud Platform resources. A `Policy` + * consists of a list of `bindings`. A `binding` binds a list of `members` to + * a `role`, where the members can be user accounts, Google groups, Google + * domains, and service accounts. A `role` is a named list of permissions + * defined by IAM. **JSON Example** { "bindings": [ { + * "role": "roles/owner", "members": [ + * "user:mike@example.com", "group:admins@example.com", + * "domain:google.com", + * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { + * "role": "roles/viewer", "members": + * ["user:sean@example.com"] } ] } **YAML + * Example** bindings: - members: - user:mike@example.com - + * group:admins@example.com - domain:google.com - + * serviceAccount:my-other-app@appspot.gserviceaccount.com role: + * roles/owner - members: - user:sean@example.com role: + * roles/viewer For a description of IAM and its features, see the [IAM + * developer's guide](https://cloud.google.com/iam/docs). + */ + export interface Schema$IamPolicy { + /** + * Associates a list of `members` to a `role`. `bindings` with no members + * will result in an error. + */ + bindings?: Schema$Binding[]; + /** + * `etag` is used for optimistic concurrency control as a way to help + * prevent simultaneous updates of a policy from overwriting each other. It + * is strongly suggested that systems make use of the `etag` in the + * read-modify-write cycle to perform policy updates in order to avoid race + * conditions: An `etag` is returned in the response to `getIamPolicy`, and + * systems are expected to put that etag in the request to `setIamPolicy` to + * ensure that their change will be applied to the same version of the + * policy. If no `etag` is provided in the call to `setIamPolicy`, then the + * existing policy is overwritten blindly. + */ + etag?: string; + /** + * Deprecated. + */ + version?: number; + } + /** + * Response message for BinauthzManagementService.ListAttestors. + */ + export interface Schema$ListAttestorsResponse { + /** + * The list of attestors. + */ + attestors?: Schema$Attestor[]; + /** + * A token to retrieve the next page of results. Pass this value in the + * ListAttestorsRequest.page_token field in the subsequent call to the + * `ListAttestors` method to retrieve the next page of results. + */ + nextPageToken?: string; + } + /** + * A policy for container image binary authorization. + */ + export interface Schema$Policy { + /** + * Optional. Admission policy whitelisting. A matching admission request + * will always be permitted. This feature is typically used to exclude + * Google or third-party infrastructure images from Binary Authorization + * policies. + */ + admissionWhitelistPatterns?: Schema$AdmissionWhitelistPattern[]; + /** + * Optional. Per-cluster admission rules. Cluster spec format: + * `location.clusterId`. There can be at most one admission rule per cluster + * spec. A `location` is either a compute zone (e.g. us-central1-a) or a + * region (e.g. us-central1). For `clusterId` syntax restrictions see + * https://cloud.google.com/container-engine/reference/rest/v1/projects.zones.clusters. + */ + clusterAdmissionRules?: any; + /** + * Required. Default admission rule for a cluster without a per-cluster + * admission rule. + */ + defaultAdmissionRule?: Schema$AdmissionRule; + /** + * Optional. A descriptive comment. + */ + description?: string; + /** + * Output only. The resource name, in the format `projects/x/policy`. There + * is at most one policy per project. + */ + name?: string; + /** + * Output only. Time when the policy was last updated. + */ + updateTime?: string; + } + /** + * Request message for `SetIamPolicy` method. + */ + export interface Schema$SetIamPolicyRequest { + /** + * REQUIRED: The complete policy to be applied to the `resource`. The size + * of the policy is limited to a few 10s of KB. An empty policy is a valid + * policy but certain Cloud Platform services (such as Projects) might + * reject them. + */ + policy?: Schema$IamPolicy; + } + /** + * Request message for `TestIamPermissions` method. + */ + export interface Schema$TestIamPermissionsRequest { + /** + * The set of permissions to check for the `resource`. Permissions with + * wildcards (such as '*' or 'storage.*') are not allowed. + * For more information see [IAM + * Overview](https://cloud.google.com/iam/docs/overview#permissions). + */ + permissions?: string[]; + } + /** + * Response message for `TestIamPermissions` method. + */ + export interface Schema$TestIamPermissionsResponse { + /** + * A subset of `TestPermissionsRequest.permissions` that the caller is + * allowed. + */ + permissions?: string[]; + } + /** + * An user owned drydock note references a Drydock ATTESTATION_AUTHORITY Note + * created by the user. + */ + export interface Schema$UserOwnedDrydockNote { + /** + * Output only. This field will contain the service account email address + * that this Attestor will use as the principal when querying Container + * Analysis. Attestor administrators must grant this service account the IAM + * role needed to read attestations from the note_reference in Container + * Analysis (`containeranalysis.notes.occurrences.viewer`). This email + * address is fixed for the lifetime of the Attestor, but callers should not + * make any other assumptions about the service account email; future + * versions may use an email based on a different naming pattern. + */ + delegationServiceAccountEmail?: string; + /** + * Required. The Drydock resource name of a ATTESTATION_AUTHORITY Note, + * created by the user, in the format: `projects/x/notes/x (or the legacy + * `providers/x/notes/x). This field may not be updated. An attestation by + * this attestor is stored as a Drydock ATTESTATION_AUTHORITY Occurrence + * that names a container image and that links to this Note. Drydock is an + * external dependency. + */ + noteReference?: string; + /** + * Optional. Public keys that verify attestations signed by this attestor. + * This field may be updated. If this field is non-empty, one of the + * specified public keys must verify that an attestation was signed by this + * attestor for the image specified in the admission request. If this field + * is empty, this attestor always returns that no valid attestations exist. + */ + publicKeys?: Schema$AttestorPublicKey[]; + } + + + export class Resource$Projects { + root: Binaryauthorization; + attestors: Resource$Projects$Attestors; + policy: Resource$Projects$Policy; + constructor(root: Binaryauthorization) { + this.root = root; + this.getRoot.bind(this); + this.attestors = new Resource$Projects$Attestors(root); + this.policy = new Resource$Projects$Policy(root); + } + + getRoot() { + return this.root; + } + + + /** + * binaryauthorization.projects.getPolicy + * @desc Gets the policy for this project. Returns a default policy if the + * project does not have one. + * @alias binaryauthorization.projects.getPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name of the policy to + * retrieve, in the format `projects/x/policy`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getPolicy( + params?: Params$Resource$Projects$Getpolicy, + options?: MethodOptions): AxiosPromise; + getPolicy( + params: Params$Resource$Projects$Getpolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + getPolicy( + params: Params$Resource$Projects$Getpolicy, + callback: BodyResponseCallback): void; + getPolicy(callback: BodyResponseCallback): void; + getPolicy( + paramsOrCallback?: Params$Resource$Projects$Getpolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Projects$Getpolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Getpolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://binaryauthorization.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * binaryauthorization.projects.updatePolicy + * @desc Creates or updates a project's policy, and returns a copy of the + * new policy. A policy is always updated as a whole, to avoid race + * conditions with concurrent policy enforcement (or management!) requests. + * Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the + * request is malformed. + * @alias binaryauthorization.projects.updatePolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Output only. The resource name, in the format + * `projects/x/policy`. There is at most one policy per project. + * @param {().Policy} params.resource Request body data + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + updatePolicy( + params?: Params$Resource$Projects$Updatepolicy, + options?: MethodOptions): AxiosPromise; + updatePolicy( + params: Params$Resource$Projects$Updatepolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + updatePolicy( + params: Params$Resource$Projects$Updatepolicy, + callback: BodyResponseCallback): void; + updatePolicy(callback: BodyResponseCallback): void; + updatePolicy( + paramsOrCallback?: Params$Resource$Projects$Updatepolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Projects$Updatepolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Updatepolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://binaryauthorization.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Getpolicy { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Required. The resource name of the policy to retrieve, in the format + * `projects/x/policy`. + */ + name?: string; + } + export interface Params$Resource$Projects$Updatepolicy { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Output only. The resource name, in the format `projects/x/policy`. There + * is at most one policy per project. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Policy; + } + + export class Resource$Projects$Attestors { + root: Binaryauthorization; + constructor(root: Binaryauthorization) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * binaryauthorization.projects.attestors.create + * @desc Creates an attestor, and returns a copy of the new attestor. + * Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the + * request is malformed, ALREADY_EXISTS if the attestor already exists. + * @alias binaryauthorization.projects.attestors.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.attestorId Required. The attestors ID. + * @param {string} params.parent Required. The parent of this attestor. + * @param {().Attestor} params.resource Request body data + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Projects$Attestors$Create, + options?: MethodOptions): AxiosPromise; + create( + params: Params$Resource$Projects$Attestors$Create, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + create( + params: Params$Resource$Projects$Attestors$Create, + callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: Params$Resource$Projects$Attestors$Create| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Projects$Attestors$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Attestors$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://binaryauthorization.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/attestors') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * binaryauthorization.projects.attestors.delete + * @desc Deletes an attestor. Returns NOT_FOUND if the attestor does not + * exist. + * @alias binaryauthorization.projects.attestors.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the attestors to + * delete, in the format `projects/x/attestors/x`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Projects$Attestors$Delete, + options?: MethodOptions): AxiosPromise; + delete( + params: Params$Resource$Projects$Attestors$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Projects$Attestors$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Projects$Attestors$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Projects$Attestors$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Attestors$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://binaryauthorization.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * binaryauthorization.projects.attestors.get + * @desc Gets an attestor. Returns NOT_FOUND if the attestor does not exist. + * @alias binaryauthorization.projects.attestors.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the attestor to + * retrieve, in the format `projects/x/attestors/x`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Projects$Attestors$Get, + options?: MethodOptions): AxiosPromise; + get(params: Params$Resource$Projects$Attestors$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Projects$Attestors$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Projects$Attestors$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Projects$Attestors$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Attestors$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://binaryauthorization.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * binaryauthorization.projects.attestors.getIamPolicy + * @desc Gets the access control policy for a resource. Returns an empty + * policy if the resource exists and does not have a policy set. + * @alias binaryauthorization.projects.attestors.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the + * policy is being requested. See the operation documentation for the + * appropriate value for this field. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: Params$Resource$Projects$Attestors$Getiampolicy, + options?: MethodOptions): AxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Attestors$Getiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + getIamPolicy( + params: Params$Resource$Projects$Attestors$Getiampolicy, + callback: BodyResponseCallback): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: Params$Resource$Projects$Attestors$Getiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Attestors$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Attestors$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://binaryauthorization.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * binaryauthorization.projects.attestors.list + * @desc Lists attestors. Returns INVALID_ARGUMENT if the project does not + * exist. + * @alias binaryauthorization.projects.attestors.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize Requested page size. The server may + * return fewer results than requested. If unspecified, the server will + * pick an appropriate default. + * @param {string=} params.pageToken A token identifying a page of results + * the server should return. Typically, this is the value of + * ListAttestorsResponse.next_page_token returned from the previous call + * to the `ListAttestors` method. + * @param {string} params.parent Required. The resource name of the project + * associated with the attestors, in the format `projects/x`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Attestors$List, + options?: MethodOptions): AxiosPromise; + list( + params: Params$Resource$Projects$Attestors$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Projects$Attestors$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Projects$Attestors$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Projects$Attestors$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Attestors$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://binaryauthorization.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/attestors') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * binaryauthorization.projects.attestors.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces + * any existing policy. + * @alias binaryauthorization.projects.attestors.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the + * policy is being specified. See the operation documentation for the + * appropriate value for this field. + * @param {().SetIamPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setIamPolicy( + params?: Params$Resource$Projects$Attestors$Setiampolicy, + options?: MethodOptions): AxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Attestors$Setiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + setIamPolicy( + params: Params$Resource$Projects$Attestors$Setiampolicy, + callback: BodyResponseCallback): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: Params$Resource$Projects$Attestors$Setiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Attestors$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Attestors$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://binaryauthorization.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * binaryauthorization.projects.attestors.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. If + * the resource does not exist, this will return an empty set of + * permissions, not a NOT_FOUND error. Note: This operation is designed to + * be used for building permission-aware UIs and command-line tools, not for + * authorization checking. This operation may "fail open" without warning. + * @alias binaryauthorization.projects.attestors.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the + * policy detail is being requested. See the operation documentation for + * the appropriate value for this field. + * @param {().TestIamPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Projects$Attestors$Testiampermissions, + options?: MethodOptions): + AxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Attestors$Testiampermissions, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + testIamPermissions( + params: Params$Resource$Projects$Attestors$Testiampermissions, + callback: BodyResponseCallback): + void; + testIamPermissions( + callback: BodyResponseCallback): + void; + testIamPermissions( + paramsOrCallback?: + Params$Resource$Projects$Attestors$Testiampermissions| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Attestors$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Attestors$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://binaryauthorization.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * binaryauthorization.projects.attestors.update + * @desc Updates an attestor. Returns NOT_FOUND if the attestor does not + * exist. + * @alias binaryauthorization.projects.attestors.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name, in the format: + * `projects/x/attestors/x`. This field may not be updated. + * @param {().Attestor} params.resource Request body data + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Projects$Attestors$Update, + options?: MethodOptions): AxiosPromise; + update( + params: Params$Resource$Projects$Attestors$Update, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Projects$Attestors$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: Params$Resource$Projects$Attestors$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Projects$Attestors$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Attestors$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://binaryauthorization.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Attestors$Create { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Required. The attestors ID. + */ + attestorId?: string; + /** + * Required. The parent of this attestor. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Attestor; + } + export interface Params$Resource$Projects$Attestors$Delete { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Required. The name of the attestors to delete, in the format + * `projects/x/attestors/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Attestors$Get { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Required. The name of the attestor to retrieve, in the format + * `projects/x/attestors/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Attestors$Getiampolicy { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being requested. See the + * operation documentation for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Attestors$List { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Requested page size. The server may return fewer results than requested. + * If unspecified, the server will pick an appropriate default. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. + * Typically, this is the value of ListAttestorsResponse.next_page_token + * returned from the previous call to the `ListAttestors` method. + */ + pageToken?: string; + /** + * Required. The resource name of the project associated with the attestors, + * in the format `projects/x`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Attestors$Setiampolicy { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being specified. See the + * operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Attestors$Testiampermissions { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy detail is being requested. + * See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + export interface Params$Resource$Projects$Attestors$Update { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Required. The resource name, in the format: `projects/x/attestors/x`. + * This field may not be updated. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Attestor; + } + + + export class Resource$Projects$Policy { + root: Binaryauthorization; + constructor(root: Binaryauthorization) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * binaryauthorization.projects.policy.getIamPolicy + * @desc Gets the access control policy for a resource. Returns an empty + * policy if the resource exists and does not have a policy set. + * @alias binaryauthorization.projects.policy.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the + * policy is being requested. See the operation documentation for the + * appropriate value for this field. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: Params$Resource$Projects$Policy$Getiampolicy, + options?: MethodOptions): AxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Policy$Getiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + getIamPolicy( + params: Params$Resource$Projects$Policy$Getiampolicy, + callback: BodyResponseCallback): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: Params$Resource$Projects$Policy$Getiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Policy$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Policy$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://binaryauthorization.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * binaryauthorization.projects.policy.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces + * any existing policy. + * @alias binaryauthorization.projects.policy.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the + * policy is being specified. See the operation documentation for the + * appropriate value for this field. + * @param {().SetIamPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setIamPolicy( + params?: Params$Resource$Projects$Policy$Setiampolicy, + options?: MethodOptions): AxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Policy$Setiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + setIamPolicy( + params: Params$Resource$Projects$Policy$Setiampolicy, + callback: BodyResponseCallback): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: Params$Resource$Projects$Policy$Setiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Policy$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Policy$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://binaryauthorization.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * binaryauthorization.projects.policy.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. If + * the resource does not exist, this will return an empty set of + * permissions, not a NOT_FOUND error. Note: This operation is designed to + * be used for building permission-aware UIs and command-line tools, not for + * authorization checking. This operation may "fail open" without warning. + * @alias binaryauthorization.projects.policy.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the + * policy detail is being requested. See the operation documentation for + * the appropriate value for this field. + * @param {().TestIamPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Projects$Policy$Testiampermissions, + options?: MethodOptions): + AxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Policy$Testiampermissions, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + testIamPermissions( + params: Params$Resource$Projects$Policy$Testiampermissions, + callback: BodyResponseCallback): + void; + testIamPermissions( + callback: BodyResponseCallback): + void; + testIamPermissions( + paramsOrCallback?: Params$Resource$Projects$Policy$Testiampermissions| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Policy$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Policy$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://binaryauthorization.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Policy$Getiampolicy { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being requested. See the + * operation documentation for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Policy$Setiampolicy { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being specified. See the + * operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Policy$Testiampermissions { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy detail is being requested. + * See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } +} diff --git a/src/apis/blogger/v2.ts b/src/apis/blogger/v2.ts index f709fc13652..d37661580eb 100644 --- a/src/apis/blogger/v2.ts +++ b/src/apis/blogger/v2.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -370,7 +369,8 @@ export namespace blogger_v2 { * * @param {object} params Parameters for request * @param {string} params.blogId The ID of the blog to get. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -458,7 +458,8 @@ export namespace blogger_v2 { * @param {string} params.blogId ID of the blog to containing the comment. * @param {string} params.commentId The ID of the comment to get. * @param {string} params.postId ID of the post to fetch posts from. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -521,12 +522,16 @@ export namespace blogger_v2 { * * @param {object} params Parameters for request * @param {string} params.blogId ID of the blog to fetch comments from. - * @param {boolean=} params.fetchBodies Whether the body content of the comments is included. - * @param {integer=} params.maxResults Maximum number of comments to include in the result. + * @param {boolean=} params.fetchBodies Whether the body content of the + * comments is included. + * @param {integer=} params.maxResults Maximum number of comments to include + * in the result. * @param {string=} params.pageToken Continuation token if request is paged. * @param {string} params.postId ID of the post to fetch posts from. - * @param {string=} params.startDate Earliest date of comment to fetch, a date-time with RFC 3339 formatting. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.startDate Earliest date of comment to fetch, a + * date-time with RFC 3339 formatting. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -657,7 +662,8 @@ export namespace blogger_v2 { * @param {object} params Parameters for request * @param {string} params.blogId ID of the blog containing the page. * @param {string} params.pageId The ID of the page to get. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -719,7 +725,8 @@ export namespace blogger_v2 { * @param {object} params Parameters for request * @param {string} params.blogId ID of the blog to fetch pages from. * @param {boolean=} params.fetchBodies Whether to retrieve the Page bodies. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -828,7 +835,8 @@ export namespace blogger_v2 { * @param {object} params Parameters for request * @param {string} params.blogId ID of the blog to fetch the post from. * @param {string} params.postId The ID of the post - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -889,11 +897,15 @@ export namespace blogger_v2 { * * @param {object} params Parameters for request * @param {string} params.blogId ID of the blog to fetch posts from. - * @param {boolean=} params.fetchBodies Whether the body content of posts is included. + * @param {boolean=} params.fetchBodies Whether the body content of posts is + * included. * @param {integer=} params.maxResults Maximum number of posts to fetch. - * @param {string=} params.pageToken Continuation token if the request is paged. - * @param {string=} params.startDate Earliest post date to fetch, a date-time with RFC 3339 formatting. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.pageToken Continuation token if the request is + * paged. + * @param {string=} params.startDate Earliest post date to fetch, a + * date-time with RFC 3339 formatting. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1015,7 +1027,8 @@ export namespace blogger_v2 { * * @param {object} params Parameters for request * @param {string} params.userId The ID of the user to get. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1099,8 +1112,11 @@ export namespace blogger_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.userId ID of the user whose blogs are to be + * fetched. Either the word 'self' (sans quote marks) or the user's + * profile identifier. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/blogger/v3.ts b/src/apis/blogger/v3.ts index 23a3f64d4e3..48264c96f38 100644 --- a/src/apis/blogger/v3.ts +++ b/src/apis/blogger/v3.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -545,9 +544,12 @@ export namespace blogger_v3 { * * @param {object} params Parameters for request * @param {string} params.blogId The ID of the blog to get. - * @param {integer=} params.maxPosts Maximum number of posts to pull back with the blog. - * @param {string=} params.view Access level with which to view the blog. Note that some fields require elevated access. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.maxPosts Maximum number of posts to pull back + * with the blog. + * @param {string=} params.view Access level with which to view the blog. + * Note that some fields require elevated access. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -608,8 +610,10 @@ export namespace blogger_v3 { * * @param {object} params Parameters for request * @param {string} params.url The URL of the blog to retrieve. - * @param {string=} params.view Access level with which to view the blog. Note that some fields require elevated access. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.view Access level with which to view the blog. + * Note that some fields require elevated access. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -672,12 +676,22 @@ export namespace blogger_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.fetchUserInfo Whether the response is a list of blogs with per-user information instead of just blogs. - * @param {string=} params.role User access types for blogs to include in the results, e.g. AUTHOR will return blogs where the user has author level access. If no roles are specified, defaults to ADMIN and AUTHOR roles. - * @param {string=} params.status Blog statuses to include in the result (default: Live blogs only). Note that ADMIN access is required to view deleted blogs. - * @param {string} params.userId ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. - * @param {string=} params.view Access level with which to view the blogs. Note that some fields require elevated access. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {boolean=} params.fetchUserInfo Whether the response is a list of + * blogs with per-user information instead of just blogs. + * @param {string=} params.role User access types for blogs to include in + * the results, e.g. AUTHOR will return blogs where the user has author + * level access. If no roles are specified, defaults to ADMIN and AUTHOR + * roles. + * @param {string=} params.status Blog statuses to include in the result + * (default: Live blogs only). Note that ADMIN access is required to + * view deleted blogs. + * @param {string} params.userId ID of the user whose blogs are to be + * fetched. Either the word 'self' (sans quote marks) or the user's + * profile identifier. + * @param {string=} params.view Access level with which to view the blogs. + * Note that some fields require elevated access. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -825,9 +839,13 @@ export namespace blogger_v3 { * * @param {object} params Parameters for request * @param {string} params.blogId The ID of the blog to get. - * @param {integer=} params.maxPosts Maximum number of posts to pull back with the blog. - * @param {string} params.userId ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.maxPosts Maximum number of posts to pull back + * with the blog. + * @param {string} params.userId ID of the user whose blogs are to be + * fetched. Either the word 'self' (sans quote marks) or the user's + * profile identifier. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -924,9 +942,11 @@ export namespace blogger_v3 { * * @param {object} params Parameters for request * @param {string} params.blogId The ID of the Blog. - * @param {string} params.commentId The ID of the comment to mark as not spam. + * @param {string} params.commentId The ID of the comment to mark as not + * spam. * @param {string} params.postId The ID of the Post. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -994,7 +1014,8 @@ export namespace blogger_v3 { * @param {string} params.blogId The ID of the Blog. * @param {string} params.commentId The ID of the comment to delete. * @param {string} params.postId The ID of the Post. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1061,8 +1082,12 @@ export namespace blogger_v3 { * @param {string} params.blogId ID of the blog to containing the comment. * @param {string} params.commentId The ID of the comment to get. * @param {string} params.postId ID of the post to fetch posts from. - * @param {string=} params.view Access level for the requested comment (default: READER). Note that some comments will require elevated permissions, for example comments where the parent posts which is in a draft state, or comments that are pending moderation. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.view Access level for the requested comment + * (default: READER). Note that some comments will require elevated + * permissions, for example comments where the parent posts which is in + * a draft state, or comments that are pending moderation. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1125,15 +1150,21 @@ export namespace blogger_v3 { * * @param {object} params Parameters for request * @param {string} params.blogId ID of the blog to fetch comments from. - * @param {string=} params.endDate Latest date of comment to fetch, a date-time with RFC 3339 formatting. - * @param {boolean=} params.fetchBodies Whether the body content of the comments is included. - * @param {integer=} params.maxResults Maximum number of comments to include in the result. + * @param {string=} params.endDate Latest date of comment to fetch, a + * date-time with RFC 3339 formatting. + * @param {boolean=} params.fetchBodies Whether the body content of the + * comments is included. + * @param {integer=} params.maxResults Maximum number of comments to include + * in the result. * @param {string=} params.pageToken Continuation token if request is paged. * @param {string} params.postId ID of the post to fetch posts from. - * @param {string=} params.startDate Earliest date of comment to fetch, a date-time with RFC 3339 formatting. + * @param {string=} params.startDate Earliest date of comment to fetch, a + * date-time with RFC 3339 formatting. * @param {string=} params.status - * @param {string=} params.view Access level with which to view the returned result. Note that some fields require elevated access. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.view Access level with which to view the returned + * result. Note that some fields require elevated access. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1200,13 +1231,18 @@ export namespace blogger_v3 { * * @param {object} params Parameters for request * @param {string} params.blogId ID of the blog to fetch comments from. - * @param {string=} params.endDate Latest date of comment to fetch, a date-time with RFC 3339 formatting. - * @param {boolean=} params.fetchBodies Whether the body content of the comments is included. - * @param {integer=} params.maxResults Maximum number of comments to include in the result. + * @param {string=} params.endDate Latest date of comment to fetch, a + * date-time with RFC 3339 formatting. + * @param {boolean=} params.fetchBodies Whether the body content of the + * comments is included. + * @param {integer=} params.maxResults Maximum number of comments to include + * in the result. * @param {string=} params.pageToken Continuation token if request is paged. - * @param {string=} params.startDate Earliest date of comment to fetch, a date-time with RFC 3339 formatting. + * @param {string=} params.startDate Earliest date of comment to fetch, a + * date-time with RFC 3339 formatting. * @param {string=} params.status - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1275,7 +1311,8 @@ export namespace blogger_v3 { * @param {string} params.blogId The ID of the Blog. * @param {string} params.commentId The ID of the comment to mark as spam. * @param {string} params.postId The ID of the Post. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1343,9 +1380,11 @@ export namespace blogger_v3 { * * @param {object} params Parameters for request * @param {string} params.blogId The ID of the Blog. - * @param {string} params.commentId The ID of the comment to delete content from. + * @param {string} params.commentId The ID of the comment to delete content + * from. * @param {string} params.postId The ID of the Post. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1609,7 +1648,8 @@ export namespace blogger_v3 { * @param {object} params Parameters for request * @param {string} params.blogId The ID of the Blog. * @param {string} params.pageId The ID of the Page. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1674,7 +1714,8 @@ export namespace blogger_v3 { * @param {string} params.blogId ID of the blog containing the page. * @param {string} params.pageId The ID of the page to get. * @param {string=} params.view - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1735,9 +1776,11 @@ export namespace blogger_v3 { * * @param {object} params Parameters for request * @param {string} params.blogId ID of the blog to add the page to. - * @param {boolean=} params.isDraft Whether to create the page as a draft (default: false). + * @param {boolean=} params.isDraft Whether to create the page as a draft + * (default: false). * @param {().Page} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1804,10 +1847,13 @@ export namespace blogger_v3 { * @param {string} params.blogId ID of the blog to fetch Pages from. * @param {boolean=} params.fetchBodies Whether to retrieve the Page bodies. * @param {integer=} params.maxResults Maximum number of Pages to fetch. - * @param {string=} params.pageToken Continuation token if the request is paged. + * @param {string=} params.pageToken Continuation token if the request is + * paged. * @param {string=} params.status - * @param {string=} params.view Access level with which to view the returned result. Note that some fields require elevated access. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.view Access level with which to view the returned + * result. Note that some fields require elevated access. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1872,10 +1918,13 @@ export namespace blogger_v3 { * @param {object} params Parameters for request * @param {string} params.blogId The ID of the Blog. * @param {string} params.pageId The ID of the Page. - * @param {boolean=} params.publish Whether a publish action should be performed when the page is updated (default: false). - * @param {boolean=} params.revert Whether a revert action should be performed when the page is updated (default: false). + * @param {boolean=} params.publish Whether a publish action should be + * performed when the page is updated (default: false). + * @param {boolean=} params.revert Whether a revert action should be + * performed when the page is updated (default: false). * @param {().Page} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1940,7 +1989,8 @@ export namespace blogger_v3 { * @param {object} params Parameters for request * @param {string} params.blogId The ID of the blog. * @param {string} params.pageId The ID of the page. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2006,7 +2056,8 @@ export namespace blogger_v3 { * @param {object} params Parameters for request * @param {string} params.blogId The ID of the blog. * @param {string} params.pageId The ID of the page. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2072,10 +2123,13 @@ export namespace blogger_v3 { * @param {object} params Parameters for request * @param {string} params.blogId The ID of the Blog. * @param {string} params.pageId The ID of the Page. - * @param {boolean=} params.publish Whether a publish action should be performed when the page is updated (default: false). - * @param {boolean=} params.revert Whether a revert action should be performed when the page is updated (default: false). + * @param {boolean=} params.publish Whether a publish action should be + * performed when the page is updated (default: false). + * @param {boolean=} params.revert Whether a revert action should be + * performed when the page is updated (default: false). * @param {().Page} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2330,7 +2384,8 @@ export namespace blogger_v3 { * @param {object} params Parameters for request * @param {string} params.blogId The ID of the blog to get. * @param {string=} params.range - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2422,7 +2477,8 @@ export namespace blogger_v3 { * @param {object} params Parameters for request * @param {string} params.blogId The ID of the Blog. * @param {string} params.postId The ID of the Post. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2485,12 +2541,18 @@ export namespace blogger_v3 { * * @param {object} params Parameters for request * @param {string} params.blogId ID of the blog to fetch the post from. - * @param {boolean=} params.fetchBody Whether the body content of the post is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic. - * @param {boolean=} params.fetchImages Whether image URL metadata for each post is included (default: false). - * @param {integer=} params.maxComments Maximum number of comments to pull back on a post. + * @param {boolean=} params.fetchBody Whether the body content of the post + * is included (default: true). This should be set to false when the + * post bodies are not required, to help minimize traffic. + * @param {boolean=} params.fetchImages Whether image URL metadata for each + * post is included (default: false). + * @param {integer=} params.maxComments Maximum number of comments to pull + * back on a post. * @param {string} params.postId The ID of the post - * @param {string=} params.view Access level with which to view the returned result. Note that some fields require elevated access. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.view Access level with which to view the returned + * result. Note that some fields require elevated access. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2551,10 +2613,13 @@ export namespace blogger_v3 { * * @param {object} params Parameters for request * @param {string} params.blogId ID of the blog to fetch the post from. - * @param {integer=} params.maxComments Maximum number of comments to pull back on a post. + * @param {integer=} params.maxComments Maximum number of comments to pull + * back on a post. * @param {string} params.path Path of the Post to retrieve. - * @param {string=} params.view Access level with which to view the returned result. Note that some fields require elevated access. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.view Access level with which to view the returned + * result. Note that some fields require elevated access. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2619,11 +2684,15 @@ export namespace blogger_v3 { * * @param {object} params Parameters for request * @param {string} params.blogId ID of the blog to add the post to. - * @param {boolean=} params.fetchBody Whether the body content of the post is included with the result (default: true). - * @param {boolean=} params.fetchImages Whether image URL metadata for each post is included in the returned result (default: false). - * @param {boolean=} params.isDraft Whether to create the post as a draft (default: false). + * @param {boolean=} params.fetchBody Whether the body content of the post + * is included with the result (default: true). + * @param {boolean=} params.fetchImages Whether image URL metadata for each + * post is included in the returned result (default: false). + * @param {boolean=} params.isDraft Whether to create the post as a draft + * (default: false). * @param {().Post} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2687,17 +2756,26 @@ export namespace blogger_v3 { * * @param {object} params Parameters for request * @param {string} params.blogId ID of the blog to fetch posts from. - * @param {string=} params.endDate Latest post date to fetch, a date-time with RFC 3339 formatting. - * @param {boolean=} params.fetchBodies Whether the body content of posts is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic. - * @param {boolean=} params.fetchImages Whether image URL metadata for each post is included. - * @param {string=} params.labels Comma-separated list of labels to search for. + * @param {string=} params.endDate Latest post date to fetch, a date-time + * with RFC 3339 formatting. + * @param {boolean=} params.fetchBodies Whether the body content of posts is + * included (default: true). This should be set to false when the post + * bodies are not required, to help minimize traffic. + * @param {boolean=} params.fetchImages Whether image URL metadata for each + * post is included. + * @param {string=} params.labels Comma-separated list of labels to search + * for. * @param {integer=} params.maxResults Maximum number of posts to fetch. * @param {string=} params.orderBy Sort search results - * @param {string=} params.pageToken Continuation token if the request is paged. - * @param {string=} params.startDate Earliest post date to fetch, a date-time with RFC 3339 formatting. + * @param {string=} params.pageToken Continuation token if the request is + * paged. + * @param {string=} params.startDate Earliest post date to fetch, a + * date-time with RFC 3339 formatting. * @param {string=} params.status Statuses to include in the results. - * @param {string=} params.view Access level with which to view the returned result. Note that some fields require escalated access. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.view Access level with which to view the returned + * result. Note that some fields require escalated access. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2761,14 +2839,20 @@ export namespace blogger_v3 { * * @param {object} params Parameters for request * @param {string} params.blogId The ID of the Blog. - * @param {boolean=} params.fetchBody Whether the body content of the post is included with the result (default: true). - * @param {boolean=} params.fetchImages Whether image URL metadata for each post is included in the returned result (default: false). - * @param {integer=} params.maxComments Maximum number of comments to retrieve with the returned post. + * @param {boolean=} params.fetchBody Whether the body content of the post + * is included with the result (default: true). + * @param {boolean=} params.fetchImages Whether image URL metadata for each + * post is included in the returned result (default: false). + * @param {integer=} params.maxComments Maximum number of comments to + * retrieve with the returned post. * @param {string} params.postId The ID of the Post. - * @param {boolean=} params.publish Whether a publish action should be performed when the post is updated (default: false). - * @param {boolean=} params.revert Whether a revert action should be performed when the post is updated (default: false). + * @param {boolean=} params.publish Whether a publish action should be + * performed when the post is updated (default: false). + * @param {boolean=} params.revert Whether a revert action should be + * performed when the post is updated (default: false). * @param {().Post} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2834,8 +2918,13 @@ export namespace blogger_v3 { * @param {object} params Parameters for request * @param {string} params.blogId The ID of the Blog. * @param {string} params.postId The ID of the Post. - * @param {string=} params.publishDate Optional date and time to schedule the publishing of the Blog. If no publishDate parameter is given, the post is either published at the a previously saved schedule date (if present), or the current time. If a future date is given, the post will be scheduled to be published. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.publishDate Optional date and time to schedule + * the publishing of the Blog. If no publishDate parameter is given, the + * post is either published at the a previously saved schedule date (if + * present), or the current time. If a future date is given, the post + * will be scheduled to be published. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2901,7 +2990,8 @@ export namespace blogger_v3 { * @param {object} params Parameters for request * @param {string} params.blogId The ID of the Blog. * @param {string} params.postId The ID of the Post. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2966,10 +3056,14 @@ export namespace blogger_v3 { * * @param {object} params Parameters for request * @param {string} params.blogId ID of the blog to fetch the post from. - * @param {boolean=} params.fetchBodies Whether the body content of posts is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic. + * @param {boolean=} params.fetchBodies Whether the body content of posts is + * included (default: true). This should be set to false when the post + * bodies are not required, to help minimize traffic. * @param {string=} params.orderBy Sort search results - * @param {string} params.q Query terms to search this blog for matching posts. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.q Query terms to search this blog for matching + * posts. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3033,14 +3127,20 @@ export namespace blogger_v3 { * * @param {object} params Parameters for request * @param {string} params.blogId The ID of the Blog. - * @param {boolean=} params.fetchBody Whether the body content of the post is included with the result (default: true). - * @param {boolean=} params.fetchImages Whether image URL metadata for each post is included in the returned result (default: false). - * @param {integer=} params.maxComments Maximum number of comments to retrieve with the returned post. + * @param {boolean=} params.fetchBody Whether the body content of the post + * is included with the result (default: true). + * @param {boolean=} params.fetchImages Whether image URL metadata for each + * post is included in the returned result (default: false). + * @param {integer=} params.maxComments Maximum number of comments to + * retrieve with the returned post. * @param {string} params.postId The ID of the Post. - * @param {boolean=} params.publish Whether a publish action should be performed when the post is updated (default: false). - * @param {boolean=} params.revert Whether a revert action should be performed when the post is updated (default: false). + * @param {boolean=} params.publish Whether a publish action should be + * performed when the post is updated (default: false). + * @param {boolean=} params.revert Whether a revert action should be + * performed when the post is updated (default: false). * @param {().Post} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3427,10 +3527,14 @@ export namespace blogger_v3 { * * @param {object} params Parameters for request * @param {string} params.blogId The ID of the blog. - * @param {integer=} params.maxComments Maximum number of comments to pull back on a post. + * @param {integer=} params.maxComments Maximum number of comments to pull + * back on a post. * @param {string} params.postId The ID of the post to get. - * @param {string} params.userId ID of the user for the per-user information to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.userId ID of the user for the per-user information + * to be fetched. Either the word 'self' (sans quote marks) or the + * user's profile identifier. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3496,17 +3600,27 @@ export namespace blogger_v3 { * * @param {object} params Parameters for request * @param {string} params.blogId ID of the blog to fetch posts from. - * @param {string=} params.endDate Latest post date to fetch, a date-time with RFC 3339 formatting. - * @param {boolean=} params.fetchBodies Whether the body content of posts is included. Default is false. - * @param {string=} params.labels Comma-separated list of labels to search for. + * @param {string=} params.endDate Latest post date to fetch, a date-time + * with RFC 3339 formatting. + * @param {boolean=} params.fetchBodies Whether the body content of posts is + * included. Default is false. + * @param {string=} params.labels Comma-separated list of labels to search + * for. * @param {integer=} params.maxResults Maximum number of posts to fetch. - * @param {string=} params.orderBy Sort order applied to search results. Default is published. - * @param {string=} params.pageToken Continuation token if the request is paged. - * @param {string=} params.startDate Earliest post date to fetch, a date-time with RFC 3339 formatting. + * @param {string=} params.orderBy Sort order applied to search results. + * Default is published. + * @param {string=} params.pageToken Continuation token if the request is + * paged. + * @param {string=} params.startDate Earliest post date to fetch, a + * date-time with RFC 3339 formatting. * @param {string=} params.status - * @param {string} params.userId ID of the user for the per-user information to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. - * @param {string=} params.view Access level with which to view the returned result. Note that some fields require elevated access. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.userId ID of the user for the per-user information + * to be fetched. Either the word 'self' (sans quote marks) or the + * user's profile identifier. + * @param {string=} params.view Access level with which to view the returned + * result. Note that some fields require elevated access. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3663,7 +3777,8 @@ export namespace blogger_v3 { * * @param {object} params Parameters for request * @param {string} params.userId The ID of the user to get. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/books/v1.ts b/src/apis/books/v1.ts index 260e88dc69d..a93a171d206 100644 --- a/src/apis/books/v1.ts +++ b/src/apis/books/v1.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -563,6 +562,7 @@ export namespace books_v1 { doc_type?: string; dont_show_notification?: boolean; iconUrl?: string; + is_document_mature?: boolean; /** * Resource type. */ @@ -905,9 +905,12 @@ export namespace books_v1 { * * @param {object} params Parameters for request * @param {string} params.shelf ID of bookshelf to retrieve. - * @param {string=} params.source String to identify the originator of this request. - * @param {string} params.userId ID of user for whom to retrieve bookshelves. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.source String to identify the originator of this + * request. + * @param {string} params.userId ID of user for whom to retrieve + * bookshelves. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -968,9 +971,12 @@ export namespace books_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.source String to identify the originator of this request. - * @param {string} params.userId ID of user for whom to retrieve bookshelves. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.source String to identify the originator of this + * request. + * @param {string} params.userId ID of user for whom to retrieve + * bookshelves. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1083,11 +1089,16 @@ export namespace books_v1 { * @param {object} params Parameters for request * @param {integer=} params.maxResults Maximum number of results to return * @param {string} params.shelf ID of bookshelf to retrieve volumes. - * @param {boolean=} params.showPreorders Set to true to show pre-ordered books. Defaults to false. - * @param {string=} params.source String to identify the originator of this request. - * @param {integer=} params.startIndex Index of the first element to return (starts at 0) - * @param {string} params.userId ID of user for whom to retrieve bookshelf volumes. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {boolean=} params.showPreorders Set to true to show pre-ordered + * books. Defaults to false. + * @param {string=} params.source String to identify the originator of this + * request. + * @param {integer=} params.startIndex Index of the first element to return + * (starts at 0) + * @param {string} params.userId ID of user for whom to retrieve bookshelf + * volumes. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1198,11 +1209,15 @@ export namespace books_v1 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {string=} params.drive_document_id A drive document id. The upload_client_token must not be set. - * @param {string=} params.mime_type The document MIME type. It can be set only if the drive_document_id is set. - * @param {string=} params.name The document name. It can be set only if the drive_document_id is set. + * @param {string=} params.drive_document_id A drive document id. The + * upload_client_token must not be set. + * @param {string=} params.mime_type The document MIME type. It can be set + * only if the drive_document_id is set. + * @param {string=} params.name The document name. It can be set only if the + * drive_document_id is set. * @param {string=} params.upload_client_token - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1272,7 +1287,8 @@ export namespace books_v1 { * * @param {object} params Parameters for request * @param {string} params.volumeId The id of the book to be removed. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1336,7 +1352,8 @@ export namespace books_v1 { * * @param {object} params Parameters for request * @param {().BooksCloudloadingResource} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1467,8 +1484,10 @@ export namespace books_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.cpksver The device/version ID from which to request the data. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.cpksver The device/version ID from which to + * request the data. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1558,8 +1577,10 @@ export namespace books_v1 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {string=} params.source String to identify the originator of this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.source String to identify the originator of this + * request. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1627,9 +1648,11 @@ export namespace books_v1 { * * @param {object=} params Parameters for request * @param {string=} params.docId The docid to share. - * @param {string=} params.source String to identify the originator of this request. + * @param {string=} params.source String to identify the originator of this + * request. * @param {string=} params.volumeId The volume to share. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1695,9 +1718,11 @@ export namespace books_v1 { * * @param {object=} params Parameters for request * @param {string=} params.docId The docid to unshare. - * @param {string=} params.source String to identify the originator of this request. + * @param {string=} params.source String to identify the originator of this + * request. * @param {string=} params.volumeId The volume to unshare. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1828,11 +1853,15 @@ export namespace books_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.contentVersion The content version for the requested volume. - * @param {string=} params.source String to identify the originator of this request. - * @param {string} params.summaryId The ID for the layer to get the summary for. + * @param {string=} params.contentVersion The content version for the + * requested volume. + * @param {string=} params.source String to identify the originator of this + * request. + * @param {string} params.summaryId The ID for the layer to get the summary + * for. * @param {string} params.volumeId The volume to retrieve layers for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1894,12 +1923,16 @@ export namespace books_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.contentVersion The content version for the requested volume. + * @param {string=} params.contentVersion The content version for the + * requested volume. * @param {integer=} params.maxResults Maximum number of results to return - * @param {string=} params.pageToken The value of the nextToken from the previous page. - * @param {string=} params.source String to identify the originator of this request. + * @param {string=} params.pageToken The value of the nextToken from the + * previous page. + * @param {string=} params.source String to identify the originator of this + * request. * @param {string} params.volumeId The volume to retrieve layers for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2026,17 +2059,26 @@ export namespace books_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.allowWebDefinitions For the dictionary layer. Whether or not to allow web definitions. - * @param {string} params.annotationDataId The ID of the annotation data to retrieve. - * @param {string} params.contentVersion The content version for the volume you are trying to retrieve. - * @param {integer=} params.h The requested pixel height for any images. If height is provided width must also be provided. - * @param {string} params.layerId The ID for the layer to get the annotations. - * @param {string=} params.locale The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. + * @param {boolean=} params.allowWebDefinitions For the dictionary layer. + * Whether or not to allow web definitions. + * @param {string} params.annotationDataId The ID of the annotation data to + * retrieve. + * @param {string} params.contentVersion The content version for the volume + * you are trying to retrieve. + * @param {integer=} params.h The requested pixel height for any images. If + * height is provided width must also be provided. + * @param {string} params.layerId The ID for the layer to get the + * annotations. + * @param {string=} params.locale The locale information for the data. + * ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. * @param {integer=} params.scale The requested scale for the image. - * @param {string=} params.source String to identify the originator of this request. + * @param {string=} params.source String to identify the originator of this + * request. * @param {string} params.volumeId The volume to retrieve annotations for. - * @param {integer=} params.w The requested pixel width for any images. If width is provided height must also be provided. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.w The requested pixel width for any images. If + * width is provided height must also be provided. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2101,20 +2143,32 @@ export namespace books_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.annotationDataId The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set. - * @param {string} params.contentVersion The content version for the requested volume. - * @param {integer=} params.h The requested pixel height for any images. If height is provided width must also be provided. - * @param {string} params.layerId The ID for the layer to get the annotation data. - * @param {string=} params.locale The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. + * @param {string=} params.annotationDataId The list of Annotation Data Ids + * to retrieve. Pagination is ignored if this is set. + * @param {string} params.contentVersion The content version for the + * requested volume. + * @param {integer=} params.h The requested pixel height for any images. If + * height is provided width must also be provided. + * @param {string} params.layerId The ID for the layer to get the annotation + * data. + * @param {string=} params.locale The locale information for the data. + * ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. * @param {integer=} params.maxResults Maximum number of results to return - * @param {string=} params.pageToken The value of the nextToken from the previous page. + * @param {string=} params.pageToken The value of the nextToken from the + * previous page. * @param {integer=} params.scale The requested scale for the image. - * @param {string=} params.source String to identify the originator of this request. - * @param {string=} params.updatedMax RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive). - * @param {string=} params.updatedMin RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive). - * @param {string} params.volumeId The volume to retrieve annotation data for. - * @param {integer=} params.w The requested pixel width for any images. If width is provided height must also be provided. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.source String to identify the originator of this + * request. + * @param {string=} params.updatedMax RFC 3339 timestamp to restrict to + * items updated prior to this timestamp (exclusive). + * @param {string=} params.updatedMin RFC 3339 timestamp to restrict to + * items updated since this timestamp (inclusive). + * @param {string} params.volumeId The volume to retrieve annotation data + * for. + * @param {integer=} params.w The requested pixel width for any images. If + * width is provided height must also be provided. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2310,12 +2364,17 @@ export namespace books_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.annotationId The ID of the volume annotation to retrieve. - * @param {string} params.layerId The ID for the layer to get the annotations. - * @param {string=} params.locale The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. - * @param {string=} params.source String to identify the originator of this request. + * @param {string} params.annotationId The ID of the volume annotation to + * retrieve. + * @param {string} params.layerId The ID for the layer to get the + * annotations. + * @param {string=} params.locale The locale information for the data. + * ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. + * @param {string=} params.source String to identify the originator of this + * request. * @param {string} params.volumeId The volume to retrieve annotations for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2379,22 +2438,37 @@ export namespace books_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.contentVersion The content version for the requested volume. - * @param {string=} params.endOffset The end offset to end retrieving data from. - * @param {string=} params.endPosition The end position to end retrieving data from. - * @param {string} params.layerId The ID for the layer to get the annotations. - * @param {string=} params.locale The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. + * @param {string} params.contentVersion The content version for the + * requested volume. + * @param {string=} params.endOffset The end offset to end retrieving data + * from. + * @param {string=} params.endPosition The end position to end retrieving + * data from. + * @param {string} params.layerId The ID for the layer to get the + * annotations. + * @param {string=} params.locale The locale information for the data. + * ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. * @param {integer=} params.maxResults Maximum number of results to return - * @param {string=} params.pageToken The value of the nextToken from the previous page. - * @param {boolean=} params.showDeleted Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false. - * @param {string=} params.source String to identify the originator of this request. - * @param {string=} params.startOffset The start offset to start retrieving data from. - * @param {string=} params.startPosition The start position to start retrieving data from. - * @param {string=} params.updatedMax RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive). - * @param {string=} params.updatedMin RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive). - * @param {string=} params.volumeAnnotationsVersion The version of the volume annotations that you are requesting. + * @param {string=} params.pageToken The value of the nextToken from the + * previous page. + * @param {boolean=} params.showDeleted Set to true to return deleted + * annotations. updatedMin must be in the request to use this. Defaults + * to false. + * @param {string=} params.source String to identify the originator of this + * request. + * @param {string=} params.startOffset The start offset to start retrieving + * data from. + * @param {string=} params.startPosition The start position to start + * retrieving data from. + * @param {string=} params.updatedMax RFC 3339 timestamp to restrict to + * items updated prior to this timestamp (exclusive). + * @param {string=} params.updatedMin RFC 3339 timestamp to restrict to + * items updated since this timestamp (inclusive). + * @param {string=} params.volumeAnnotationsVersion The version of the + * volume annotations that you are requesting. * @param {string} params.volumeId The volume to retrieve annotations for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2574,7 +2648,8 @@ export namespace books_v1 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2640,11 +2715,16 @@ export namespace books_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.cpksver The device/version ID from which to release the restriction. - * @param {string=} params.locale ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US. - * @param {string=} params.source String to identify the originator of this request. - * @param {string} params.volumeIds The volume(s) to release restrictions for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.cpksver The device/version ID from which to + * release the restriction. + * @param {string=} params.locale ISO-639-1, ISO-3166-1 codes for message + * localization, i.e. en_US. + * @param {string=} params.source String to identify the originator of this + * request. + * @param {string} params.volumeIds The volume(s) to release restrictions + * for. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2711,13 +2791,19 @@ export namespace books_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.cpksver The device/version ID from which to request the restrictions. - * @param {string=} params.licenseTypes The type of access license to request. If not specified, the default is BOTH. - * @param {string=} params.locale ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US. + * @param {string} params.cpksver The device/version ID from which to + * request the restrictions. + * @param {string=} params.licenseTypes The type of access license to + * request. If not specified, the default is BOTH. + * @param {string=} params.locale ISO-639-1, ISO-3166-1 codes for message + * localization, i.e. en_US. * @param {string} params.nonce The client nonce value. - * @param {string} params.source String to identify the originator of this request. - * @param {string} params.volumeId The volume to request concurrent/download restrictions for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.source String to identify the originator of this + * request. + * @param {string} params.volumeId The volume to request concurrent/download + * restrictions for. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2784,15 +2870,23 @@ export namespace books_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.cpksver The device/version ID from which to release the restriction. - * @param {string=} params.features List of features supported by the client, i.e., 'RENTALS' - * @param {boolean=} params.includeNonComicsSeries Set to true to include non-comics series. Defaults to false. - * @param {string=} params.locale ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US. + * @param {string} params.cpksver The device/version ID from which to + * release the restriction. + * @param {string=} params.features List of features supported by the + * client, i.e., 'RENTALS' + * @param {boolean=} params.includeNonComicsSeries Set to true to include + * non-comics series. Defaults to false. + * @param {string=} params.locale ISO-639-1, ISO-3166-1 codes for message + * localization, i.e. en_US. * @param {string} params.nonce The client nonce value. - * @param {boolean=} params.showPreorders Set to true to show pre-ordered books. Defaults to false. - * @param {string} params.source String to identify the originator of this request. - * @param {string=} params.volumeIds The volume(s) to request download restrictions for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {boolean=} params.showPreorders Set to true to show pre-ordered + * books. Defaults to false. + * @param {string} params.source String to identify the originator of this + * request. + * @param {string=} params.volumeIds The volume(s) to request download + * restrictions for. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2860,7 +2954,8 @@ export namespace books_v1 { * * @param {object} params Parameters for request * @param {().Usersettings} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3073,8 +3168,10 @@ export namespace books_v1 { * * @param {object} params Parameters for request * @param {string} params.annotationId The ID for the annotation to delete. - * @param {string=} params.source String to identify the originator of this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.source String to identify the originator of this + * request. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3139,11 +3236,15 @@ export namespace books_v1 { * * @param {object} params Parameters for request * @param {string=} params.annotationId The ID for the annotation to insert. - * @param {string=} params.country ISO-3166-1 code to override the IP-based location. - * @param {boolean=} params.showOnlySummaryInResponse Requests that only the summary of the specified layer be provided in the response. - * @param {string=} params.source String to identify the originator of this request. + * @param {string=} params.country ISO-3166-1 code to override the IP-based + * location. + * @param {boolean=} params.showOnlySummaryInResponse Requests that only the + * summary of the specified layer be provided in the response. + * @param {string=} params.source String to identify the originator of this + * request. * @param {().Annotation} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3209,17 +3310,25 @@ export namespace books_v1 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {string=} params.contentVersion The content version for the requested volume. + * @param {string=} params.contentVersion The content version for the + * requested volume. * @param {string=} params.layerId The layer ID to limit annotation by. * @param {string=} params.layerIds The layer ID(s) to limit annotation by. * @param {integer=} params.maxResults Maximum number of results to return - * @param {string=} params.pageToken The value of the nextToken from the previous page. - * @param {boolean=} params.showDeleted Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false. - * @param {string=} params.source String to identify the originator of this request. - * @param {string=} params.updatedMax RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive). - * @param {string=} params.updatedMin RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive). + * @param {string=} params.pageToken The value of the nextToken from the + * previous page. + * @param {boolean=} params.showDeleted Set to true to return deleted + * annotations. updatedMin must be in the request to use this. Defaults + * to false. + * @param {string=} params.source String to identify the originator of this + * request. + * @param {string=} params.updatedMax RFC 3339 timestamp to restrict to + * items updated prior to this timestamp (exclusive). + * @param {string=} params.updatedMin RFC 3339 timestamp to restrict to + * items updated since this timestamp (inclusive). * @param {string=} params.volumeId The volume to restrict annotations to. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3285,9 +3394,11 @@ export namespace books_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.layerIds Array of layer IDs to get the summary for. + * @param {string} params.layerIds Array of layer IDs to get the summary + * for. * @param {string} params.volumeId Volume id to get the summary for. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3354,9 +3465,11 @@ export namespace books_v1 { * * @param {object} params Parameters for request * @param {string} params.annotationId The ID for the annotation to update. - * @param {string=} params.source String to identify the originator of this request. + * @param {string=} params.source String to identify the originator of this + * request. * @param {().Annotation} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3567,11 +3680,14 @@ export namespace books_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.reason The reason for which the book is added to the library. + * @param {string=} params.reason The reason for which the book is added to + * the library. * @param {string} params.shelf ID of bookshelf to which to add a volume. - * @param {string=} params.source String to identify the originator of this request. + * @param {string=} params.source String to identify the originator of this + * request. * @param {string} params.volumeId ID of volume to add. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3636,9 +3752,12 @@ export namespace books_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.shelf ID of bookshelf from which to remove a volume. - * @param {string=} params.source String to identify the originator of this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.shelf ID of bookshelf from which to remove a + * volume. + * @param {string=} params.source String to identify the originator of this + * request. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3705,8 +3824,10 @@ export namespace books_v1 { * * @param {object} params Parameters for request * @param {string} params.shelf ID of bookshelf to retrieve. - * @param {string=} params.source String to identify the originator of this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.source String to identify the originator of this + * request. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3769,8 +3890,10 @@ export namespace books_v1 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {string=} params.source String to identify the originator of this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.source String to identify the originator of this + * request. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3837,10 +3960,14 @@ export namespace books_v1 { * * @param {object} params Parameters for request * @param {string} params.shelf ID of bookshelf with the volume. - * @param {string=} params.source String to identify the originator of this request. + * @param {string=} params.source String to identify the originator of this + * request. * @param {string} params.volumeId ID of volume to move. - * @param {integer} params.volumePosition Position on shelf to move the item (0 puts the item before the current first item, 1 puts it between the first and the second and so on.) - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer} params.volumePosition Position on shelf to move the item + * (0 puts the item before the current first item, 1 puts it between the + * first and the second and so on.) + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3905,11 +4032,15 @@ export namespace books_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.reason The reason for which the book is removed from the library. - * @param {string} params.shelf ID of bookshelf from which to remove a volume. - * @param {string=} params.source String to identify the originator of this request. + * @param {string=} params.reason The reason for which the book is removed + * from the library. + * @param {string} params.shelf ID of bookshelf from which to remove a + * volume. + * @param {string=} params.source String to identify the originator of this + * request. * @param {string} params.volumeId ID of volume to remove. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4098,15 +4229,23 @@ export namespace books_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.country ISO-3166-1 code to override the IP-based location. + * @param {string=} params.country ISO-3166-1 code to override the IP-based + * location. * @param {integer=} params.maxResults Maximum number of results to return - * @param {string=} params.projection Restrict information returned to a set of selected fields. - * @param {string=} params.q Full-text search query string in this bookshelf. - * @param {string} params.shelf The bookshelf ID or name retrieve volumes for. - * @param {boolean=} params.showPreorders Set to true to show pre-ordered books. Defaults to false. - * @param {string=} params.source String to identify the originator of this request. - * @param {integer=} params.startIndex Index of the first element to return (starts at 0) - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.projection Restrict information returned to a set + * of selected fields. + * @param {string=} params.q Full-text search query string in this + * bookshelf. + * @param {string} params.shelf The bookshelf ID or name retrieve volumes + * for. + * @param {boolean=} params.showPreorders Set to true to show pre-ordered + * books. Defaults to false. + * @param {string=} params.source String to identify the originator of this + * request. + * @param {integer=} params.startIndex Index of the first element to return + * (starts at 0) + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4225,10 +4364,14 @@ export namespace books_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.contentVersion Volume content version for which this reading position is requested. - * @param {string=} params.source String to identify the originator of this request. - * @param {string} params.volumeId ID of volume for which to retrieve a reading position. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.contentVersion Volume content version for which + * this reading position is requested. + * @param {string=} params.source String to identify the originator of this + * request. + * @param {string} params.volumeId ID of volume for which to retrieve a + * reading position. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4290,14 +4433,22 @@ export namespace books_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.action Action that caused this reading position to be set. - * @param {string=} params.contentVersion Volume content version for which this reading position applies. - * @param {string=} params.deviceCookie Random persistent device cookie optional on set position. - * @param {string} params.position Position string for the new volume reading position. - * @param {string=} params.source String to identify the originator of this request. - * @param {string} params.timestamp RFC 3339 UTC format timestamp associated with this reading position. - * @param {string} params.volumeId ID of volume for which to update the reading position. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.action Action that caused this reading position + * to be set. + * @param {string=} params.contentVersion Volume content version for which + * this reading position applies. + * @param {string=} params.deviceCookie Random persistent device cookie + * optional on set position. + * @param {string} params.position Position string for the new volume + * reading position. + * @param {string=} params.source String to identify the originator of this + * request. + * @param {string} params.timestamp RFC 3339 UTC format timestamp associated + * with this reading position. + * @param {string} params.volumeId ID of volume for which to update the + * reading position. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4433,10 +4584,14 @@ export namespace books_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.locale ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating notification title and body. - * @param {string} params.notification_id String to identify the notification. - * @param {string=} params.source String to identify the originator of this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.locale ISO-639-1 language and ISO-3166-1 country + * code. Ex: 'en_US'. Used for generating notification title and body. + * @param {string} params.notification_id String to identify the + * notification. + * @param {string=} params.source String to identify the originator of this + * request. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4531,8 +4686,10 @@ export namespace books_v1 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {string=} params.locale ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.locale ISO-639-1 language and ISO-3166-1 country + * code. Default is en-US if unset. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4598,11 +4755,17 @@ export namespace books_v1 { * * @param {object=} params Parameters for request * @param {string=} params.categoryId List of category ids requested. - * @param {string=} params.locale ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset. - * @param {string=} params.maxAllowedMaturityRating The maximum allowed maturity rating of returned volumes. Books with a higher maturity rating are filtered out. - * @param {integer=} params.pageSize Number of maximum results per page to be included in the response. - * @param {string=} params.pageToken The value of the nextToken from the previous page. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.locale ISO-639-1 language and ISO-3166-1 country + * code. Default is en-US if unset. + * @param {string=} params.maxAllowedMaturityRating The maximum allowed + * maturity rating of returned volumes. Books with a higher maturity + * rating are filtered out. + * @param {integer=} params.pageSize Number of maximum results per page to + * be included in the response. + * @param {string=} params.pageToken The value of the nextToken from the + * previous page. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4722,10 +4885,15 @@ export namespace books_v1 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {string=} params.locale ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations. - * @param {string=} params.maxAllowedMaturityRating The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out. - * @param {string=} params.source String to identify the originator of this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.locale ISO-639-1 language and ISO-3166-1 country + * code. Ex: 'en_US'. Used for generating recommendations. + * @param {string=} params.maxAllowedMaturityRating The maximum allowed + * maturity rating of returned recommendations. Books with a higher + * maturity rating are filtered out. + * @param {string=} params.source String to identify the originator of this + * request. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4829,7 +4997,8 @@ export namespace books_v1 { * @param {string=} params.product device product * @param {string=} params.serial device serial * @param {string=} params.volumeId Volume id to exercise the offer - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4898,7 +5067,8 @@ export namespace books_v1 { * @param {string=} params.offerId Offer to dimiss * @param {string=} params.product device product * @param {string=} params.serial device serial - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -4968,7 +5138,8 @@ export namespace books_v1 { * @param {string=} params.model device model * @param {string=} params.product device product * @param {string=} params.serial device serial - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5150,7 +5321,8 @@ export namespace books_v1 { * * @param {object} params Parameters for request * @param {string} params.series_id String that identifies the series - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5234,10 +5406,13 @@ export namespace books_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.page_size Number of maximum results per page to be included in the response. - * @param {string=} params.page_token The value of the nextToken from the previous page. + * @param {integer=} params.page_size Number of maximum results per page to + * be included in the response. + * @param {string=} params.page_token The value of the nextToken from the + * previous page. * @param {string} params.series_id String that identifies the series - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5341,14 +5516,19 @@ export namespace books_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.country ISO-3166-1 code to override the IP-based location. - * @param {boolean=} params.includeNonComicsSeries Set to true to include non-comics series. Defaults to false. + * @param {string=} params.country ISO-3166-1 code to override the IP-based + * location. + * @param {boolean=} params.includeNonComicsSeries Set to true to include + * non-comics series. Defaults to false. * @param {string=} params.partner Brand results for partner ID. - * @param {string=} params.projection Restrict information returned to a set of selected fields. - * @param {string=} params.source String to identify the originator of this request. + * @param {string=} params.projection Restrict information returned to a set + * of selected fields. + * @param {string=} params.source String to identify the originator of this + * request. * @param {boolean=} params.user_library_consistent_read * @param {string} params.volumeId ID of volume to retrieve. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5408,21 +5588,32 @@ export namespace books_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.download Restrict to volumes by download availability. + * @param {string=} params.download Restrict to volumes by download + * availability. * @param {string=} params.filter Filter search results. - * @param {string=} params.langRestrict Restrict results to books with this language code. - * @param {string=} params.libraryRestrict Restrict search to this user's library. - * @param {string=} params.maxAllowedMaturityRating The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out. + * @param {string=} params.langRestrict Restrict results to books with this + * language code. + * @param {string=} params.libraryRestrict Restrict search to this user's + * library. + * @param {string=} params.maxAllowedMaturityRating The maximum allowed + * maturity rating of returned recommendations. Books with a higher + * maturity rating are filtered out. * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.orderBy Sort search results. - * @param {string=} params.partner Restrict and brand results for partner ID. + * @param {string=} params.partner Restrict and brand results for partner + * ID. * @param {string=} params.printType Restrict to books or magazines. - * @param {string=} params.projection Restrict information returned to a set of selected fields. + * @param {string=} params.projection Restrict information returned to a set + * of selected fields. * @param {string} params.q Full-text search query string. - * @param {boolean=} params.showPreorders Set to true to show books available for preorder. Defaults to false. - * @param {string=} params.source String to identify the originator of this request. - * @param {integer=} params.startIndex Index of the first result to return (starts at 0) - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {boolean=} params.showPreorders Set to true to show books + * available for preorder. Defaults to false. + * @param {string=} params.source String to identify the originator of this + * request. + * @param {integer=} params.startIndex Index of the first result to return + * (starts at 0) + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5598,11 +5789,16 @@ export namespace books_v1 { * * @param {object} params Parameters for request * @param {string=} params.association Association type. - * @param {string=} params.locale ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations. - * @param {string=} params.maxAllowedMaturityRating The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out. - * @param {string=} params.source String to identify the originator of this request. + * @param {string=} params.locale ISO-639-1 language and ISO-3166-1 country + * code. Ex: 'en_US'. Used for generating recommendations. + * @param {string=} params.maxAllowedMaturityRating The maximum allowed + * maturity rating of returned recommendations. Books with a higher + * maturity rating are filtered out. + * @param {string=} params.source String to identify the originator of this + * request. * @param {string} params.volumeId ID of the source volume. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5711,13 +5907,20 @@ export namespace books_v1 { * * @param {object=} params Parameters for request * @param {string=} params.acquireMethod How the book was acquired - * @param {string=} params.country ISO-3166-1 code to override the IP-based location. - * @param {string=} params.locale ISO-639-1 language and ISO-3166-1 country code. Ex:'en_US'. Used for generating recommendations. + * @param {string=} params.country ISO-3166-1 code to override the IP-based + * location. + * @param {string=} params.locale ISO-639-1 language and ISO-3166-1 country + * code. Ex:'en_US'. Used for generating recommendations. * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.processingState The processing state of the user uploaded volumes to be returned. Applicable only if the UPLOADED is specified in the acquireMethod. - * @param {string=} params.source String to identify the originator of this request. - * @param {integer=} params.startIndex Index of the first result to return (starts at 0) - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.processingState The processing state of the user + * uploaded volumes to be returned. Applicable only if the UPLOADED is + * specified in the acquireMethod. + * @param {string=} params.source String to identify the originator of this + * request. + * @param {integer=} params.startIndex Index of the first result to return + * (starts at 0) + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5833,10 +6036,15 @@ export namespace books_v1 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {string=} params.locale ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations. - * @param {string=} params.maxAllowedMaturityRating The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out. - * @param {string=} params.source String to identify the originator of this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.locale ISO-639-1 language and ISO-3166-1 country + * code. Ex: 'en_US'. Used for generating recommendations. + * @param {string=} params.maxAllowedMaturityRating The maximum allowed + * maturity rating of returned recommendations. Books with a higher + * maturity rating are filtered out. + * @param {string=} params.source String to identify the originator of this + * request. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -5901,11 +6109,14 @@ export namespace books_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.locale ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations. + * @param {string=} params.locale ISO-639-1 language and ISO-3166-1 country + * code. Ex: 'en_US'. Used for generating recommendations. * @param {string} params.rating Rating to be given to the volume. - * @param {string=} params.source String to identify the originator of this request. + * @param {string=} params.source String to identify the originator of this + * request. * @param {string} params.volumeId ID of the source volume. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -6041,13 +6252,19 @@ export namespace books_v1 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {string=} params.locale ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations. + * @param {string=} params.locale ISO-639-1 language and ISO-3166-1 country + * code. Ex: 'en_US'. Used for generating recommendations. * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.processingState The processing state of the user uploaded volumes to be returned. - * @param {string=} params.source String to identify the originator of this request. - * @param {integer=} params.startIndex Index of the first result to return (starts at 0) - * @param {string=} params.volumeId The ids of the volumes to be returned. If not specified all that match the processingState are returned. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string=} params.processingState The processing state of the user + * uploaded volumes to be returned. + * @param {string=} params.source String to identify the originator of this + * request. + * @param {integer=} params.startIndex Index of the first result to return + * (starts at 0) + * @param {string=} params.volumeId The ids of the volumes to be returned. + * If not specified all that match the processingState are returned. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diff --git a/src/apis/calendar/v3.ts b/src/apis/calendar/v3.ts index 269395e3e2b..f36df5d2417 100644 --- a/src/apis/calendar/v3.ts +++ b/src/apis/calendar/v3.ts @@ -16,7 +16,6 @@ import {AxiosPromise} from 'axios'; import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; - import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; // tslint:disable: no-any @@ -309,7 +308,7 @@ export namespace calendar_v3 { * "email" - Reminders are sent via email. - "sms" - * Reminders are sent via SMS. This value is read-only and is ignored on * inserts and updates. SMS reminders are only available for G Suite - * customers. + * customers. Required when adding a notification. */ method?: string; /** @@ -318,8 +317,9 @@ export namespace calendar_v3 { * the calendar. - "eventChange" - Notification sent when an * event is changed. - "eventCancellation" - Notification sent * when an event is cancelled. - "eventResponse" - Notification - * sent when an event is changed. - "agenda" - An agenda with the - * events of the day (sent out in the morning). + * sent when an attendee responds to the event invitation. - + * "agenda" - An agenda with the events of the day (sent out in + * the morning). Required when adding a notification. */ type?: string; } @@ -576,10 +576,10 @@ export namespace calendar_v3 { password?: string; /** * The PIN to access the conference. The maximum length is 128 characters. - * When creating new conference data, populate only the subset of - * {meetingCode, accessCode, passcode, password, pin} fields that match the - * terminology that the conference provider uses. Only the populated fields - * should be displayed. Optional. + * When creating new conference data, populate only the subset + * of {meetingCode, accessCode, passcode, password, pin} fields that match + * the terminology that the conference provider uses. Only the populated + * fields should be displayed. Optional. */ pin?: string; /** @@ -759,7 +759,9 @@ export namespace calendar_v3 { /** * For an instance of a recurring event, this is the time at which this * event would start according to the recurrence data in the recurring event - * identified by recurringEventId. Immutable. + * identified by recurringEventId. It uniquely identifies the instance + * within the recurring event series even if the instance was moved to a + * different time. Immutable. */ originalStartTime?: Schema$EventDateTime; /** @@ -866,7 +868,7 @@ export namespace calendar_v3 { /** * URL link to the attachment. For adding Google Drive file attachments use * the same format as in alternateLink property of the Files resource in the - * Drive API. + * Drive API. Required when adding an attachment. */ fileUrl?: string; /** @@ -898,11 +900,11 @@ export namespace calendar_v3 { /** * The attendee's email address, if available. This field must be * present when adding an attendee. It must be a valid email address as per - * RFC5322. + * RFC5322. Required when adding an attendee. */ email?: string; /** - * The attendee's Profile ID, if available. It corresponds to theid + * The attendee's Profile ID, if available. It corresponds to the id * field in the People collection of the Google+ API */ id?: string; @@ -964,11 +966,13 @@ export namespace calendar_v3 { * Reminders are sent via SMS. These are only available for G Suite * customers. Requests to set SMS reminders for other account types are * ignored. - "popup" - Reminders are sent via a UI popup. + * Required when adding a reminder. */ method?: string; /** * Number of minutes before the start of the event when the reminder should * trigger. Valid values are between 0 and 40320 (4 weeks in minutes). + * Required when adding a reminder. */ minutes?: number; } @@ -1058,13 +1062,13 @@ export namespace calendar_v3 { export interface Schema$FreeBusyRequest { /** * Maximal number of calendars for which FreeBusy information is to be - * provided. Optional. + * provided. Optional. Maximum value is 50. */ calendarExpansionMax?: number; /** * Maximal number of calendar identifiers to be provided for a single group. - * Optional. An error will be returned for a group with more members than - * this value. + * Optional. An error is returned for a group with more members than this + * value. Maximum value is 100. */ groupExpansionMax?: number; /** @@ -1072,11 +1076,11 @@ export namespace calendar_v3 { */ items?: Schema$FreeBusyRequestItem[]; /** - * The end of the interval for the query. + * The end of the interval for the query formatted as per RFC3339. */ timeMax?: string; /** - * The start of the interval for the query. + * The start of the interval for the query formatted as per RFC3339. */ timeMin?: string; /** @@ -1188,9 +1192,13 @@ export namespace calendar_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. + * @param {string} params.calendarId Calendar identifier. To retrieve + * calendar IDs call the calendarList.list method. If you want to access + * the primary calendar of the currently logged in user, use the + * "primary" keyword. * @param {string} params.ruleId ACL rule identifier. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1253,9 +1261,13 @@ export namespace calendar_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. + * @param {string} params.calendarId Calendar identifier. To retrieve + * calendar IDs call the calendarList.list method. If you want to access + * the primary calendar of the currently logged in user, use the + * "primary" keyword. * @param {string} params.ruleId ACL rule identifier. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1316,10 +1328,15 @@ export namespace calendar_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. - * @param {boolean=} params.sendNotifications Whether to send notifications about the calendar sharing change. Optional. The default is True. + * @param {string} params.calendarId Calendar identifier. To retrieve + * calendar IDs call the calendarList.list method. If you want to access + * the primary calendar of the currently logged in user, use the + * "primary" keyword. + * @param {boolean=} params.sendNotifications Whether to send notifications + * about the calendar sharing change. Optional. The default is True. * @param {().AclRule} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1382,12 +1399,31 @@ export namespace calendar_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. - * @param {integer=} params.maxResults Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. - * @param {string=} params.pageToken Token specifying which result page to return. Optional. - * @param {boolean=} params.showDeleted Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False. - * @param {string=} params.syncToken Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.calendarId Calendar identifier. To retrieve + * calendar IDs call the calendarList.list method. If you want to access + * the primary calendar of the currently logged in user, use the + * "primary" keyword. + * @param {integer=} params.maxResults Maximum number of entries returned on + * one result page. By default the value is 100 entries. The page size + * can never be larger than 250 entries. Optional. + * @param {string=} params.pageToken Token specifying which result page to + * return. Optional. + * @param {boolean=} params.showDeleted Whether to include deleted ACLs in + * the result. Deleted ACLs are represented by role equal to "none". + * Deleted ACLs will always be included if syncToken is provided. + * Optional. The default is False. + * @param {string=} params.syncToken Token obtained from the nextSyncToken + * field returned on the last page of results from the previous list + * request. It makes the result of this list request contain only + * entries that have changed since then. All entries deleted since the + * previous list request will always be in the result set and it is not + * allowed to set showDeleted to False. If the syncToken expires, the + * server will respond with a 410 GONE response code and the client + * should clear its storage and perform a full synchronization without + * any syncToken. Learn more about incremental synchronization. + * Optional. The default is to return all entries. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1451,11 +1487,17 @@ export namespace calendar_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. + * @param {string} params.calendarId Calendar identifier. To retrieve + * calendar IDs call the calendarList.list method. If you want to access + * the primary calendar of the currently logged in user, use the + * "primary" keyword. * @param {string} params.ruleId ACL rule identifier. - * @param {boolean=} params.sendNotifications Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True. + * @param {boolean=} params.sendNotifications Whether to send notifications + * about the calendar sharing change. Note that there are no + * notifications on access removal. Optional. The default is True. * @param {().AclRule} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1519,11 +1561,17 @@ export namespace calendar_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. + * @param {string} params.calendarId Calendar identifier. To retrieve + * calendar IDs call the calendarList.list method. If you want to access + * the primary calendar of the currently logged in user, use the + * "primary" keyword. * @param {string} params.ruleId ACL rule identifier. - * @param {boolean=} params.sendNotifications Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True. + * @param {boolean=} params.sendNotifications Whether to send notifications + * about the calendar sharing change. Note that there are no + * notifications on access removal. Optional. The default is True. * @param {().AclRule} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1587,13 +1635,32 @@ export namespace calendar_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. - * @param {integer=} params.maxResults Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. - * @param {string=} params.pageToken Token specifying which result page to return. Optional. - * @param {boolean=} params.showDeleted Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False. - * @param {string=} params.syncToken Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries. + * @param {string} params.calendarId Calendar identifier. To retrieve + * calendar IDs call the calendarList.list method. If you want to access + * the primary calendar of the currently logged in user, use the + * "primary" keyword. + * @param {integer=} params.maxResults Maximum number of entries returned on + * one result page. By default the value is 100 entries. The page size + * can never be larger than 250 entries. Optional. + * @param {string=} params.pageToken Token specifying which result page to + * return. Optional. + * @param {boolean=} params.showDeleted Whether to include deleted ACLs in + * the result. Deleted ACLs are represented by role equal to "none". + * Deleted ACLs will always be included if syncToken is provided. + * Optional. The default is False. + * @param {string=} params.syncToken Token obtained from the nextSyncToken + * field returned on the last page of results from the previous list + * request. It makes the result of this list request contain only + * entries that have changed since then. All entries deleted since the + * previous list request will always be in the result set and it is not + * allowed to set showDeleted to False. If the syncToken expires, the + * server will respond with a 410 GONE response code and the client + * should clear its storage and perform a full synchronization without + * any syncToken. Learn more about incremental synchronization. + * Optional. The default is to return all entries. * @param {().Channel} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1865,13 +1932,17 @@ export namespace calendar_v3 { /** * calendar.calendarList.delete - * @desc Deletes an entry on the user's calendar list. + * @desc Removes a calendar from the user's calendar list. * @alias calendar.calendarList.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.calendarId Calendar identifier. To retrieve + * calendar IDs call the calendarList.list method. If you want to access + * the primary calendar of the currently logged in user, use the + * "primary" keyword. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1930,13 +2001,17 @@ export namespace calendar_v3 { /** * calendar.calendarList.get - * @desc Returns an entry on the user's calendar list. + * @desc Returns a calendar from the user's calendar list. * @alias calendar.calendarList.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.calendarId Calendar identifier. To retrieve + * calendar IDs call the calendarList.list method. If you want to access + * the primary calendar of the currently logged in user, use the + * "primary" keyword. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -1992,14 +2067,19 @@ export namespace calendar_v3 { /** * calendar.calendarList.insert - * @desc Adds an entry to the user's calendar list. + * @desc Inserts an existing calendar into the user's calendar list. * @alias calendar.calendarList.insert * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.colorRgbFormat Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False. + * @param {boolean=} params.colorRgbFormat Whether to use the + * foregroundColor and backgroundColor fields to write the calendar + * colors (RGB). If this feature is used, the index-based colorId field + * will be set to the best matching option automatically. Optional. The + * default is False. * @param {().CalendarListEntry} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2060,18 +2140,39 @@ export namespace calendar_v3 { /** * calendar.calendarList.list - * @desc Returns entries on the user's calendar list. + * @desc Returns the calendars on the user's calendar list. * @alias calendar.calendarList.list * @memberOf! () * * @param {object=} params Parameters for request - * @param {integer=} params.maxResults Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. - * @param {string=} params.minAccessRole The minimum access role for the user in the returned entries. Optional. The default is no restriction. - * @param {string=} params.pageToken Token specifying which result page to return. Optional. - * @param {boolean=} params.showDeleted Whether to include deleted calendar list entries in the result. Optional. The default is False. - * @param {boolean=} params.showHidden Whether to show hidden entries. Optional. The default is False. - * @param {string=} params.syncToken Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.maxResults Maximum number of entries returned on + * one result page. By default the value is 100 entries. The page size + * can never be larger than 250 entries. Optional. + * @param {string=} params.minAccessRole The minimum access role for the + * user in the returned entries. Optional. The default is no + * restriction. + * @param {string=} params.pageToken Token specifying which result page to + * return. Optional. + * @param {boolean=} params.showDeleted Whether to include deleted calendar + * list entries in the result. Optional. The default is False. + * @param {boolean=} params.showHidden Whether to show hidden entries. + * Optional. The default is False. + * @param {string=} params.syncToken Token obtained from the nextSyncToken + * field returned on the last page of results from the previous list + * request. It makes the result of this list request contain only + * entries that have changed since then. If only read-only fields such + * as calendar properties or ACLs have changed, the entry won't be + * returned. All entries deleted and hidden since the previous list + * request will always be in the result set and it is not allowed to set + * showDeleted neither showHidden to False. To ensure client state + * consistency minAccessRole query parameter cannot be specified + * together with nextSyncToken. If the syncToken expires, the server + * will respond with a 410 GONE response code and the client should + * clear its storage and perform a full synchronization without any + * syncToken. Learn more about incremental synchronization. Optional. + * The default is to return all entries. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2131,16 +2232,24 @@ export namespace calendar_v3 { /** * calendar.calendarList.patch - * @desc Updates an entry on the user's calendar list. This method supports - * patch semantics. + * @desc Updates an existing calendar on the user's calendar list. This + * method supports patch semantics. * @alias calendar.calendarList.patch * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. - * @param {boolean=} params.colorRgbFormat Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False. + * @param {string} params.calendarId Calendar identifier. To retrieve + * calendar IDs call the calendarList.list method. If you want to access + * the primary calendar of the currently logged in user, use the + * "primary" keyword. + * @param {boolean=} params.colorRgbFormat Whether to use the + * foregroundColor and backgroundColor fields to write the calendar + * colors (RGB). If this feature is used, the index-based colorId field + * will be set to the best matching option automatically. Optional. The + * default is False. * @param {().CalendarListEntry} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2200,15 +2309,23 @@ export namespace calendar_v3 { /** * calendar.calendarList.update - * @desc Updates an entry on the user's calendar list. + * @desc Updates an existing calendar on the user's calendar list. * @alias calendar.calendarList.update * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. - * @param {boolean=} params.colorRgbFormat Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False. + * @param {string} params.calendarId Calendar identifier. To retrieve + * calendar IDs call the calendarList.list method. If you want to access + * the primary calendar of the currently logged in user, use the + * "primary" keyword. + * @param {boolean=} params.colorRgbFormat Whether to use the + * foregroundColor and backgroundColor fields to write the calendar + * colors (RGB). If this feature is used, the index-based colorId field + * will be set to the best matching option automatically. Optional. The + * default is False. * @param {().CalendarListEntry} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2274,14 +2391,35 @@ export namespace calendar_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.maxResults Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. - * @param {string=} params.minAccessRole The minimum access role for the user in the returned entries. Optional. The default is no restriction. - * @param {string=} params.pageToken Token specifying which result page to return. Optional. - * @param {boolean=} params.showDeleted Whether to include deleted calendar list entries in the result. Optional. The default is False. - * @param {boolean=} params.showHidden Whether to show hidden entries. Optional. The default is False. - * @param {string=} params.syncToken Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries. + * @param {integer=} params.maxResults Maximum number of entries returned on + * one result page. By default the value is 100 entries. The page size + * can never be larger than 250 entries. Optional. + * @param {string=} params.minAccessRole The minimum access role for the + * user in the returned entries. Optional. The default is no + * restriction. + * @param {string=} params.pageToken Token specifying which result page to + * return. Optional. + * @param {boolean=} params.showDeleted Whether to include deleted calendar + * list entries in the result. Optional. The default is False. + * @param {boolean=} params.showHidden Whether to show hidden entries. + * Optional. The default is False. + * @param {string=} params.syncToken Token obtained from the nextSyncToken + * field returned on the last page of results from the previous list + * request. It makes the result of this list request contain only + * entries that have changed since then. If only read-only fields such + * as calendar properties or ACLs have changed, the entry won't be + * returned. All entries deleted and hidden since the previous list + * request will always be in the result set and it is not allowed to set + * showDeleted neither showHidden to False. To ensure client state + * consistency minAccessRole query parameter cannot be specified + * together with nextSyncToken. If the syncToken expires, the server + * will respond with a 410 GONE response code and the client should + * clear its storage and perform a full synchronization without any + * syncToken. Learn more about incremental synchronization. Optional. + * The default is to return all entries. * @param {().Channel} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2554,8 +2692,12 @@ export namespace calendar_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.calendarId Calendar identifier. To retrieve + * calendar IDs call the calendarList.list method. If you want to access + * the primary calendar of the currently logged in user, use the + * "primary" keyword. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2618,8 +2760,12 @@ export namespace calendar_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.calendarId Calendar identifier. To retrieve + * calendar IDs call the calendarList.list method. If you want to access + * the primary calendar of the currently logged in user, use the + * "primary" keyword. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2681,8 +2827,12 @@ export namespace calendar_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {string} params.calendarId Calendar identifier. To retrieve + * calendar IDs call the calendarList.list method. If you want to access + * the primary calendar of the currently logged in user, use the + * "primary" keyword. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2743,7 +2893,8 @@ export namespace calendar_v3 { * * @param {object} params Parameters for request * @param {().Calendar} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2807,9 +2958,13 @@ export namespace calendar_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. + * @param {string} params.calendarId Calendar identifier. To retrieve + * calendar IDs call the calendarList.list method. If you want to access + * the primary calendar of the currently logged in user, use the + * "primary" keyword. * @param {().Calendar} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -2872,9 +3027,13 @@ export namespace calendar_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. + * @param {string} params.calendarId Calendar identifier. To retrieve + * calendar IDs call the calendarList.list method. If you want to access + * the primary calendar of the currently logged in user, use the + * "primary" keyword. * @param {().Calendar} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3039,7 +3198,8 @@ export namespace calendar_v3 { * * @param {object} params Parameters for request * @param {().Channel} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3127,7 +3287,8 @@ export namespace calendar_v3 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3207,10 +3368,15 @@ export namespace calendar_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. + * @param {string} params.calendarId Calendar identifier. To retrieve + * calendar IDs call the calendarList.list method. If you want to access + * the primary calendar of the currently logged in user, use the + * "primary" keyword. * @param {string} params.eventId Event identifier. - * @param {boolean=} params.sendNotifications Whether to send notifications about the deletion of the event. Optional. The default is False. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {boolean=} params.sendNotifications Whether to send notifications + * about the deletion of the event. Optional. The default is False. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3273,12 +3439,25 @@ export namespace calendar_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.alwaysIncludeEmail Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False. - * @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. + * @param {boolean=} params.alwaysIncludeEmail Whether to always include a + * value in the email field for the organizer, creator and attendees, + * even if no real email is available (i.e. a generated, non-working + * value will be provided). The use of this option is discouraged and + * should only be used by clients which cannot handle the absence of an + * email address value in the mentioned places. Optional. The default is + * False. + * @param {string} params.calendarId Calendar identifier. To retrieve + * calendar IDs call the calendarList.list method. If you want to access + * the primary calendar of the currently logged in user, use the + * "primary" keyword. * @param {string} params.eventId Event identifier. - * @param {integer=} params.maxAttendees The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. - * @param {string=} params.timeZone Time zone used in the response. Optional. The default is the time zone of the calendar. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {integer=} params.maxAttendees The maximum number of attendees to + * include in the response. If there are more than the specified number + * of attendees, only the participant is returned. Optional. + * @param {string=} params.timeZone Time zone used in the response. + * Optional. The default is the time zone of the calendar. + * @param {object} [options] Optionally override request options, such as + * `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3340,11 +3519,20 @@ export namespace calendar_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.calendarId Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. - * @param {integer=} params.conferenceDataVersion Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0. - * @param {boolean=} params.supportsAttachments Whether API client performing operation supports event attachments. Optional. The default is False. + * @param {string} params.calendarId Calendar identifier. To retrieve calendar + * IDs call the calendarList.list method. If you want to access the primary + * calendar of the currently logged in user, use the "primary" keyword. + * @param {integer=} params.conferenceDataVersion Version number of conference + * data supported by the API client. Version 0 assumes no conference data + * support and ignores conference data in the event's body. Version 1 + * enables support for copying of ConferenceData as well as for creating new + * conferences using the createRequest field of conferenceData. The default + * is 0. + * @param {boolean=} params.supportsAttachments Whether API client performing + * operation supports event attachments. Optional. The default is False. * @param {().Event} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {object} [options] Optionally override request options, such as `url`, + * `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ @@ -3447,18 +3635,43 @@ import(paramsOrCallback?: Params$Resource$Events$Import|BodyResponseCallback