From 341115a1196711088a1a9dcef14aee92830b8375 Mon Sep 17 00:00:00 2001 From: Justin Beckwith Date: Fri, 9 Nov 2018 10:47:43 -0800 Subject: [PATCH] feat: run the generator (#1430) --- src/apis/abusiveexperiencereport/README.md | 2 +- src/apis/abusiveexperiencereport/v1.ts | 61 +- src/apis/acceleratedmobilepageurl/v1.ts | 53 +- src/apis/accesscontextmanager/v1beta.ts | 100 +- src/apis/adexchangebuyer/v1.2.ts | 48 +- src/apis/adexchangebuyer/v1.3.ts | 83 +- src/apis/adexchangebuyer/v1.4.ts | 128 +- src/apis/adexchangebuyer2/v2beta1.ts | 251 +- src/apis/adexperiencereport/README.md | 2 +- src/apis/adexperiencereport/v1.ts | 58 +- src/apis/admin/datatransfer_v1.ts | 45 +- src/apis/admin/directory_v1.ts | 318 +- src/apis/admin/reports_v1.ts | 49 +- src/apis/adsense/v1.4.ts | 141 +- src/apis/adsensehost/v4.1.ts | 106 +- src/apis/alertcenter/README.md | 2 +- src/apis/alertcenter/v1beta1.ts | 383 +- src/apis/analytics/v2.4.ts | 51 +- src/apis/analytics/v3.ts | 296 +- src/apis/analyticsreporting/v4.ts | 53 +- src/apis/androiddeviceprovisioning/v1.ts | 130 +- src/apis/androidenterprise/v1.ts | 340 +- src/apis/androidmanagement/v1.ts | 178 +- src/apis/androidpublisher/v1.1.ts | 41 +- src/apis/androidpublisher/v1.ts | 38 +- src/apis/androidpublisher/v2.ts | 197 +- src/apis/androidpublisher/v3.ts | 179 +- src/apis/appengine/README.md | 2 +- src/apis/appengine/v1.ts | 164 +- src/apis/appengine/v1alpha.ts | 99 +- src/apis/appengine/v1beta.ts | 164 +- src/apis/appengine/v1beta4.ts | 110 +- src/apis/appengine/v1beta5.ts | 111 +- src/apis/appsactivity/v1.ts | 36 +- src/apis/appstate/v1.ts | 44 +- src/apis/bigquery/v2.ts | 144 +- src/apis/bigquerydatatransfer/v1.ts | 135 +- src/apis/binaryauthorization/v1beta1.ts | 90 +- src/apis/blogger/v2.ts | 52 +- src/apis/blogger/v3.ts | 106 +- src/apis/books/v1.ts | 178 +- src/apis/calendar/v3.ts | 114 +- src/apis/chat/v1.ts | 73 +- src/apis/civicinfo/v2.ts | 62 +- src/apis/classroom/v1.ts | 195 +- src/apis/cloudasset/v1beta1.ts | 109 +- src/apis/cloudbilling/v1.ts | 86 +- src/apis/cloudbuild/v1.ts | 97 +- src/apis/clouddebugger/v2.ts | 75 +- src/apis/clouderrorreporting/v1beta1.ts | 69 +- src/apis/cloudfunctions/v1.ts | 575 +- src/apis/cloudfunctions/v1beta2.ts | 96 +- src/apis/cloudiot/v1.ts | 132 +- src/apis/cloudkms/v1.ts | 132 +- src/apis/cloudprofiler/v2.ts | 60 +- src/apis/cloudresourcemanager/README.md | 2 +- src/apis/cloudresourcemanager/v1.ts | 170 +- src/apis/cloudresourcemanager/v1beta1.ts | 109 +- src/apis/cloudresourcemanager/v2.ts | 82 +- src/apis/cloudresourcemanager/v2beta1.ts | 82 +- .../{serviceuser => cloudsearch}/README.md | 6 +- .../{serviceuser => cloudsearch}/index.ts | 16 +- .../{serviceuser => cloudsearch}/package.json | 4 +- src/apis/cloudsearch/v1.ts | 5862 +++ src/apis/cloudshell/v1.ts | 61 +- src/apis/cloudshell/v1alpha1.ts | 69 +- src/apis/cloudtasks/v2beta2.ts | 155 +- src/apis/cloudtasks/v2beta3.ts | 153 +- src/apis/cloudtrace/v1.ts | 60 +- src/apis/cloudtrace/v2.ts | 57 +- src/apis/composer/v1.ts | 75 +- src/apis/composer/v1beta1.ts | 88 +- src/apis/compute/alpha.ts | 3314 +- src/apis/compute/beta.ts | 2118 +- src/apis/compute/v1.ts | 1824 +- src/apis/container/README.md | 2 +- src/apis/container/v1.ts | 231 +- src/apis/container/v1beta1.ts | 237 +- src/apis/content/index.ts | 11 +- src/apis/content/v2.ts | 459 +- src/apis/content/v2sandbox.ts | 5283 --- src/apis/customsearch/v1.ts | 39 +- src/apis/dataflow/v1b3.ts | 164 +- src/apis/dataproc/v1.ts | 234 +- src/apis/dataproc/v1beta2.ts | 277 +- src/apis/datastore/v1.ts | 92 +- src/apis/datastore/v1beta1.ts | 55 +- src/apis/datastore/v1beta3.ts | 70 +- src/apis/deploymentmanager/alpha.ts | 130 +- src/apis/deploymentmanager/v2.ts | 78 +- src/apis/deploymentmanager/v2beta.ts | 120 +- src/apis/dfareporting/index.ts | 12 +- src/apis/dfareporting/v2.8.ts | 38703 ---------------- src/apis/dfareporting/v3.0.ts | 574 +- src/apis/dfareporting/v3.1.ts | 578 +- src/apis/dfareporting/v3.2.ts | 578 +- src/apis/dialogflow/README.md | 2 +- src/apis/dialogflow/v2.ts | 238 +- src/apis/dialogflow/v2beta1.ts | 5667 +-- src/apis/digitalassetlinks/v1.ts | 59 +- src/apis/discovery/v1.ts | 38 +- src/apis/dlp/v2.ts | 210 +- src/apis/dns/v1.ts | 72 +- src/apis/dns/v1beta2.ts | 116 +- src/apis/dns/v2beta1.ts | 72 +- src/apis/doubleclickbidmanager/v1.ts | 58 +- src/apis/doubleclicksearch/v2.ts | 60 +- src/apis/drive/v2.ts | 186 +- src/apis/drive/v3.ts | 120 +- src/apis/file/v1beta1.ts | 84 +- src/apis/firebasedynamiclinks/v1.ts | 65 +- src/apis/firebasehosting/v1beta1.ts | 87 +- src/apis/firebaserules/v1.ts | 83 +- src/apis/firestore/v1.ts | 1391 +- src/apis/firestore/v1beta1.ts | 108 +- src/apis/firestore/v1beta2.ts | 78 +- src/apis/fitness/v1.ts | 76 +- src/apis/fusiontables/v1.ts | 99 +- src/apis/fusiontables/v2.ts | 105 +- src/apis/games/v1.ts | 173 +- .../gamesConfiguration/v1configuration.ts | 73 +- src/apis/gamesManagement/v1management.ts | 106 +- src/apis/genomics/README.md | 2 +- src/apis/genomics/v1.ts | 192 +- src/apis/genomics/v1alpha2.ts | 76 +- src/apis/genomics/v2alpha1.ts | 66 +- src/apis/gmail/v1.ts | 227 +- src/apis/groupsmigration/v1.ts | 36 +- src/apis/groupssettings/v1.ts | 40 +- src/apis/iam/v1.ts | 145 +- src/apis/iamcredentials/README.md | 2 +- src/apis/iamcredentials/v1.ts | 69 +- src/apis/iap/v1beta1.ts | 105 +- src/apis/identitytoolkit/v3.ts | 94 +- src/apis/index.ts | 8 +- src/apis/indexing/README.md | 2 +- src/apis/indexing/v3.ts | 60 +- src/apis/jobs/v2.ts | 102 +- src/apis/jobs/v3.ts | 124 +- src/apis/jobs/v3p1beta1.ts | 127 +- src/apis/kgsearch/v1.ts | 53 +- src/apis/language/README.md | 2 +- src/apis/language/v1.ts | 75 +- src/apis/language/v1beta1.ts | 69 +- src/apis/language/v1beta2.ts | 75 +- src/apis/licensing/v1.ts | 55 +- src/apis/logging/v2.ts | 264 +- src/apis/logging/v2beta1.ts | 1448 +- src/apis/manufacturers/v1.ts | 63 +- src/apis/mirror/v1.ts | 90 +- src/apis/ml/v1.ts | 140 +- src/apis/monitoring/v3.ts | 1621 +- src/apis/oauth2/v1.ts | 52 +- src/apis/oauth2/v2.ts | 43 +- src/apis/oslogin/v1.ts | 79 +- src/apis/oslogin/v1alpha.ts | 84 +- src/apis/oslogin/v1beta.ts | 79 +- src/apis/pagespeedonline/v1.ts | 37 +- src/apis/pagespeedonline/v2.ts | 37 +- src/apis/pagespeedonline/v4.ts | 37 +- src/apis/partners/v2.ts | 93 +- src/apis/people/v1.ts | 89 +- src/apis/playcustomapp/v1.ts | 37 +- src/apis/plus/v1.ts | 54 +- src/apis/plusDomains/v1.ts | 79 +- src/apis/poly/README.md | 2 +- src/apis/poly/v1.ts | 61 +- src/apis/proximitybeacon/v1beta1.ts | 95 +- src/apis/pubsub/v1.ts | 147 +- src/apis/pubsub/v1beta1a.ts | 91 +- src/apis/pubsub/v1beta2.ts | 111 +- src/apis/redis/v1.ts | 88 +- src/apis/redis/v1beta1.ts | 88 +- src/apis/replicapool/v1beta1.ts | 55 +- src/apis/replicapoolupdater/v1beta1.ts | 64 +- src/apis/reseller/v1.ts | 81 +- src/apis/runtimeconfig/v1.ts | 59 +- src/apis/runtimeconfig/v1beta1.ts | 133 +- src/apis/safebrowsing/v4.ts | 70 +- src/apis/script/README.md | 2 +- src/apis/script/v1.ts | 107 +- src/apis/searchconsole/v1.ts | 54 +- src/apis/servicebroker/v1.ts | 58 +- src/apis/servicebroker/v1alpha1.ts | 99 +- src/apis/servicebroker/v1beta1.ts | 114 +- src/apis/serviceconsumermanagement/v1.ts | 83 +- src/apis/servicecontrol/v1.ts | 522 +- src/apis/servicemanagement/v1.ts | 120 +- src/apis/servicenetworking/v1beta.ts | 80 +- src/apis/serviceusage/v1.ts | 77 +- src/apis/serviceusage/v1beta1.ts | 71 +- src/apis/serviceuser/v1.ts | 2420 - src/apis/sheets/v4.ts | 101 +- src/apis/siteVerification/v1.ts | 53 +- src/apis/slides/v1.ts | 75 +- src/apis/sourcerepo/README.md | 2 +- src/apis/sourcerepo/v1.ts | 81 +- src/apis/spanner/v1.ts | 171 +- src/apis/speech/v1.ts | 60 +- src/apis/speech/v1beta1.ts | 61 +- src/apis/sqladmin/v1beta4.ts | 161 +- src/apis/storage/v1.ts | 162 +- src/apis/storage/v1beta1.ts | 94 +- src/apis/storage/v1beta2.ts | 120 +- src/apis/storagetransfer/v1.ts | 83 +- src/apis/streetviewpublish/v1.ts | 109 +- src/apis/surveys/v2.ts | 50 +- src/apis/tagmanager/v1.ts | 181 +- src/apis/tagmanager/v2.ts | 250 +- src/apis/tasks/v1.ts | 62 +- src/apis/testing/v1.ts | 83 +- src/apis/texttospeech/v1.ts | 55 +- src/apis/texttospeech/v1beta1.ts | 55 +- src/apis/toolresults/v1beta3.ts | 108 +- src/apis/tpu/v1.ts | 106 +- src/apis/tpu/v1alpha1.ts | 106 +- src/apis/translate/README.md | 2 +- src/apis/translate/v2.ts | 72 +- src/apis/urlshortener/v1.ts | 40 +- src/apis/vault/v1.ts | 524 +- src/apis/videointelligence/v1.ts | 442 +- src/apis/videointelligence/v1beta2.ts | 432 +- src/apis/videointelligence/v1p1beta1.ts | 349 +- src/apis/vision/v1.ts | 2416 +- src/apis/vision/v1p1beta1.ts | 508 +- src/apis/vision/v1p2beta1.ts | 508 +- src/apis/webfonts/v1.ts | 36 +- src/apis/webmasters/v3.ts | 65 +- src/apis/websecurityscanner/README.md | 2 +- src/apis/websecurityscanner/v1alpha.ts | 92 +- src/apis/youtube/v3.ts | 219 +- src/apis/youtubeAnalytics/v1.ts | 52 +- src/apis/youtubeAnalytics/v1beta1.ts | 52 +- src/apis/youtubeAnalytics/v2.ts | 69 +- src/apis/youtubereporting/v1.ts | 68 +- src/generator/templates/api-endpoint.njk | 18 +- src/generator/templates/package.json.njk | 2 +- src/index.ts | 4 +- 238 files changed, 37571 insertions(+), 60277 deletions(-) rename src/apis/{serviceuser => cloudsearch}/README.md (81%) rename src/apis/{serviceuser => cloudsearch}/index.ts (63%) rename src/apis/{serviceuser => cloudsearch}/package.json (88%) create mode 100644 src/apis/cloudsearch/v1.ts delete mode 100644 src/apis/content/v2sandbox.ts delete mode 100644 src/apis/dfareporting/v2.8.ts delete mode 100644 src/apis/serviceuser/v1.ts diff --git a/src/apis/abusiveexperiencereport/README.md b/src/apis/abusiveexperiencereport/README.md index 84a3ae2039..43d66aa73a 100644 --- a/src/apis/abusiveexperiencereport/README.md +++ b/src/apis/abusiveexperiencereport/README.md @@ -2,7 +2,7 @@ # @google/abusiveexperiencereport -> View Abusive Experience Report data, and get a list of sites that have a significant number of abusive experiences. +> Views Abusive Experience Report data, and gets a list of sites that have a significant number of abusive experiences. ## Installation diff --git a/src/apis/abusiveexperiencereport/v1.ts b/src/apis/abusiveexperiencereport/v1.ts index 6e609f2479..0b05aab047 100644 --- a/src/apis/abusiveexperiencereport/v1.ts +++ b/src/apis/abusiveexperiencereport/v1.ts @@ -29,10 +29,61 @@ export namespace abusiveexperiencereport_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Abusive Experience Report API * - * View Abusive Experience Report data, and get a list of sites that have a + * Views Abusive Experience Report data, and gets a list of sites that have a * significant number of abusive experiences. * * @example @@ -68,8 +119,7 @@ export namespace abusiveexperiencereport_v1 { } /** - * Response message for GetSiteSummary. Do not confuse with same message in - * google.ads.experiencereport.v1 + * Response message for GetSiteSummary. */ export interface Schema$SiteSummaryResponse { /** @@ -186,7 +236,7 @@ export namespace abusiveexperiencereport_v1 { } } - export interface Params$Resource$Sites$Get { + export interface Params$Resource$Sites$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -285,7 +335,8 @@ export namespace abusiveexperiencereport_v1 { } } - export interface Params$Resource$Violatingsites$List { + export interface Params$Resource$Violatingsites$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/acceleratedmobilepageurl/v1.ts b/src/apis/acceleratedmobilepageurl/v1.ts index c96838235e..342a60a520 100644 --- a/src/apis/acceleratedmobilepageurl/v1.ts +++ b/src/apis/acceleratedmobilepageurl/v1.ts @@ -29,6 +29,57 @@ export namespace acceleratedmobilepageurl_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Accelerated Mobile Pages (AMP) URL API * @@ -215,7 +266,7 @@ export namespace acceleratedmobilepageurl_v1 { } } - export interface Params$Resource$Ampurls$Batchget { + export interface Params$Resource$Ampurls$Batchget extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/accesscontextmanager/v1beta.ts b/src/apis/accesscontextmanager/v1beta.ts index 2a6aea2820..230886672d 100644 --- a/src/apis/accesscontextmanager/v1beta.ts +++ b/src/apis/accesscontextmanager/v1beta.ts @@ -29,6 +29,57 @@ export namespace accesscontextmanager_v1beta { version: 'v1beta'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Access Context Manager API * @@ -125,7 +176,7 @@ export namespace accesscontextmanager_v1beta { */ parent?: string; /** - * Human readable title. Does not affect behavior. + * Required. Human readable title. Does not affect behavior. */ title?: string; /** @@ -851,7 +902,8 @@ export namespace accesscontextmanager_v1beta { } } - export interface Params$Resource$Accesspolicies$Create { + export interface Params$Resource$Accesspolicies$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -863,7 +915,8 @@ export namespace accesscontextmanager_v1beta { */ requestBody?: Schema$AccessPolicy; } - export interface Params$Resource$Accesspolicies$Delete { + export interface Params$Resource$Accesspolicies$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -875,7 +928,8 @@ export namespace accesscontextmanager_v1beta { */ name?: string; } - export interface Params$Resource$Accesspolicies$Get { + export interface Params$Resource$Accesspolicies$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -887,7 +941,8 @@ export namespace accesscontextmanager_v1beta { */ name?: string; } - export interface Params$Resource$Accesspolicies$List { + export interface Params$Resource$Accesspolicies$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -908,7 +963,8 @@ export namespace accesscontextmanager_v1beta { */ parent?: string; } - export interface Params$Resource$Accesspolicies$Patch { + export interface Params$Resource$Accesspolicies$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1291,7 +1347,8 @@ export namespace accesscontextmanager_v1beta { } } - export interface Params$Resource$Accesspolicies$Accesslevels$Create { + export interface Params$Resource$Accesspolicies$Accesslevels$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1308,7 +1365,8 @@ export namespace accesscontextmanager_v1beta { */ requestBody?: Schema$AccessLevel; } - export interface Params$Resource$Accesspolicies$Accesslevels$Delete { + export interface Params$Resource$Accesspolicies$Accesslevels$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1320,7 +1378,8 @@ export namespace accesscontextmanager_v1beta { */ name?: string; } - export interface Params$Resource$Accesspolicies$Accesslevels$Get { + export interface Params$Resource$Accesspolicies$Accesslevels$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1341,7 +1400,8 @@ export namespace accesscontextmanager_v1beta { */ name?: string; } - export interface Params$Resource$Accesspolicies$Accesslevels$List { + export interface Params$Resource$Accesspolicies$Accesslevels$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1368,7 +1428,8 @@ export namespace accesscontextmanager_v1beta { */ parent?: string; } - export interface Params$Resource$Accesspolicies$Accesslevels$Patch { + export interface Params$Resource$Accesspolicies$Accesslevels$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1762,7 +1823,8 @@ export namespace accesscontextmanager_v1beta { } } - export interface Params$Resource$Accesspolicies$Serviceperimeters$Create { + export interface Params$Resource$Accesspolicies$Serviceperimeters$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1779,7 +1841,8 @@ export namespace accesscontextmanager_v1beta { */ requestBody?: Schema$ServicePerimeter; } - export interface Params$Resource$Accesspolicies$Serviceperimeters$Delete { + export interface Params$Resource$Accesspolicies$Serviceperimeters$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1791,7 +1854,8 @@ export namespace accesscontextmanager_v1beta { */ name?: string; } - export interface Params$Resource$Accesspolicies$Serviceperimeters$Get { + export interface Params$Resource$Accesspolicies$Serviceperimeters$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1803,7 +1867,8 @@ export namespace accesscontextmanager_v1beta { */ name?: string; } - export interface Params$Resource$Accesspolicies$Serviceperimeters$List { + export interface Params$Resource$Accesspolicies$Serviceperimeters$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1824,7 +1889,8 @@ export namespace accesscontextmanager_v1beta { */ parent?: string; } - export interface Params$Resource$Accesspolicies$Serviceperimeters$Patch { + export interface Params$Resource$Accesspolicies$Serviceperimeters$Patch + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1925,7 +1991,7 @@ export namespace accesscontextmanager_v1beta { } } - export interface Params$Resource$Operations$Get { + export interface Params$Resource$Operations$Get extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/adexchangebuyer/v1.2.ts b/src/apis/adexchangebuyer/v1.2.ts index 0bf102a338..f667373228 100644 --- a/src/apis/adexchangebuyer/v1.2.ts +++ b/src/apis/adexchangebuyer/v1.2.ts @@ -29,6 +29,40 @@ export namespace adexchangebuyer_v1_2 { version: 'v1_2'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Ad Exchange Buyer API * @@ -526,7 +560,7 @@ export namespace adexchangebuyer_v1_2 { } } - export interface Params$Resource$Accounts$Get { + export interface Params$Resource$Accounts$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -537,13 +571,13 @@ export namespace adexchangebuyer_v1_2 { */ id?: number; } - export interface Params$Resource$Accounts$List { + export interface Params$Resource$Accounts$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; } - export interface Params$Resource$Accounts$Patch { + export interface Params$Resource$Accounts$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -559,7 +593,7 @@ export namespace adexchangebuyer_v1_2 { */ requestBody?: Schema$Account; } - export interface Params$Resource$Accounts$Update { + export interface Params$Resource$Accounts$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -786,7 +820,7 @@ export namespace adexchangebuyer_v1_2 { } } - export interface Params$Resource$Creatives$Get { + export interface Params$Resource$Creatives$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -801,7 +835,7 @@ export namespace adexchangebuyer_v1_2 { */ buyerCreativeId?: string; } - export interface Params$Resource$Creatives$Insert { + export interface Params$Resource$Creatives$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -813,7 +847,7 @@ export namespace adexchangebuyer_v1_2 { */ requestBody?: Schema$Creative; } - export interface Params$Resource$Creatives$List { + export interface Params$Resource$Creatives$List extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/adexchangebuyer/v1.3.ts b/src/apis/adexchangebuyer/v1.3.ts index 1b5cec98b1..f320245054 100644 --- a/src/apis/adexchangebuyer/v1.3.ts +++ b/src/apis/adexchangebuyer/v1.3.ts @@ -29,6 +29,40 @@ export namespace adexchangebuyer_v1_3 { version: 'v1_3'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Ad Exchange Buyer API * @@ -935,7 +969,7 @@ export namespace adexchangebuyer_v1_3 { } } - export interface Params$Resource$Accounts$Get { + export interface Params$Resource$Accounts$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -946,13 +980,13 @@ export namespace adexchangebuyer_v1_3 { */ id?: number; } - export interface Params$Resource$Accounts$List { + export interface Params$Resource$Accounts$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; } - export interface Params$Resource$Accounts$Patch { + export interface Params$Resource$Accounts$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -968,7 +1002,7 @@ export namespace adexchangebuyer_v1_3 { */ requestBody?: Schema$Account; } - export interface Params$Resource$Accounts$Update { + export interface Params$Resource$Accounts$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1126,7 +1160,7 @@ export namespace adexchangebuyer_v1_3 { } } - export interface Params$Resource$Billinginfo$Get { + export interface Params$Resource$Billinginfo$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1137,7 +1171,7 @@ export namespace adexchangebuyer_v1_3 { */ accountId?: number; } - export interface Params$Resource$Billinginfo$List { + export interface Params$Resource$Billinginfo$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1358,7 +1392,7 @@ export namespace adexchangebuyer_v1_3 { } } - export interface Params$Resource$Budget$Get { + export interface Params$Resource$Budget$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1373,7 +1407,7 @@ export namespace adexchangebuyer_v1_3 { */ billingId?: string; } - export interface Params$Resource$Budget$Patch { + export interface Params$Resource$Budget$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1393,7 +1427,7 @@ export namespace adexchangebuyer_v1_3 { */ requestBody?: Schema$Budget; } - export interface Params$Resource$Budget$Update { + export interface Params$Resource$Budget$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1626,7 +1660,7 @@ export namespace adexchangebuyer_v1_3 { } } - export interface Params$Resource$Creatives$Get { + export interface Params$Resource$Creatives$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1641,7 +1675,7 @@ export namespace adexchangebuyer_v1_3 { */ buyerCreativeId?: string; } - export interface Params$Resource$Creatives$Insert { + export interface Params$Resource$Creatives$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1653,7 +1687,7 @@ export namespace adexchangebuyer_v1_3 { */ requestBody?: Schema$Creative; } - export interface Params$Resource$Creatives$List { + export interface Params$Resource$Creatives$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1824,7 +1858,7 @@ export namespace adexchangebuyer_v1_3 { } } - export interface Params$Resource$Directdeals$Get { + export interface Params$Resource$Directdeals$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1835,7 +1869,7 @@ export namespace adexchangebuyer_v1_3 { */ id?: string; } - export interface Params$Resource$Directdeals$List { + export interface Params$Resource$Directdeals$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1927,7 +1961,8 @@ export namespace adexchangebuyer_v1_3 { } } - export interface Params$Resource$Performancereport$List { + export interface Params$Resource$Performancereport$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2387,7 +2422,8 @@ export namespace adexchangebuyer_v1_3 { } } - export interface Params$Resource$Pretargetingconfig$Delete { + export interface Params$Resource$Pretargetingconfig$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2402,7 +2438,8 @@ export namespace adexchangebuyer_v1_3 { */ configId?: string; } - export interface Params$Resource$Pretargetingconfig$Get { + export interface Params$Resource$Pretargetingconfig$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2417,7 +2454,8 @@ export namespace adexchangebuyer_v1_3 { */ configId?: string; } - export interface Params$Resource$Pretargetingconfig$Insert { + export interface Params$Resource$Pretargetingconfig$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2433,7 +2471,8 @@ export namespace adexchangebuyer_v1_3 { */ requestBody?: Schema$PretargetingConfig; } - export interface Params$Resource$Pretargetingconfig$List { + export interface Params$Resource$Pretargetingconfig$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2444,7 +2483,8 @@ export namespace adexchangebuyer_v1_3 { */ accountId?: string; } - export interface Params$Resource$Pretargetingconfig$Patch { + export interface Params$Resource$Pretargetingconfig$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2464,7 +2504,8 @@ export namespace adexchangebuyer_v1_3 { */ requestBody?: Schema$PretargetingConfig; } - export interface Params$Resource$Pretargetingconfig$Update { + export interface Params$Resource$Pretargetingconfig$Update extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/adexchangebuyer/v1.4.ts b/src/apis/adexchangebuyer/v1.4.ts index 0ee27a1912..891fb53315 100644 --- a/src/apis/adexchangebuyer/v1.4.ts +++ b/src/apis/adexchangebuyer/v1.4.ts @@ -29,6 +29,40 @@ export namespace adexchangebuyer_v1_4 { version: 'v1_4'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Ad Exchange Buyer API * @@ -2026,7 +2060,7 @@ export namespace adexchangebuyer_v1_4 { } } - export interface Params$Resource$Accounts$Get { + export interface Params$Resource$Accounts$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2037,13 +2071,13 @@ export namespace adexchangebuyer_v1_4 { */ id?: number; } - export interface Params$Resource$Accounts$List { + export interface Params$Resource$Accounts$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; } - export interface Params$Resource$Accounts$Patch { + export interface Params$Resource$Accounts$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2063,7 +2097,7 @@ export namespace adexchangebuyer_v1_4 { */ requestBody?: Schema$Account; } - export interface Params$Resource$Accounts$Update { + export interface Params$Resource$Accounts$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2225,7 +2259,7 @@ export namespace adexchangebuyer_v1_4 { } } - export interface Params$Resource$Billinginfo$Get { + export interface Params$Resource$Billinginfo$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2236,7 +2270,7 @@ export namespace adexchangebuyer_v1_4 { */ accountId?: number; } - export interface Params$Resource$Billinginfo$List { + export interface Params$Resource$Billinginfo$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2457,7 +2491,7 @@ export namespace adexchangebuyer_v1_4 { } } - export interface Params$Resource$Budget$Get { + export interface Params$Resource$Budget$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2472,7 +2506,7 @@ export namespace adexchangebuyer_v1_4 { */ billingId?: string; } - export interface Params$Resource$Budget$Patch { + export interface Params$Resource$Budget$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2492,7 +2526,7 @@ export namespace adexchangebuyer_v1_4 { */ requestBody?: Schema$Budget; } - export interface Params$Resource$Budget$Update { + export interface Params$Resource$Budget$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2934,7 +2968,8 @@ export namespace adexchangebuyer_v1_4 { } } - export interface Params$Resource$Creatives$Adddeal { + export interface Params$Resource$Creatives$Adddeal extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2953,7 +2988,7 @@ export namespace adexchangebuyer_v1_4 { */ dealId?: string; } - export interface Params$Resource$Creatives$Get { + export interface Params$Resource$Creatives$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2968,7 +3003,7 @@ export namespace adexchangebuyer_v1_4 { */ buyerCreativeId?: string; } - export interface Params$Resource$Creatives$Insert { + export interface Params$Resource$Creatives$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2980,7 +3015,7 @@ export namespace adexchangebuyer_v1_4 { */ requestBody?: Schema$Creative; } - export interface Params$Resource$Creatives$List { + export interface Params$Resource$Creatives$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3017,7 +3052,8 @@ export namespace adexchangebuyer_v1_4 { */ pageToken?: string; } - export interface Params$Resource$Creatives$Listdeals { + export interface Params$Resource$Creatives$Listdeals extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3032,7 +3068,8 @@ export namespace adexchangebuyer_v1_4 { */ buyerCreativeId?: string; } - export interface Params$Resource$Creatives$Removedeal { + export interface Params$Resource$Creatives$Removedeal extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3349,7 +3386,8 @@ export namespace adexchangebuyer_v1_4 { } } - export interface Params$Resource$Marketplacedeals$Delete { + export interface Params$Resource$Marketplacedeals$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3365,7 +3403,8 @@ export namespace adexchangebuyer_v1_4 { */ requestBody?: Schema$DeleteOrderDealsRequest; } - export interface Params$Resource$Marketplacedeals$Insert { + export interface Params$Resource$Marketplacedeals$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3381,7 +3420,8 @@ export namespace adexchangebuyer_v1_4 { */ requestBody?: Schema$AddOrderDealsRequest; } - export interface Params$Resource$Marketplacedeals$List { + export interface Params$Resource$Marketplacedeals$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3397,7 +3437,8 @@ export namespace adexchangebuyer_v1_4 { */ proposalId?: string; } - export interface Params$Resource$Marketplacedeals$Update { + export interface Params$Resource$Marketplacedeals$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3567,7 +3608,8 @@ export namespace adexchangebuyer_v1_4 { } } - export interface Params$Resource$Marketplacenotes$Insert { + export interface Params$Resource$Marketplacenotes$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3583,7 +3625,8 @@ export namespace adexchangebuyer_v1_4 { */ requestBody?: Schema$AddOrderNotesRequest; } - export interface Params$Resource$Marketplacenotes$List { + export interface Params$Resource$Marketplacenotes$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3684,7 +3727,8 @@ export namespace adexchangebuyer_v1_4 { } } - export interface Params$Resource$Marketplaceprivateauction$Updateproposal { + export interface Params$Resource$Marketplaceprivateauction$Updateproposal + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3786,7 +3830,8 @@ export namespace adexchangebuyer_v1_4 { } } - export interface Params$Resource$Performancereport$List { + export interface Params$Resource$Performancereport$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4246,7 +4291,8 @@ export namespace adexchangebuyer_v1_4 { } } - export interface Params$Resource$Pretargetingconfig$Delete { + export interface Params$Resource$Pretargetingconfig$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4261,7 +4307,8 @@ export namespace adexchangebuyer_v1_4 { */ configId?: string; } - export interface Params$Resource$Pretargetingconfig$Get { + export interface Params$Resource$Pretargetingconfig$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4276,7 +4323,8 @@ export namespace adexchangebuyer_v1_4 { */ configId?: string; } - export interface Params$Resource$Pretargetingconfig$Insert { + export interface Params$Resource$Pretargetingconfig$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4292,7 +4340,8 @@ export namespace adexchangebuyer_v1_4 { */ requestBody?: Schema$PretargetingConfig; } - export interface Params$Resource$Pretargetingconfig$List { + export interface Params$Resource$Pretargetingconfig$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4303,7 +4352,8 @@ export namespace adexchangebuyer_v1_4 { */ accountId?: string; } - export interface Params$Resource$Pretargetingconfig$Patch { + export interface Params$Resource$Pretargetingconfig$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4323,7 +4373,8 @@ export namespace adexchangebuyer_v1_4 { */ requestBody?: Schema$PretargetingConfig; } - export interface Params$Resource$Pretargetingconfig$Update { + export interface Params$Resource$Pretargetingconfig$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4483,7 +4534,7 @@ export namespace adexchangebuyer_v1_4 { } } - export interface Params$Resource$Products$Get { + export interface Params$Resource$Products$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4494,7 +4545,7 @@ export namespace adexchangebuyer_v1_4 { */ productId?: string; } - export interface Params$Resource$Products$Search { + export interface Params$Resource$Products$Search extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4917,7 +4968,7 @@ export namespace adexchangebuyer_v1_4 { } } - export interface Params$Resource$Proposals$Get { + export interface Params$Resource$Proposals$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4928,7 +4979,7 @@ export namespace adexchangebuyer_v1_4 { */ proposalId?: string; } - export interface Params$Resource$Proposals$Insert { + export interface Params$Resource$Proposals$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4940,7 +4991,7 @@ export namespace adexchangebuyer_v1_4 { */ requestBody?: Schema$CreateOrdersRequest; } - export interface Params$Resource$Proposals$Patch { + export interface Params$Resource$Proposals$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4968,7 +5019,7 @@ export namespace adexchangebuyer_v1_4 { */ requestBody?: Schema$Proposal; } - export interface Params$Resource$Proposals$Search { + export interface Params$Resource$Proposals$Search extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4979,7 +5030,8 @@ export namespace adexchangebuyer_v1_4 { */ pqlQuery?: string; } - export interface Params$Resource$Proposals$Setupcomplete { + export interface Params$Resource$Proposals$Setupcomplete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4990,7 +5042,7 @@ export namespace adexchangebuyer_v1_4 { */ proposalId?: string; } - export interface Params$Resource$Proposals$Update { + export interface Params$Resource$Proposals$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5105,7 +5157,7 @@ export namespace adexchangebuyer_v1_4 { } } - export interface Params$Resource$Pubprofiles$List { + export interface Params$Resource$Pubprofiles$List extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/adexchangebuyer2/v2beta1.ts b/src/apis/adexchangebuyer2/v2beta1.ts index d73281a4c7..8e21a9aa2e 100644 --- a/src/apis/adexchangebuyer2/v2beta1.ts +++ b/src/apis/adexchangebuyer2/v2beta1.ts @@ -29,6 +29,57 @@ export namespace adexchangebuyer2_v2beta1 { version: 'v2beta1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Ad Exchange Buyer API II * @@ -1028,6 +1079,12 @@ export namespace adexchangebuyer2_v2beta1 { * Interpreted relative to Pacific time zone. */ absoluteDateRange?: Schema$AbsoluteDateRange; + /** + * The set of dimensions along which to break down the response; may be + * empty. If multiple dimensions are requested, the breakdown is along the + * Cartesian product of the requested dimensions. + */ + breakdownDimensions?: string[]; /** * The ID of the creative on which to filter; optional. This field may be * set only for a filter set that accesses account-level troubleshooting @@ -2176,6 +2233,11 @@ export namespace adexchangebuyer2_v2beta1 { * dimensions. Encapsulates the values of all dimensions for a given row. */ export interface Schema$RowDimensions { + /** + * The publisher identifier for this row, if a breakdown by + * BreakdownDimension.PUBLISHER_IDENTIFIER was requested. + */ + publisherIdentifier?: string; /** * The time interval that this row represents. */ @@ -2763,7 +2825,8 @@ export namespace adexchangebuyer2_v2beta1 { } } - export interface Params$Resource$Accounts$Clients$Create { + export interface Params$Resource$Accounts$Clients$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2780,7 +2843,8 @@ export namespace adexchangebuyer2_v2beta1 { */ requestBody?: Schema$Client; } - export interface Params$Resource$Accounts$Clients$Get { + export interface Params$Resource$Accounts$Clients$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2795,7 +2859,8 @@ export namespace adexchangebuyer2_v2beta1 { */ clientAccountId?: string; } - export interface Params$Resource$Accounts$Clients$List { + export interface Params$Resource$Accounts$Clients$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2823,7 +2888,8 @@ export namespace adexchangebuyer2_v2beta1 { */ partnerClientId?: string; } - export interface Params$Resource$Accounts$Clients$Update { + export interface Params$Resource$Accounts$Clients$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3085,7 +3151,8 @@ export namespace adexchangebuyer2_v2beta1 { } } - export interface Params$Resource$Accounts$Clients$Invitations$Create { + export interface Params$Resource$Accounts$Clients$Invitations$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3106,7 +3173,8 @@ export namespace adexchangebuyer2_v2beta1 { */ requestBody?: Schema$ClientUserInvitation; } - export interface Params$Resource$Accounts$Clients$Invitations$Get { + export interface Params$Resource$Accounts$Clients$Invitations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3126,7 +3194,8 @@ export namespace adexchangebuyer2_v2beta1 { */ invitationId?: string; } - export interface Params$Resource$Accounts$Clients$Invitations$List { + export interface Params$Resource$Accounts$Clients$Invitations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3387,7 +3456,8 @@ export namespace adexchangebuyer2_v2beta1 { } } - export interface Params$Resource$Accounts$Clients$Users$Get { + export interface Params$Resource$Accounts$Clients$Users$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3407,7 +3477,8 @@ export namespace adexchangebuyer2_v2beta1 { */ userId?: string; } - export interface Params$Resource$Accounts$Clients$Users$List { + export interface Params$Resource$Accounts$Clients$Users$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3438,7 +3509,8 @@ export namespace adexchangebuyer2_v2beta1 { */ pageToken?: string; } - export interface Params$Resource$Accounts$Clients$Users$Update { + export interface Params$Resource$Accounts$Clients$Users$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3901,7 +3973,8 @@ export namespace adexchangebuyer2_v2beta1 { } } - export interface Params$Resource$Accounts$Creatives$Create { + export interface Params$Resource$Accounts$Creatives$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3923,7 +3996,8 @@ export namespace adexchangebuyer2_v2beta1 { */ requestBody?: Schema$Creative; } - export interface Params$Resource$Accounts$Creatives$Get { + export interface Params$Resource$Accounts$Creatives$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3938,7 +4012,8 @@ export namespace adexchangebuyer2_v2beta1 { */ creativeId?: string; } - export interface Params$Resource$Accounts$Creatives$List { + export interface Params$Resource$Accounts$Creatives$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3976,7 +4051,8 @@ export namespace adexchangebuyer2_v2beta1 { */ query?: string; } - export interface Params$Resource$Accounts$Creatives$Stopwatching { + export interface Params$Resource$Accounts$Creatives$Stopwatching extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3997,7 +4073,8 @@ export namespace adexchangebuyer2_v2beta1 { */ requestBody?: Schema$StopWatchingCreativeRequest; } - export interface Params$Resource$Accounts$Creatives$Update { + export interface Params$Resource$Accounts$Creatives$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4019,7 +4096,8 @@ export namespace adexchangebuyer2_v2beta1 { */ requestBody?: Schema$Creative; } - export interface Params$Resource$Accounts$Creatives$Watch { + export interface Params$Resource$Accounts$Creatives$Watch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4278,7 +4356,8 @@ export namespace adexchangebuyer2_v2beta1 { } } - export interface Params$Resource$Accounts$Creatives$Dealassociations$Add { + export interface Params$Resource$Accounts$Creatives$Dealassociations$Add + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4298,7 +4377,8 @@ export namespace adexchangebuyer2_v2beta1 { */ requestBody?: Schema$AddDealAssociationRequest; } - export interface Params$Resource$Accounts$Creatives$Dealassociations$List { + export interface Params$Resource$Accounts$Creatives$Dealassociations$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4338,7 +4418,8 @@ export namespace adexchangebuyer2_v2beta1 { */ query?: string; } - export interface Params$Resource$Accounts$Creatives$Dealassociations$Remove { + export interface Params$Resource$Accounts$Creatives$Dealassociations$Remove + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4449,7 +4530,8 @@ export namespace adexchangebuyer2_v2beta1 { } } - export interface Params$Resource$Accounts$Finalizedproposals$List { + export interface Params$Resource$Accounts$Finalizedproposals$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4632,7 +4714,8 @@ export namespace adexchangebuyer2_v2beta1 { } } - export interface Params$Resource$Accounts$Products$Get { + export interface Params$Resource$Accounts$Products$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4647,7 +4730,8 @@ export namespace adexchangebuyer2_v2beta1 { */ productId?: string; } - export interface Params$Resource$Accounts$Products$List { + export interface Params$Resource$Accounts$Products$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5428,7 +5512,8 @@ export namespace adexchangebuyer2_v2beta1 { } } - export interface Params$Resource$Accounts$Proposals$Accept { + export interface Params$Resource$Accounts$Proposals$Accept extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5448,7 +5533,8 @@ export namespace adexchangebuyer2_v2beta1 { */ requestBody?: Schema$AcceptProposalRequest; } - export interface Params$Resource$Accounts$Proposals$Addnote { + export interface Params$Resource$Accounts$Proposals$Addnote extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5468,7 +5554,8 @@ export namespace adexchangebuyer2_v2beta1 { */ requestBody?: Schema$AddNoteRequest; } - export interface Params$Resource$Accounts$Proposals$Cancelnegotiation { + export interface Params$Resource$Accounts$Proposals$Cancelnegotiation extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5488,7 +5575,8 @@ export namespace adexchangebuyer2_v2beta1 { */ requestBody?: Schema$CancelNegotiationRequest; } - export interface Params$Resource$Accounts$Proposals$Completesetup { + export interface Params$Resource$Accounts$Proposals$Completesetup extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5508,7 +5596,8 @@ export namespace adexchangebuyer2_v2beta1 { */ requestBody?: Schema$CompleteSetupRequest; } - export interface Params$Resource$Accounts$Proposals$Create { + export interface Params$Resource$Accounts$Proposals$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5524,7 +5613,8 @@ export namespace adexchangebuyer2_v2beta1 { */ requestBody?: Schema$Proposal; } - export interface Params$Resource$Accounts$Proposals$Get { + export interface Params$Resource$Accounts$Proposals$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5539,7 +5629,8 @@ export namespace adexchangebuyer2_v2beta1 { */ proposalId?: string; } - export interface Params$Resource$Accounts$Proposals$List { + export interface Params$Resource$Accounts$Proposals$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5570,7 +5661,8 @@ export namespace adexchangebuyer2_v2beta1 { */ pageToken?: string; } - export interface Params$Resource$Accounts$Proposals$Pause { + export interface Params$Resource$Accounts$Proposals$Pause extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5590,7 +5682,8 @@ export namespace adexchangebuyer2_v2beta1 { */ requestBody?: Schema$PauseProposalRequest; } - export interface Params$Resource$Accounts$Proposals$Resume { + export interface Params$Resource$Accounts$Proposals$Resume extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5610,7 +5703,8 @@ export namespace adexchangebuyer2_v2beta1 { */ requestBody?: Schema$ResumeProposalRequest; } - export interface Params$Resource$Accounts$Proposals$Update { + export interface Params$Resource$Accounts$Proposals$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5788,7 +5882,8 @@ export namespace adexchangebuyer2_v2beta1 { } } - export interface Params$Resource$Accounts$Publisherprofiles$Get { + export interface Params$Resource$Accounts$Publisherprofiles$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5803,7 +5898,8 @@ export namespace adexchangebuyer2_v2beta1 { */ publisherProfileId?: string; } - export interface Params$Resource$Accounts$Publisherprofiles$List { + export interface Params$Resource$Accounts$Publisherprofiles$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5942,7 +6038,8 @@ export namespace adexchangebuyer2_v2beta1 { } } - export interface Params$Resource$Bidders$Accounts$Creatives$Delete { + export interface Params$Resource$Bidders$Accounts$Creatives$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6276,7 +6373,8 @@ export namespace adexchangebuyer2_v2beta1 { } } - export interface Params$Resource$Bidders$Accounts$Filtersets$Create { + export interface Params$Resource$Bidders$Accounts$Filtersets$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6303,7 +6401,8 @@ export namespace adexchangebuyer2_v2beta1 { */ requestBody?: Schema$FilterSet; } - export interface Params$Resource$Bidders$Accounts$Filtersets$Delete { + export interface Params$Resource$Bidders$Accounts$Filtersets$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6319,7 +6418,8 @@ export namespace adexchangebuyer2_v2beta1 { */ name?: string; } - export interface Params$Resource$Bidders$Accounts$Filtersets$Get { + export interface Params$Resource$Bidders$Accounts$Filtersets$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6335,7 +6435,8 @@ export namespace adexchangebuyer2_v2beta1 { */ name?: string; } - export interface Params$Resource$Bidders$Accounts$Filtersets$List { + export interface Params$Resource$Bidders$Accounts$Filtersets$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6448,7 +6549,8 @@ export namespace adexchangebuyer2_v2beta1 { } } - export interface Params$Resource$Bidders$Accounts$Filtersets$Bidmetrics$List { + export interface Params$Resource$Bidders$Accounts$Filtersets$Bidmetrics$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6574,7 +6676,8 @@ export namespace adexchangebuyer2_v2beta1 { } } - export interface Params$Resource$Bidders$Accounts$Filtersets$Bidresponseerrors$List { + export interface Params$Resource$Bidders$Accounts$Filtersets$Bidresponseerrors$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6707,7 +6810,8 @@ export namespace adexchangebuyer2_v2beta1 { } } - export interface Params$Resource$Bidders$Accounts$Filtersets$Bidresponseswithoutbids$List { + export interface Params$Resource$Bidders$Accounts$Filtersets$Bidresponseswithoutbids$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6836,7 +6940,8 @@ export namespace adexchangebuyer2_v2beta1 { } } - export interface Params$Resource$Bidders$Accounts$Filtersets$Filteredbidrequests$List { + export interface Params$Resource$Bidders$Accounts$Filtersets$Filteredbidrequests$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6959,7 +7064,8 @@ export namespace adexchangebuyer2_v2beta1 { } } - export interface Params$Resource$Bidders$Accounts$Filtersets$Filteredbids$List { + export interface Params$Resource$Bidders$Accounts$Filtersets$Filteredbids$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7089,7 +7195,8 @@ export namespace adexchangebuyer2_v2beta1 { } } - export interface Params$Resource$Bidders$Accounts$Filtersets$Filteredbids$Creatives$List { + export interface Params$Resource$Bidders$Accounts$Filtersets$Filteredbids$Creatives$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7227,7 +7334,8 @@ export namespace adexchangebuyer2_v2beta1 { } } - export interface Params$Resource$Bidders$Accounts$Filtersets$Filteredbids$Details$List { + export interface Params$Resource$Bidders$Accounts$Filtersets$Filteredbids$Details$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7363,7 +7471,8 @@ export namespace adexchangebuyer2_v2beta1 { } } - export interface Params$Resource$Bidders$Accounts$Filtersets$Impressionmetrics$List { + export interface Params$Resource$Bidders$Accounts$Filtersets$Impressionmetrics$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7480,7 +7589,8 @@ export namespace adexchangebuyer2_v2beta1 { } } - export interface Params$Resource$Bidders$Accounts$Filtersets$Losingbids$List { + export interface Params$Resource$Bidders$Accounts$Filtersets$Losingbids$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7611,7 +7721,8 @@ export namespace adexchangebuyer2_v2beta1 { } } - export interface Params$Resource$Bidders$Accounts$Filtersets$Nonbillablewinningbids$List { + export interface Params$Resource$Bidders$Accounts$Filtersets$Nonbillablewinningbids$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7950,7 +8061,8 @@ export namespace adexchangebuyer2_v2beta1 { } } - export interface Params$Resource$Bidders$Filtersets$Create { + export interface Params$Resource$Bidders$Filtersets$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7977,7 +8089,8 @@ export namespace adexchangebuyer2_v2beta1 { */ requestBody?: Schema$FilterSet; } - export interface Params$Resource$Bidders$Filtersets$Delete { + export interface Params$Resource$Bidders$Filtersets$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7993,7 +8106,8 @@ export namespace adexchangebuyer2_v2beta1 { */ name?: string; } - export interface Params$Resource$Bidders$Filtersets$Get { + export interface Params$Resource$Bidders$Filtersets$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8009,7 +8123,8 @@ export namespace adexchangebuyer2_v2beta1 { */ name?: string; } - export interface Params$Resource$Bidders$Filtersets$List { + export interface Params$Resource$Bidders$Filtersets$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8120,7 +8235,8 @@ export namespace adexchangebuyer2_v2beta1 { } } - export interface Params$Resource$Bidders$Filtersets$Bidmetrics$List { + export interface Params$Resource$Bidders$Filtersets$Bidmetrics$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8242,7 +8358,8 @@ export namespace adexchangebuyer2_v2beta1 { } } - export interface Params$Resource$Bidders$Filtersets$Bidresponseerrors$List { + export interface Params$Resource$Bidders$Filtersets$Bidresponseerrors$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8372,7 +8489,8 @@ export namespace adexchangebuyer2_v2beta1 { } } - export interface Params$Resource$Bidders$Filtersets$Bidresponseswithoutbids$List { + export interface Params$Resource$Bidders$Filtersets$Bidresponseswithoutbids$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8497,7 +8615,8 @@ export namespace adexchangebuyer2_v2beta1 { } } - export interface Params$Resource$Bidders$Filtersets$Filteredbidrequests$List { + export interface Params$Resource$Bidders$Filtersets$Filteredbidrequests$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8617,7 +8736,8 @@ export namespace adexchangebuyer2_v2beta1 { } } - export interface Params$Resource$Bidders$Filtersets$Filteredbids$List { + export interface Params$Resource$Bidders$Filtersets$Filteredbids$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8743,7 +8863,8 @@ export namespace adexchangebuyer2_v2beta1 { } } - export interface Params$Resource$Bidders$Filtersets$Filteredbids$Creatives$List { + export interface Params$Resource$Bidders$Filtersets$Filteredbids$Creatives$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8877,7 +8998,8 @@ export namespace adexchangebuyer2_v2beta1 { } } - export interface Params$Resource$Bidders$Filtersets$Filteredbids$Details$List { + export interface Params$Resource$Bidders$Filtersets$Filteredbids$Details$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9009,7 +9131,8 @@ export namespace adexchangebuyer2_v2beta1 { } } - export interface Params$Resource$Bidders$Filtersets$Impressionmetrics$List { + export interface Params$Resource$Bidders$Filtersets$Impressionmetrics$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9124,7 +9247,8 @@ export namespace adexchangebuyer2_v2beta1 { } } - export interface Params$Resource$Bidders$Filtersets$Losingbids$List { + export interface Params$Resource$Bidders$Filtersets$Losingbids$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9251,7 +9375,8 @@ export namespace adexchangebuyer2_v2beta1 { } } - export interface Params$Resource$Bidders$Filtersets$Nonbillablewinningbids$List { + export interface Params$Resource$Bidders$Filtersets$Nonbillablewinningbids$List + extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/adexperiencereport/README.md b/src/apis/adexperiencereport/README.md index 8ad34374e3..7a940d25ee 100644 --- a/src/apis/adexperiencereport/README.md +++ b/src/apis/adexperiencereport/README.md @@ -2,7 +2,7 @@ # @google/adexperiencereport -> View Ad Experience Report data, and get a list of sites that have a significant number of annoying ads. +> Views Ad Experience Report data, and gets a list of sites that have a significant number of annoying ads. ## Installation diff --git a/src/apis/adexperiencereport/v1.ts b/src/apis/adexperiencereport/v1.ts index e8b9b73870..61612df363 100644 --- a/src/apis/adexperiencereport/v1.ts +++ b/src/apis/adexperiencereport/v1.ts @@ -29,10 +29,61 @@ export namespace adexperiencereport_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Ad Experience Report API * - * View Ad Experience Report data, and get a list of sites that have a + * Views Ad Experience Report data, and gets a list of sites that have a * significant number of annoying ads. * * @example @@ -202,7 +253,7 @@ export namespace adexperiencereport_v1 { } } - export interface Params$Resource$Sites$Get { + export interface Params$Resource$Sites$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -302,7 +353,8 @@ export namespace adexperiencereport_v1 { } } - export interface Params$Resource$Violatingsites$List { + export interface Params$Resource$Violatingsites$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/admin/datatransfer_v1.ts b/src/apis/admin/datatransfer_v1.ts index f433cdda0f..22edaad909 100644 --- a/src/apis/admin/datatransfer_v1.ts +++ b/src/apis/admin/datatransfer_v1.ts @@ -29,6 +29,40 @@ export namespace admin_datatransfer_v1 { version: 'datatransfer_v1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Admin Data Transfer API * @@ -356,7 +390,7 @@ export namespace admin_datatransfer_v1 { } } - export interface Params$Resource$Applications$Get { + export interface Params$Resource$Applications$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -367,7 +401,8 @@ export namespace admin_datatransfer_v1 { */ applicationId?: string; } - export interface Params$Resource$Applications$List { + export interface Params$Resource$Applications$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -602,7 +637,7 @@ export namespace admin_datatransfer_v1 { } } - export interface Params$Resource$Transfers$Get { + export interface Params$Resource$Transfers$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -614,7 +649,7 @@ export namespace admin_datatransfer_v1 { */ dataTransferId?: string; } - export interface Params$Resource$Transfers$Insert { + export interface Params$Resource$Transfers$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -626,7 +661,7 @@ export namespace admin_datatransfer_v1 { */ requestBody?: Schema$DataTransfer; } - export interface Params$Resource$Transfers$List { + export interface Params$Resource$Transfers$List extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/admin/directory_v1.ts b/src/apis/admin/directory_v1.ts index f6f1a9489e..c12a69347e 100644 --- a/src/apis/admin/directory_v1.ts +++ b/src/apis/admin/directory_v1.ts @@ -29,6 +29,40 @@ export namespace admin_directory_v1 { version: 'directory_v1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Admin Directory API * @@ -2600,7 +2634,7 @@ export namespace admin_directory_v1 { } } - export interface Params$Resource$Asps$Delete { + export interface Params$Resource$Asps$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2616,7 +2650,7 @@ export namespace admin_directory_v1 { */ userKey?: string; } - export interface Params$Resource$Asps$Get { + export interface Params$Resource$Asps$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2632,7 +2666,7 @@ export namespace admin_directory_v1 { */ userKey?: string; } - export interface Params$Resource$Asps$List { + export interface Params$Resource$Asps$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2722,7 +2756,7 @@ export namespace admin_directory_v1 { } } - export interface Params$Resource$Channels$Stop { + export interface Params$Resource$Channels$Stop extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3173,7 +3207,8 @@ export namespace admin_directory_v1 { } } - export interface Params$Resource$Chromeosdevices$Action { + export interface Params$Resource$Chromeosdevices$Action extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3193,7 +3228,8 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$ChromeOsDeviceAction; } - export interface Params$Resource$Chromeosdevices$Get { + export interface Params$Resource$Chromeosdevices$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3212,7 +3248,8 @@ export namespace admin_directory_v1 { */ projection?: string; } - export interface Params$Resource$Chromeosdevices$List { + export interface Params$Resource$Chromeosdevices$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3253,7 +3290,8 @@ export namespace admin_directory_v1 { */ sortOrder?: string; } - export interface Params$Resource$Chromeosdevices$Movedevicestoou { + export interface Params$Resource$Chromeosdevices$Movedevicestoou extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3273,7 +3311,8 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$ChromeOsMoveDevicesToOu; } - export interface Params$Resource$Chromeosdevices$Patch { + export interface Params$Resource$Chromeosdevices$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3297,7 +3336,8 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$ChromeOsDevice; } - export interface Params$Resource$Chromeosdevices$Update { + export interface Params$Resource$Chromeosdevices$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3526,7 +3566,7 @@ export namespace admin_directory_v1 { } } - export interface Params$Resource$Customers$Get { + export interface Params$Resource$Customers$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3537,7 +3577,7 @@ export namespace admin_directory_v1 { */ customerKey?: string; } - export interface Params$Resource$Customers$Patch { + export interface Params$Resource$Customers$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3553,7 +3593,7 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$Customer; } - export interface Params$Resource$Customers$Update { + export interface Params$Resource$Customers$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3854,7 +3894,8 @@ export namespace admin_directory_v1 { } } - export interface Params$Resource$Domainaliases$Delete { + export interface Params$Resource$Domainaliases$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3869,7 +3910,8 @@ export namespace admin_directory_v1 { */ domainAliasName?: string; } - export interface Params$Resource$Domainaliases$Get { + export interface Params$Resource$Domainaliases$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3884,7 +3926,8 @@ export namespace admin_directory_v1 { */ domainAliasName?: string; } - export interface Params$Resource$Domainaliases$Insert { + export interface Params$Resource$Domainaliases$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3900,7 +3943,8 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$DomainAlias; } - export interface Params$Resource$Domainaliases$List { + export interface Params$Resource$Domainaliases$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4188,7 +4232,7 @@ export namespace admin_directory_v1 { } } - export interface Params$Resource$Domains$Delete { + export interface Params$Resource$Domains$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4203,7 +4247,7 @@ export namespace admin_directory_v1 { */ domainName?: string; } - export interface Params$Resource$Domains$Get { + export interface Params$Resource$Domains$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4218,7 +4262,7 @@ export namespace admin_directory_v1 { */ domainName?: string; } - export interface Params$Resource$Domains$Insert { + export interface Params$Resource$Domains$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4234,7 +4278,7 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$Domains; } - export interface Params$Resource$Domains$List { + export interface Params$Resource$Domains$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4651,7 +4695,7 @@ export namespace admin_directory_v1 { } } - export interface Params$Resource$Groups$Delete { + export interface Params$Resource$Groups$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4662,7 +4706,7 @@ export namespace admin_directory_v1 { */ groupKey?: string; } - export interface Params$Resource$Groups$Get { + export interface Params$Resource$Groups$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4673,7 +4717,7 @@ export namespace admin_directory_v1 { */ groupKey?: string; } - export interface Params$Resource$Groups$Insert { + export interface Params$Resource$Groups$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4685,7 +4729,7 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$Group; } - export interface Params$Resource$Groups$List { + export interface Params$Resource$Groups$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4731,7 +4775,7 @@ export namespace admin_directory_v1 { */ userKey?: string; } - export interface Params$Resource$Groups$Patch { + export interface Params$Resource$Groups$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4748,7 +4792,7 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$Group; } - export interface Params$Resource$Groups$Update { + export interface Params$Resource$Groups$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4977,7 +5021,8 @@ export namespace admin_directory_v1 { } } - export interface Params$Resource$Groups$Aliases$Delete { + export interface Params$Resource$Groups$Aliases$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4992,7 +5037,8 @@ export namespace admin_directory_v1 { */ groupKey?: string; } - export interface Params$Resource$Groups$Aliases$Insert { + export interface Params$Resource$Groups$Aliases$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5008,7 +5054,8 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$Alias; } - export interface Params$Resource$Groups$Aliases$List { + export interface Params$Resource$Groups$Aliases$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5501,7 +5548,7 @@ export namespace admin_directory_v1 { } } - export interface Params$Resource$Members$Delete { + export interface Params$Resource$Members$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5516,7 +5563,7 @@ export namespace admin_directory_v1 { */ memberKey?: string; } - export interface Params$Resource$Members$Get { + export interface Params$Resource$Members$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5531,7 +5578,8 @@ export namespace admin_directory_v1 { */ memberKey?: string; } - export interface Params$Resource$Members$Hasmember { + export interface Params$Resource$Members$Hasmember extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5548,7 +5596,7 @@ export namespace admin_directory_v1 { */ memberKey?: string; } - export interface Params$Resource$Members$Insert { + export interface Params$Resource$Members$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5564,7 +5612,7 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$Member; } - export interface Params$Resource$Members$List { + export interface Params$Resource$Members$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5591,7 +5639,7 @@ export namespace admin_directory_v1 { */ roles?: string; } - export interface Params$Resource$Members$Patch { + export interface Params$Resource$Members$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5613,7 +5661,7 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$Member; } - export interface Params$Resource$Members$Update { + export interface Params$Resource$Members$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5926,7 +5974,8 @@ export namespace admin_directory_v1 { } } - export interface Params$Resource$Mobiledevices$Action { + export interface Params$Resource$Mobiledevices$Action extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5946,7 +5995,8 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$MobileDeviceAction; } - export interface Params$Resource$Mobiledevices$Delete { + export interface Params$Resource$Mobiledevices$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5961,7 +6011,8 @@ export namespace admin_directory_v1 { */ resourceId?: string; } - export interface Params$Resource$Mobiledevices$Get { + export interface Params$Resource$Mobiledevices$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5980,7 +6031,8 @@ export namespace admin_directory_v1 { */ resourceId?: string; } - export interface Params$Resource$Mobiledevices$List { + export interface Params$Resource$Mobiledevices$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6377,7 +6429,8 @@ export namespace admin_directory_v1 { } } - export interface Params$Resource$Notifications$Delete { + export interface Params$Resource$Notifications$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6393,7 +6446,8 @@ export namespace admin_directory_v1 { */ notificationId?: string; } - export interface Params$Resource$Notifications$Get { + export interface Params$Resource$Notifications$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6409,7 +6463,8 @@ export namespace admin_directory_v1 { */ notificationId?: string; } - export interface Params$Resource$Notifications$List { + export interface Params$Resource$Notifications$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6433,7 +6488,8 @@ export namespace admin_directory_v1 { */ pageToken?: string; } - export interface Params$Resource$Notifications$Patch { + export interface Params$Resource$Notifications$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6453,7 +6509,8 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$Notification; } - export interface Params$Resource$Notifications$Update { + export interface Params$Resource$Notifications$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6886,7 +6943,7 @@ export namespace admin_directory_v1 { } } - export interface Params$Resource$Orgunits$Delete { + export interface Params$Resource$Orgunits$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6901,7 +6958,7 @@ export namespace admin_directory_v1 { */ orgUnitPath?: string; } - export interface Params$Resource$Orgunits$Get { + export interface Params$Resource$Orgunits$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6916,7 +6973,7 @@ export namespace admin_directory_v1 { */ orgUnitPath?: string; } - export interface Params$Resource$Orgunits$Insert { + export interface Params$Resource$Orgunits$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6932,7 +6989,7 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$OrgUnit; } - export interface Params$Resource$Orgunits$List { + export interface Params$Resource$Orgunits$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6951,7 +7008,7 @@ export namespace admin_directory_v1 { */ type?: string; } - export interface Params$Resource$Orgunits$Patch { + export interface Params$Resource$Orgunits$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6971,7 +7028,7 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$OrgUnit; } - export interface Params$Resource$Orgunits$Update { + export interface Params$Resource$Orgunits$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7072,7 +7129,7 @@ export namespace admin_directory_v1 { } } - export interface Params$Resource$Privileges$List { + export interface Params$Resource$Privileges$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7235,13 +7292,15 @@ export namespace admin_directory_v1 { } } - export interface Params$Resource$Resolvedappaccesssettings$Getsettings { + export interface Params$Resource$Resolvedappaccesssettings$Getsettings extends + StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; } - export interface Params$Resource$Resolvedappaccesssettings$Listtrustedapps { + export interface Params$Resource$Resolvedappaccesssettings$Listtrustedapps + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7693,7 +7752,8 @@ export namespace admin_directory_v1 { } } - export interface Params$Resource$Resources$Buildings$Delete { + export interface Params$Resource$Resources$Buildings$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7710,7 +7770,8 @@ export namespace admin_directory_v1 { */ customer?: string; } - export interface Params$Resource$Resources$Buildings$Get { + export interface Params$Resource$Resources$Buildings$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7727,7 +7788,8 @@ export namespace admin_directory_v1 { */ customer?: string; } - export interface Params$Resource$Resources$Buildings$Insert { + export interface Params$Resource$Resources$Buildings$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7745,7 +7807,8 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$Building; } - export interface Params$Resource$Resources$Buildings$List { + export interface Params$Resource$Resources$Buildings$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7766,7 +7829,8 @@ export namespace admin_directory_v1 { */ pageToken?: string; } - export interface Params$Resource$Resources$Buildings$Patch { + export interface Params$Resource$Resources$Buildings$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7788,7 +7852,8 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$Building; } - export interface Params$Resource$Resources$Buildings$Update { + export interface Params$Resource$Resources$Buildings$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8248,7 +8313,8 @@ export namespace admin_directory_v1 { } } - export interface Params$Resource$Resources$Calendars$Delete { + export interface Params$Resource$Resources$Calendars$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8265,7 +8331,8 @@ export namespace admin_directory_v1 { */ customer?: string; } - export interface Params$Resource$Resources$Calendars$Get { + export interface Params$Resource$Resources$Calendars$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8282,7 +8349,8 @@ export namespace admin_directory_v1 { */ customer?: string; } - export interface Params$Resource$Resources$Calendars$Insert { + export interface Params$Resource$Resources$Calendars$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8300,7 +8368,8 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$CalendarResource; } - export interface Params$Resource$Resources$Calendars$List { + export interface Params$Resource$Resources$Calendars$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8341,7 +8410,8 @@ export namespace admin_directory_v1 { */ query?: string; } - export interface Params$Resource$Resources$Calendars$Patch { + export interface Params$Resource$Resources$Calendars$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8363,7 +8433,8 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$CalendarResource; } - export interface Params$Resource$Resources$Calendars$Update { + export interface Params$Resource$Resources$Calendars$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8880,7 +8951,8 @@ export namespace admin_directory_v1 { } } - export interface Params$Resource$Resources$Features$Delete { + export interface Params$Resource$Resources$Features$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8897,7 +8969,8 @@ export namespace admin_directory_v1 { */ featureKey?: string; } - export interface Params$Resource$Resources$Features$Get { + export interface Params$Resource$Resources$Features$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8914,7 +8987,8 @@ export namespace admin_directory_v1 { */ featureKey?: string; } - export interface Params$Resource$Resources$Features$Insert { + export interface Params$Resource$Resources$Features$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8932,7 +9006,8 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$Feature; } - export interface Params$Resource$Resources$Features$List { + export interface Params$Resource$Resources$Features$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8953,7 +9028,8 @@ export namespace admin_directory_v1 { */ pageToken?: string; } - export interface Params$Resource$Resources$Features$Patch { + export interface Params$Resource$Resources$Features$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8975,7 +9051,8 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$Feature; } - export interface Params$Resource$Resources$Features$Rename { + export interface Params$Resource$Resources$Features$Rename extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8997,7 +9074,8 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$FeatureRename; } - export interface Params$Resource$Resources$Features$Update { + export interface Params$Resource$Resources$Features$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9309,7 +9387,8 @@ export namespace admin_directory_v1 { } } - export interface Params$Resource$Roleassignments$Delete { + export interface Params$Resource$Roleassignments$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9324,7 +9403,8 @@ export namespace admin_directory_v1 { */ roleAssignmentId?: string; } - export interface Params$Resource$Roleassignments$Get { + export interface Params$Resource$Roleassignments$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9339,7 +9419,8 @@ export namespace admin_directory_v1 { */ roleAssignmentId?: string; } - export interface Params$Resource$Roleassignments$Insert { + export interface Params$Resource$Roleassignments$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9355,7 +9436,8 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$RoleAssignment; } - export interface Params$Resource$Roleassignments$List { + export interface Params$Resource$Roleassignments$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9791,7 +9873,7 @@ export namespace admin_directory_v1 { } } - export interface Params$Resource$Roles$Delete { + export interface Params$Resource$Roles$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9806,7 +9888,7 @@ export namespace admin_directory_v1 { */ roleId?: string; } - export interface Params$Resource$Roles$Get { + export interface Params$Resource$Roles$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9821,7 +9903,7 @@ export namespace admin_directory_v1 { */ roleId?: string; } - export interface Params$Resource$Roles$Insert { + export interface Params$Resource$Roles$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9837,7 +9919,7 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$Role; } - export interface Params$Resource$Roles$List { + export interface Params$Resource$Roles$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9856,7 +9938,7 @@ export namespace admin_directory_v1 { */ pageToken?: string; } - export interface Params$Resource$Roles$Patch { + export interface Params$Resource$Roles$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9876,7 +9958,7 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$Role; } - export interface Params$Resource$Roles$Update { + export interface Params$Resource$Roles$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -10307,7 +10389,7 @@ export namespace admin_directory_v1 { } } - export interface Params$Resource$Schemas$Delete { + export interface Params$Resource$Schemas$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -10322,7 +10404,7 @@ export namespace admin_directory_v1 { */ schemaKey?: string; } - export interface Params$Resource$Schemas$Get { + export interface Params$Resource$Schemas$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -10337,7 +10419,7 @@ export namespace admin_directory_v1 { */ schemaKey?: string; } - export interface Params$Resource$Schemas$Insert { + export interface Params$Resource$Schemas$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -10353,7 +10435,7 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$Schema; } - export interface Params$Resource$Schemas$List { + export interface Params$Resource$Schemas$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -10364,7 +10446,7 @@ export namespace admin_directory_v1 { */ customerId?: string; } - export interface Params$Resource$Schemas$Patch { + export interface Params$Resource$Schemas$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -10384,7 +10466,7 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$Schema; } - export interface Params$Resource$Schemas$Update { + export interface Params$Resource$Schemas$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -10611,7 +10693,7 @@ export namespace admin_directory_v1 { } } - export interface Params$Resource$Tokens$Delete { + export interface Params$Resource$Tokens$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -10627,7 +10709,7 @@ export namespace admin_directory_v1 { */ userKey?: string; } - export interface Params$Resource$Tokens$Get { + export interface Params$Resource$Tokens$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -10643,7 +10725,7 @@ export namespace admin_directory_v1 { */ userKey?: string; } - export interface Params$Resource$Tokens$List { + export interface Params$Resource$Tokens$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11274,7 +11356,7 @@ export namespace admin_directory_v1 { } } - export interface Params$Resource$Users$Delete { + export interface Params$Resource$Users$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11285,7 +11367,7 @@ export namespace admin_directory_v1 { */ userKey?: string; } - export interface Params$Resource$Users$Get { + export interface Params$Resource$Users$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11309,7 +11391,7 @@ export namespace admin_directory_v1 { */ viewType?: string; } - export interface Params$Resource$Users$Insert { + export interface Params$Resource$Users$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11321,7 +11403,7 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$User; } - export interface Params$Resource$Users$List { + export interface Params$Resource$Users$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11381,7 +11463,7 @@ export namespace admin_directory_v1 { */ viewType?: string; } - export interface Params$Resource$Users$Makeadmin { + export interface Params$Resource$Users$Makeadmin extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11397,7 +11479,7 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$UserMakeAdmin; } - export interface Params$Resource$Users$Patch { + export interface Params$Resource$Users$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11414,7 +11496,7 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$User; } - export interface Params$Resource$Users$Undelete { + export interface Params$Resource$Users$Undelete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11430,7 +11512,7 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$UserUndelete; } - export interface Params$Resource$Users$Update { + export interface Params$Resource$Users$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11447,7 +11529,7 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$User; } - export interface Params$Resource$Users$Watch { + export interface Params$Resource$Users$Watch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11794,7 +11876,8 @@ export namespace admin_directory_v1 { } } - export interface Params$Resource$Users$Aliases$Delete { + export interface Params$Resource$Users$Aliases$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -11809,7 +11892,8 @@ export namespace admin_directory_v1 { */ userKey?: string; } - export interface Params$Resource$Users$Aliases$Insert { + export interface Params$Resource$Users$Aliases$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -11825,7 +11909,8 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$Alias; } - export interface Params$Resource$Users$Aliases$List { + export interface Params$Resource$Users$Aliases$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -11840,7 +11925,8 @@ export namespace admin_directory_v1 { */ userKey?: string; } - export interface Params$Resource$Users$Aliases$Watch { + export interface Params$Resource$Users$Aliases$Watch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12140,7 +12226,8 @@ export namespace admin_directory_v1 { } } - export interface Params$Resource$Users$Photos$Delete { + export interface Params$Resource$Users$Photos$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12151,7 +12238,7 @@ export namespace admin_directory_v1 { */ userKey?: string; } - export interface Params$Resource$Users$Photos$Get { + export interface Params$Resource$Users$Photos$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -12162,7 +12249,8 @@ export namespace admin_directory_v1 { */ userKey?: string; } - export interface Params$Resource$Users$Photos$Patch { + export interface Params$Resource$Users$Photos$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12178,7 +12266,8 @@ export namespace admin_directory_v1 { */ requestBody?: Schema$UserPhoto; } - export interface Params$Resource$Users$Photos$Update { + export interface Params$Resource$Users$Photos$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12412,7 +12501,8 @@ export namespace admin_directory_v1 { } } - export interface Params$Resource$Verificationcodes$Generate { + export interface Params$Resource$Verificationcodes$Generate extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12423,7 +12513,8 @@ export namespace admin_directory_v1 { */ userKey?: string; } - export interface Params$Resource$Verificationcodes$Invalidate { + export interface Params$Resource$Verificationcodes$Invalidate extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12434,7 +12525,8 @@ export namespace admin_directory_v1 { */ userKey?: string; } - export interface Params$Resource$Verificationcodes$List { + export interface Params$Resource$Verificationcodes$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/admin/reports_v1.ts b/src/apis/admin/reports_v1.ts index dd73ca5e15..5d96ad655b 100644 --- a/src/apis/admin/reports_v1.ts +++ b/src/apis/admin/reports_v1.ts @@ -29,6 +29,40 @@ export namespace admin_reports_v1 { version: 'reports_v1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Admin Reports API * @@ -393,7 +427,7 @@ export namespace admin_reports_v1 { } } - export interface Params$Resource$Activities$List { + export interface Params$Resource$Activities$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -444,7 +478,7 @@ export namespace admin_reports_v1 { */ userKey?: string; } - export interface Params$Resource$Activities$Watch { + export interface Params$Resource$Activities$Watch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -578,7 +612,7 @@ export namespace admin_reports_v1 { } } - export interface Params$Resource$Channels$Stop { + export interface Params$Resource$Channels$Stop extends StandardParameters { /** * Auth client or API Key for the request */ @@ -671,7 +705,8 @@ export namespace admin_reports_v1 { } } - export interface Params$Resource$Customerusagereports$Get { + export interface Params$Resource$Customerusagereports$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -783,7 +818,8 @@ export namespace admin_reports_v1 { } } - export interface Params$Resource$Entityusagereports$Get { + export interface Params$Resource$Entityusagereports$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -909,7 +945,8 @@ export namespace admin_reports_v1 { } } - export interface Params$Resource$Userusagereport$Get { + export interface Params$Resource$Userusagereport$Get extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/adsense/v1.4.ts b/src/apis/adsense/v1.4.ts index 8db6694427..9525838a54 100644 --- a/src/apis/adsense/v1.4.ts +++ b/src/apis/adsense/v1.4.ts @@ -29,6 +29,40 @@ export namespace adsense_v1_4 { version: 'v1_4'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * AdSense Management API * @@ -761,7 +795,7 @@ export namespace adsense_v1_4 { } } - export interface Params$Resource$Accounts$Get { + export interface Params$Resource$Accounts$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -776,7 +810,7 @@ export namespace adsense_v1_4 { */ tree?: boolean; } - export interface Params$Resource$Accounts$List { + export interface Params$Resource$Accounts$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -945,7 +979,8 @@ export namespace adsense_v1_4 { } } - export interface Params$Resource$Accounts$Adclients$Getadcode { + export interface Params$Resource$Accounts$Adclients$Getadcode extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -960,7 +995,8 @@ export namespace adsense_v1_4 { */ adClientId?: string; } - export interface Params$Resource$Accounts$Adclients$List { + export interface Params$Resource$Accounts$Adclients$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1208,7 +1244,8 @@ export namespace adsense_v1_4 { } } - export interface Params$Resource$Accounts$Adunits$Get { + export interface Params$Resource$Accounts$Adunits$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1227,7 +1264,8 @@ export namespace adsense_v1_4 { */ adUnitId?: string; } - export interface Params$Resource$Accounts$Adunits$Getadcode { + export interface Params$Resource$Accounts$Adunits$Getadcode extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1246,7 +1284,8 @@ export namespace adsense_v1_4 { */ adUnitId?: string; } - export interface Params$Resource$Accounts$Adunits$List { + export interface Params$Resource$Accounts$Adunits$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1362,7 +1401,8 @@ export namespace adsense_v1_4 { } } - export interface Params$Resource$Accounts$Adunits$Customchannels$List { + export interface Params$Resource$Accounts$Adunits$Customchannels$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1542,7 +1582,8 @@ export namespace adsense_v1_4 { } } - export interface Params$Resource$Accounts$Alerts$Delete { + export interface Params$Resource$Accounts$Alerts$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1557,7 +1598,8 @@ export namespace adsense_v1_4 { */ alertId?: string; } - export interface Params$Resource$Accounts$Alerts$List { + export interface Params$Resource$Accounts$Alerts$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1731,7 +1773,8 @@ export namespace adsense_v1_4 { } } - export interface Params$Resource$Accounts$Customchannels$Get { + export interface Params$Resource$Accounts$Customchannels$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1750,7 +1793,8 @@ export namespace adsense_v1_4 { */ customChannelId?: string; } - export interface Params$Resource$Accounts$Customchannels$List { + export interface Params$Resource$Accounts$Customchannels$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1862,7 +1906,8 @@ export namespace adsense_v1_4 { } } - export interface Params$Resource$Accounts$Customchannels$Adunits$List { + export interface Params$Resource$Accounts$Customchannels$Adunits$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1977,7 +2022,8 @@ export namespace adsense_v1_4 { } } - export interface Params$Resource$Accounts$Payments$List { + export interface Params$Resource$Accounts$Payments$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2092,7 +2138,8 @@ export namespace adsense_v1_4 { } } - export interface Params$Resource$Accounts$Reports$Generate { + export interface Params$Resource$Accounts$Reports$Generate extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2317,7 +2364,8 @@ export namespace adsense_v1_4 { } } - export interface Params$Resource$Accounts$Reports$Saved$Generate { + export interface Params$Resource$Accounts$Reports$Saved$Generate extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2345,7 +2393,8 @@ export namespace adsense_v1_4 { */ startIndex?: number; } - export interface Params$Resource$Accounts$Reports$Saved$List { + export interface Params$Resource$Accounts$Reports$Saved$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2518,7 +2567,8 @@ export namespace adsense_v1_4 { } } - export interface Params$Resource$Accounts$Savedadstyles$Get { + export interface Params$Resource$Accounts$Savedadstyles$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2533,7 +2583,8 @@ export namespace adsense_v1_4 { */ savedAdStyleId?: string; } - export interface Params$Resource$Accounts$Savedadstyles$List { + export interface Params$Resource$Accounts$Savedadstyles$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2642,7 +2693,8 @@ export namespace adsense_v1_4 { } } - export interface Params$Resource$Accounts$Urlchannels$List { + export interface Params$Resource$Accounts$Urlchannels$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2749,7 +2801,7 @@ export namespace adsense_v1_4 { } } - export interface Params$Resource$Adclients$List { + export interface Params$Resource$Adclients$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2983,7 +3035,7 @@ export namespace adsense_v1_4 { } } - export interface Params$Resource$Adunits$Get { + export interface Params$Resource$Adunits$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2998,7 +3050,8 @@ export namespace adsense_v1_4 { */ adUnitId?: string; } - export interface Params$Resource$Adunits$Getadcode { + export interface Params$Resource$Adunits$Getadcode extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3013,7 +3066,7 @@ export namespace adsense_v1_4 { */ adUnitId?: string; } - export interface Params$Resource$Adunits$List { + export interface Params$Resource$Adunits$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3124,7 +3177,8 @@ export namespace adsense_v1_4 { } } - export interface Params$Resource$Adunits$Customchannels$List { + export interface Params$Resource$Adunits$Customchannels$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3293,7 +3347,7 @@ export namespace adsense_v1_4 { } } - export interface Params$Resource$Alerts$Delete { + export interface Params$Resource$Alerts$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3304,7 +3358,7 @@ export namespace adsense_v1_4 { */ alertId?: string; } - export interface Params$Resource$Alerts$List { + export interface Params$Resource$Alerts$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3469,7 +3523,8 @@ export namespace adsense_v1_4 { } } - export interface Params$Resource$Customchannels$Get { + export interface Params$Resource$Customchannels$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3484,7 +3539,8 @@ export namespace adsense_v1_4 { */ customChannelId?: string; } - export interface Params$Resource$Customchannels$List { + export interface Params$Resource$Customchannels$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3591,7 +3647,8 @@ export namespace adsense_v1_4 { } } - export interface Params$Resource$Customchannels$Adunits$List { + export interface Params$Resource$Customchannels$Adunits$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3719,7 +3776,8 @@ export namespace adsense_v1_4 { } } - export interface Params$Resource$Metadata$Dimensions$List { + export interface Params$Resource$Metadata$Dimensions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3805,7 +3863,8 @@ export namespace adsense_v1_4 { } } - export interface Params$Resource$Metadata$Metrics$List { + export interface Params$Resource$Metadata$Metrics$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3889,7 +3948,7 @@ export namespace adsense_v1_4 { } } - export interface Params$Resource$Payments$List { + export interface Params$Resource$Payments$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3997,7 +4056,7 @@ export namespace adsense_v1_4 { } } - export interface Params$Resource$Reports$Generate { + export interface Params$Resource$Reports$Generate extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4216,7 +4275,8 @@ export namespace adsense_v1_4 { } } - export interface Params$Resource$Reports$Saved$Generate { + export interface Params$Resource$Reports$Saved$Generate extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4240,7 +4300,8 @@ export namespace adsense_v1_4 { */ startIndex?: number; } - export interface Params$Resource$Reports$Saved$List { + export interface Params$Resource$Reports$Saved$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4403,7 +4464,8 @@ export namespace adsense_v1_4 { } } - export interface Params$Resource$Savedadstyles$Get { + export interface Params$Resource$Savedadstyles$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4414,7 +4476,8 @@ export namespace adsense_v1_4 { */ savedAdStyleId?: string; } - export interface Params$Resource$Savedadstyles$List { + export interface Params$Resource$Savedadstyles$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4515,7 +4578,7 @@ export namespace adsense_v1_4 { } } - export interface Params$Resource$Urlchannels$List { + export interface Params$Resource$Urlchannels$List extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/adsensehost/v4.1.ts b/src/apis/adsensehost/v4.1.ts index 20e83f3b35..98f3addd0e 100644 --- a/src/apis/adsensehost/v4.1.ts +++ b/src/apis/adsensehost/v4.1.ts @@ -29,6 +29,40 @@ export namespace adsensehost_v4_1 { version: 'v4_1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * AdSense Host API * @@ -546,7 +580,7 @@ export namespace adsensehost_v4_1 { } } - export interface Params$Resource$Accounts$Get { + export interface Params$Resource$Accounts$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -557,7 +591,7 @@ export namespace adsensehost_v4_1 { */ accountId?: string; } - export interface Params$Resource$Accounts$List { + export interface Params$Resource$Accounts$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -717,7 +751,8 @@ export namespace adsensehost_v4_1 { } } - export interface Params$Resource$Accounts$Adclients$Get { + export interface Params$Resource$Accounts$Adclients$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -732,7 +767,8 @@ export namespace adsensehost_v4_1 { */ adClientId?: string; } - export interface Params$Resource$Accounts$Adclients$List { + export interface Params$Resource$Accounts$Adclients$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1263,7 +1299,8 @@ export namespace adsensehost_v4_1 { } } - export interface Params$Resource$Accounts$Adunits$Delete { + export interface Params$Resource$Accounts$Adunits$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1282,7 +1319,8 @@ export namespace adsensehost_v4_1 { */ adUnitId?: string; } - export interface Params$Resource$Accounts$Adunits$Get { + export interface Params$Resource$Accounts$Adunits$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1301,7 +1339,8 @@ export namespace adsensehost_v4_1 { */ adUnitId?: string; } - export interface Params$Resource$Accounts$Adunits$Getadcode { + export interface Params$Resource$Accounts$Adunits$Getadcode extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1324,7 +1363,8 @@ export namespace adsensehost_v4_1 { */ hostCustomChannelId?: string; } - export interface Params$Resource$Accounts$Adunits$Insert { + export interface Params$Resource$Accounts$Adunits$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1344,7 +1384,8 @@ export namespace adsensehost_v4_1 { */ requestBody?: Schema$AdUnit; } - export interface Params$Resource$Accounts$Adunits$List { + export interface Params$Resource$Accounts$Adunits$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1374,7 +1415,8 @@ export namespace adsensehost_v4_1 { */ pageToken?: string; } - export interface Params$Resource$Accounts$Adunits$Patch { + export interface Params$Resource$Accounts$Adunits$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1398,7 +1440,8 @@ export namespace adsensehost_v4_1 { */ requestBody?: Schema$AdUnit; } - export interface Params$Resource$Accounts$Adunits$Update { + export interface Params$Resource$Accounts$Adunits$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1509,7 +1552,8 @@ export namespace adsensehost_v4_1 { } } - export interface Params$Resource$Accounts$Reports$Generate { + export interface Params$Resource$Accounts$Reports$Generate extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1702,7 +1746,7 @@ export namespace adsensehost_v4_1 { } } - export interface Params$Resource$Adclients$Get { + export interface Params$Resource$Adclients$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1713,7 +1757,7 @@ export namespace adsensehost_v4_1 { */ adClientId?: string; } - export interface Params$Resource$Adclients$List { + export interface Params$Resource$Adclients$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1884,7 +1928,8 @@ export namespace adsensehost_v4_1 { } } - export interface Params$Resource$Associationsessions$Start { + export interface Params$Resource$Associationsessions$Start extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1907,7 +1952,8 @@ export namespace adsensehost_v4_1 { */ websiteUrl?: string; } - export interface Params$Resource$Associationsessions$Verify { + export interface Params$Resource$Associationsessions$Verify extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2346,7 +2392,8 @@ export namespace adsensehost_v4_1 { } } - export interface Params$Resource$Customchannels$Delete { + export interface Params$Resource$Customchannels$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2361,7 +2408,8 @@ export namespace adsensehost_v4_1 { */ customChannelId?: string; } - export interface Params$Resource$Customchannels$Get { + export interface Params$Resource$Customchannels$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2376,7 +2424,8 @@ export namespace adsensehost_v4_1 { */ customChannelId?: string; } - export interface Params$Resource$Customchannels$Insert { + export interface Params$Resource$Customchannels$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2392,7 +2441,8 @@ export namespace adsensehost_v4_1 { */ requestBody?: Schema$CustomChannel; } - export interface Params$Resource$Customchannels$List { + export interface Params$Resource$Customchannels$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2414,7 +2464,8 @@ export namespace adsensehost_v4_1 { */ pageToken?: string; } - export interface Params$Resource$Customchannels$Patch { + export interface Params$Resource$Customchannels$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2434,7 +2485,8 @@ export namespace adsensehost_v4_1 { */ requestBody?: Schema$CustomChannel; } - export interface Params$Resource$Customchannels$Update { + export interface Params$Resource$Customchannels$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2539,7 +2591,7 @@ export namespace adsensehost_v4_1 { } } - export interface Params$Resource$Reports$Generate { + export interface Params$Resource$Reports$Generate extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2806,7 +2858,8 @@ export namespace adsensehost_v4_1 { } } - export interface Params$Resource$Urlchannels$Delete { + export interface Params$Resource$Urlchannels$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2821,7 +2874,8 @@ export namespace adsensehost_v4_1 { */ urlChannelId?: string; } - export interface Params$Resource$Urlchannels$Insert { + export interface Params$Resource$Urlchannels$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2837,7 +2891,7 @@ export namespace adsensehost_v4_1 { */ requestBody?: Schema$UrlChannel; } - export interface Params$Resource$Urlchannels$List { + export interface Params$Resource$Urlchannels$List extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/alertcenter/README.md b/src/apis/alertcenter/README.md index 765e9affc1..1b87f92956 100644 --- a/src/apis/alertcenter/README.md +++ b/src/apis/alertcenter/README.md @@ -2,7 +2,7 @@ # @google/alertcenter -> G Suite Alert Center API to view and manage alerts on issues affecting your domain. +> Manages alerts on issues affecting your domain. ## Installation diff --git a/src/apis/alertcenter/v1beta1.ts b/src/apis/alertcenter/v1beta1.ts index 4b8b0d9f66..a9d954e870 100644 --- a/src/apis/alertcenter/v1beta1.ts +++ b/src/apis/alertcenter/v1beta1.ts @@ -29,10 +29,61 @@ export namespace alertcenter_v1beta1 { version: 'v1beta1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * G Suite Alert Center API * - * G Suite API for alerts managment. + * Manages alerts on issues affecting your domain. * * @example * const {google} = require('googleapis'); @@ -69,13 +120,13 @@ export namespace alertcenter_v1beta1 { */ export interface Schema$AccountWarning { /** - * Required. Email of the user that this event belongs to. + * Required. The email of the user that this event belongs to. */ email?: string; /** * Optional. Details of the login action associated with the warning event. - * This is only available for: Suspicious login Suspicious login (less - * secure app) User suspended (suspicious activity) + * This is only available for: * Suspicious login * Suspicious login (less + * secure app) * User suspended (suspicious activity) */ loginDetails?: Schema$LoginDetails; } @@ -88,7 +139,7 @@ export namespace alertcenter_v1beta1 { */ alertId?: string; /** - * Output only. The time this alert was created. Assigned by the server. + * Output only. The time this alert was created. */ createTime?: string; /** @@ -96,47 +147,40 @@ export namespace alertcenter_v1beta1 { */ customerId?: string; /** - * Optional. Specific data associated with this alert. e.g. + * Optional. The data associated with this alert, for example * google.apps.alertcenter.type.DeviceCompromised. */ data?: any; /** - * Optional. The time this alert was no longer active. If provided, the end - * time must not be earlier than the start time. If not provided, the end - * time will default to the start time. + * Output only. `True` if this alert is marked for deletion. + */ + deleted?: boolean; + /** + * Optional. The time the event that caused this alert ceased being active. + * If provided, the end time must not be earlier than the start time. If not + * provided, the end time defaults to the start time. */ endTime?: string; /** - * Output only. An optional Security Investigation Tool query for this - * alert. + * Output only. An optional [Security Investigation + * Tool](https://support.google.com/a/answer/7575955) query for this alert. */ securityInvestigationToolLink?: string; /** * Required. A unique identifier for the system that is reported the alert. - * Supported sources are any of the following: * "Google - * Operations" * "Mobile device management" * "Gmail - * phishing" * "Domain wide takeout" * "Government - * attack warning" * "Google identity" + * Supported sources are any of the following: * Google Operations * Mobile + * device management * Gmail phishing * Domain wide takeout * Government + * attack warning * Google identity */ source?: string; /** - * Required. The time this alert became active. + * Required. The time the event that caused this alert was started or + * detected. */ startTime?: string; /** - * Required. The type of the alert. Supported types are any of the - * following: * "Google Operations" * "Device - * compromised" * "Suspicious activity" * "User - * reported phishing" * "Misconfigured whitelist" * - * "Customer takeout initiated" * "Government attack - * warning" * "User reported spam spike" * "Suspicious - * message reported" * "Phishing reclassification" * - * "Malware reclassification" LINT.IfChange * "Suspicious - * login" * "Suspicious login (less secure app)" * - * "User suspended" * "Leaked password" * "User - * suspended (suspicious activity)" * "User suspended - * (spam)" * "User suspended (spam through relay)" - * LINT.ThenChange(//depot/google3/apps/albert/data/albert_enums.proto) + * Required. The type of the alert. For a list of available alert types see + * [G Suite Alert types](/admin-sdk/alertcenter/reference/alert-types). */ type?: string; } @@ -149,7 +193,7 @@ export namespace alertcenter_v1beta1 { */ alertId?: string; /** - * Output only. The time this feedback was created. Assigned by the server. + * Output only. The time this feedback was created. */ createTime?: string; /** @@ -161,8 +205,7 @@ export namespace alertcenter_v1beta1 { */ email?: string; /** - * Output only. A unique identifier for the feedback. When creating a new - * feedback the system will assign one. + * Output only. The unique identifier for the feedback. */ feedbackId?: string; /** @@ -175,54 +218,54 @@ export namespace alertcenter_v1beta1 { */ export interface Schema$Attachment { /** - * CSV file attachment. + * A CSV file attachment. */ csv?: Schema$Csv; } /** - * Alert for setting the domain or ip that malicious email comes from as - * whitelisted domain or ip in Gmail advanced settings. + * Alert for setting the domain or IP that malicious email comes from as + * whitelisted domain or IP in Gmail advanced settings. */ export interface Schema$BadWhitelist { /** - * Domain id. + * The domain ID. */ domainId?: Schema$DomainId; /** - * Entity whose actions triggered a Gmail phishing alert. + * The entity whose actions triggered a Gmail phishing alert. */ maliciousEntity?: Schema$MaliciousEntity; /** - * Every alert could contain multiple messages. + * The list of messages contained by this alert. */ messages?: Schema$GmailMessageInfo[]; /** - * The source ip address of the malicious email. e.g. "127.0.0.1". + * The source IP address of the malicious email, for example, `127.0.0.1`. */ sourceIp?: string; } /** - * Representation of a CSV file attachment, as a list of column headers and a - * list of data rows. + * A representation of a CSV file attachment, as a list of column headers and + * a list of data rows. */ export interface Schema$Csv { /** - * List of data rows in a CSV file, as string arrays rather than as a single - * comma-separated string. + * The list of data rows in a CSV file, as string arrays rather than as a + * single comma-separated string. */ dataRows?: Schema$CsvRow[]; /** - * List of headers for data columns in a CSV file. + * The list of headers for data columns in a CSV file. */ headers?: string[]; } /** - * Representation of a single data row in a CSV file. + * A representation of a single data row in a CSV file. */ export interface Schema$CsvRow { /** - * Data entries in a CSV file row, as a string array rather than a single - * comma-separated string. + * The data entries in a CSV file row, as a string array rather than a + * single comma-separated string. */ entries?: string[]; } @@ -235,7 +278,7 @@ export namespace alertcenter_v1beta1 { */ email?: string; /** - * Required. List of security events. + * Required. The list of security events. */ events?: Schema$DeviceCompromisedSecurityDetail[]; } @@ -244,12 +287,12 @@ export namespace alertcenter_v1beta1 { */ export interface Schema$DeviceCompromisedSecurityDetail { /** - * Device compromised state includes: "Compromised" and "Not - * Compromised". + * The device compromised state. Possible values are + * "`Compromised`" or "`Not Compromised`". */ deviceCompromisedState?: string; /** - * Required. Device Info. + * Required. The device ID. */ deviceId?: string; /** @@ -261,11 +304,11 @@ export namespace alertcenter_v1beta1 { */ deviceType?: string; /** - * Required for IOS, empty for others. + * Required for iOS, empty for others. */ iosVendorId?: string; /** - * The device resource id. + * The device resource ID. */ resourceId?: string; /** @@ -274,7 +317,7 @@ export namespace alertcenter_v1beta1 { serialNumber?: string; } /** - * Domain id of Gmail phishing alerts. + * Domain ID of Gmail phishing alerts. */ export interface Schema$DomainId { /** @@ -288,11 +331,11 @@ export namespace alertcenter_v1beta1 { */ export interface Schema$DomainWideTakeoutInitiated { /** - * Email of the admin who initiated the takeout. + * The email of the admin who initiated the takeout. */ email?: string; /** - * takeout request id. + * The takeout request ID. */ takeoutRequestId?: string; } @@ -309,7 +352,7 @@ export namespace alertcenter_v1beta1 { */ export interface Schema$GmailMessageInfo { /** - * SHA256 Hash of email's attachment and all MIME parts. + * The `SHA256` hash of email's attachment and all MIME parts. */ attachmentsSha256Hash?: string[]; /** @@ -317,27 +360,28 @@ export namespace alertcenter_v1beta1 { */ date?: string; /** - * Hash of message body text. + * The hash of the message body text. */ md5HashMessageBody?: string; /** - * MD5 Hash of email's subject. (Only available for reported emails). + * The MD5 Hash of email's subject (only available for reported emails). */ md5HashSubject?: string; /** - * Snippet of the message body text. (Only available for reported emails) + * The snippet of the message body text (only available for reported + * emails). */ messageBodySnippet?: string; /** - * Message id. + * The message ID. */ messageId?: string; /** - * Recipient of this email. + * The recipient of this email. */ recipient?: string; /** - * Email subject text. (Only available for reported emails). + * The email subject text (only available for reported emails). */ subjectText?: string; } @@ -346,22 +390,22 @@ export namespace alertcenter_v1beta1 { */ export interface Schema$GoogleOperations { /** - * List of emails which correspond to the users directly affected by the + * The list of emails which correspond to the users directly affected by the * incident. */ affectedUserEmails?: string[]; /** - * Optional application-specific data for an incident, provided when the G + * Optional. Application-specific data for an incident, provided when the G * Suite application which reported the incident cannot be completely * restored to a valid state. */ attachmentData?: Schema$Attachment; /** - * Detailed, freeform incident description. + * A detailed, freeform incident description. */ description?: string; /** - * One-line incident description. + * A one-line incident description. */ title?: string; } @@ -370,8 +414,8 @@ export namespace alertcenter_v1beta1 { */ export interface Schema$ListAlertFeedbackResponse { /** - * The list of alert feedback. Result is ordered descending by creation - * time. + * The list of alert feedback. Feedback entries for each alert are ordered + * by creation time descending. */ feedback?: Schema$AlertFeedback[]; } @@ -384,47 +428,49 @@ export namespace alertcenter_v1beta1 { */ alerts?: Schema$Alert[]; /** - * If not empty, indicates that there may be more alerts that match the - * request; this value can be passed in a new ListAlertsRequest to get the - * next page of values. + * The token for the next page. If not empty, indicates that there may be + * more alerts that match the listing request; this value can be used in a + * subsequent ListAlertsRequest to get alerts continuing from last result of + * the current list call. */ nextPageToken?: string; } /** - * Details of the login action + * The details of the login action. */ export interface Schema$LoginDetails { /** - * Required. Human readable IP address (e.g., 11.22.33.44) that is - * associated with the warning event. + * Optional. The human-readable IP address (for example, `11.22.33.44`) that + * is associated with the warning event. */ ipAddress?: string; /** - * Required. Login time that is associated with the warning event. + * Optional. The successful login time that is associated with the warning + * event. This will not be present for blocked login attempts. */ loginTime?: string; } /** * Proto for all phishing alerts with common payload. Supported types are any - * of the following: User reported phishing User reported spam spike - * Suspicious message reported Phishing reclassification Malware + * of the following: * User reported phishing * User reported spam spike * + * Suspicious message reported * Phishing reclassification * Malware * reclassification */ export interface Schema$MailPhishing { /** - * Domain id. + * The domain ID. */ domainId?: Schema$DomainId; /** - * If true, the email is originated from within the organization. + * If `true`, the email originated from within the organization. */ isInternal?: boolean; /** - * Entity whose actions triggered a Gmail phishing alert. + * The entity whose actions triggered a Gmail phishing alert. */ maliciousEntity?: Schema$MaliciousEntity; /** - * Every alert could contain multiple messages. + * The list of messages contained by this alert. */ messages?: Schema$GmailMessageInfo[]; } @@ -433,34 +479,37 @@ export namespace alertcenter_v1beta1 { */ export interface Schema$MaliciousEntity { /** - * Sender email address. + * The sender email address. */ fromHeader?: string; } /** - * Alert for a spike in user reported phishing. This will be deprecated in - * favor of MailPhishing. + * Alert for a spike in user reported phishing. <aside + * class="warning"><b>Warning</b>: This type has been + * deprecated. Use + * [MailPhishing](/admin-sdk/alertcenter/reference/rest/v1beta1/MailPhishing) + * instead.</aside> */ export interface Schema$PhishingSpike { /** - * Domain id. + * The domain ID. */ domainId?: Schema$DomainId; /** - * If true, the email is originated from within the organization. + * If `true`, the email originated from within the organization. */ isInternal?: boolean; /** - * Entity whose actions triggered a Gmail phishing alert. + * The entity whose actions triggered a Gmail phishing alert. */ maliciousEntity?: Schema$MaliciousEntity; /** - * Every alert could contain multiple messages. + * The list of messages contained by this alert. */ messages?: Schema$GmailMessageInfo[]; } /** - * A state sponsored attack alert. Derived from audit logs. + * A state-sponsored attack alert. Derived from audit logs. */ export interface Schema$StateSponsoredAttack { /** @@ -477,7 +526,7 @@ export namespace alertcenter_v1beta1 { */ email?: string; /** - * Required. List of security events. + * Required. The list of security events. */ events?: Schema$SuspiciousActivitySecurityDetail[]; } @@ -486,7 +535,7 @@ export namespace alertcenter_v1beta1 { */ export interface Schema$SuspiciousActivitySecurityDetail { /** - * Required. Device Info. + * Required. The device ID. */ deviceId?: string; /** @@ -494,7 +543,7 @@ export namespace alertcenter_v1beta1 { */ deviceModel?: string; /** - * Device property which is changed. + * The device property which was changed. */ deviceProperty?: string; /** @@ -502,19 +551,19 @@ export namespace alertcenter_v1beta1 { */ deviceType?: string; /** - * Required for IOS, empty for others. + * Required for iOS, empty for others. */ iosVendorId?: string; /** - * New value of the device property after change. + * The new value of the device property after the change. */ newValue?: string; /** - * Old value of the device property before change. + * The old value of the device property before the change. */ oldValue?: string; /** - * The device resource id. + * The device resource ID. */ resourceId?: string; /** @@ -541,17 +590,16 @@ export namespace alertcenter_v1beta1 { /** * alertcenter.alerts.delete * @desc Marks the specified alert for deletion. An alert that has been - * marked for deletion will be excluded from the results of a List operation - * by default, and will be removed from the Alert Center after 30 days. - * Marking an alert for deletion will have no effect on an alert which has - * already been marked for deletion. Attempting to mark a nonexistent alert - * for deletion will return NOT_FOUND. + * marked for deletion is removed from Alert Center after 30 days. Marking + * an alert for deletion has no effect on an alert which has already been + * marked for deletion. Attempting to mark a nonexistent alert for deletion + * results in a `NOT_FOUND` error. * @alias alertcenter.alerts.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.alertId Required. The identifier of the alert to delete. - * @param {string=} params.customerId Optional. The unique identifier of the Google account of the customer the alert is associated with. This is obfuscated and not the plain customer ID as stored internally. Inferred from the caller identity if not provided. + * @param {string=} params.customerId Optional. The unique identifier of the G Suite organization account of the customer the alert is associated with. Inferred from the caller identity if not 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 @@ -615,8 +663,8 @@ export namespace alertcenter_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.alertId Required. The identifier of the alert to retrieve. - * @param {string=} params.customerId Optional. The unique identifier of the Google account of the customer the alert is associated with. This is obfuscated and not the plain customer ID as stored internally. Inferred from the caller identity if not provided. + * @param {string} params.alertId Required. The identifier of the alert to retrieve. Returns a NOT_FOUND error if no such alert. + * @param {string=} params.customerId Optional. The unique identifier of the G Suite organization account of the customer the alert is associated with. Inferred from the caller identity if not 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 @@ -672,15 +720,15 @@ export namespace alertcenter_v1beta1 { /** * alertcenter.alerts.list - * @desc Lists all the alerts for the current user and application. + * @desc Lists the alerts. * @alias alertcenter.alerts.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.customerId Optional. The unique identifier of the Google account of the customer the alerts are associated with. This is obfuscated and not the plain customer ID as stored internally. Inferred from the caller identity if not provided. - * @param {string=} params.filter Optional. Query string for filtering alert results. This string must be specified as an expression or list of expressions, using the following grammar: ### Expressions An expression has the general form ` `. A field or value which contains a space or a colon must be enclosed by double quotes. #### Operators Operators follow the BNF specification: ` ::= "=" | ":"` ` ::= "<" | ">" | "<=" | ">="` Relational operators are defined only for timestamp fields. Equality operators are defined only for string fields. #### Timestamp fields The value supplied for a timestamp field must be an [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time string. Supported timestamp fields are `create_time`, `start_time`, and `end_time`. #### String fields The value supplied for a string field may be an arbitrary string. #### Examples To query for all alerts created on or after April 5, 2018: `create_time >= "2018-04-05T00:00:00Z"` To query for all alerts from the source "Gmail phishing": `source:"Gmail phishing"` ### Joining expressions Expressions may be joined to form a more complex query. The BNF specification is: ` ::= | | ` ` ::= "AND" | "OR" | ""` ` ::= "NOT"` Using the empty string as a conjunction acts as an implicit AND. The precedence of joining operations, from highest to lowest, is NOT, AND, OR. #### Examples To query for all alerts which started in 2017: `start_time >= "2017-01-01T00:00:00Z" AND start_time < "2018-01-01T00:00:00Z"` To query for all user reported phishing alerts from the source "Gmail phishing": `type:"User reported phishing" source:"Gmail phishing"` - * @param {string=} params.orderBy Optional. Sort the list results by a certain order. If not specified results may be returned in arbitrary order. You can sort the results in a descending order based on the creation timestamp using order_by="create_time desc". Currently, only sorting by create_time desc is supported. - * @param {integer=} params.pageSize Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + * @param {string=} params.customerId Optional. The unique identifier of the G Suite organization account of the customer the alerts are associated with. Inferred from the caller identity if not provided. + * @param {string=} params.filter Optional. A query string for filtering alert results. For more details, see [Query filters](/admin-sdk/alertcenter/guides/query-filters) and [Supported query filter fields](/admin-sdk/alertcenter/reference/filter-fields). + * @param {string=} params.orderBy Optional. The sort order of the list results. If not specified results may be returned in arbitrary order. You can sort the results in descending order based on the creation timestamp using `order_by="create_time desc"`. Currently, only sorting by `create_time desc` is supported. + * @param {integer=} params.pageSize Optional. The requested page size. Server may return fewer items than requested. If unspecified, server picks an appropriate default. * @param {string=} params.pageToken Optional. A token identifying a page of results the server should return. If empty, a new iteration is started. To continue an iteration, pass in the value from the previous ListAlertsResponse's next_page_token field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -738,7 +786,7 @@ export namespace alertcenter_v1beta1 { } } - export interface Params$Resource$Alerts$Delete { + export interface Params$Resource$Alerts$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -749,85 +797,60 @@ export namespace alertcenter_v1beta1 { */ alertId?: string; /** - * Optional. The unique identifier of the Google account of the customer the - * alert is associated with. This is obfuscated and not the plain customer - * ID as stored internally. Inferred from the caller identity if not - * provided. + * Optional. The unique identifier of the G Suite organization account of + * the customer the alert is associated with. Inferred from the caller + * identity if not provided. */ customerId?: string; } - export interface Params$Resource$Alerts$Get { + export interface Params$Resource$Alerts$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * Required. The identifier of the alert to retrieve. + * Required. The identifier of the alert to retrieve. Returns a NOT_FOUND + * error if no such alert. */ alertId?: string; /** - * Optional. The unique identifier of the Google account of the customer the - * alert is associated with. This is obfuscated and not the plain customer - * ID as stored internally. Inferred from the caller identity if not - * provided. + * Optional. The unique identifier of the G Suite organization account of + * the customer the alert is associated with. Inferred from the caller + * identity if not provided. */ customerId?: string; } - export interface Params$Resource$Alerts$List { + export interface Params$Resource$Alerts$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * Optional. The unique identifier of the Google account of the customer the - * alerts are associated with. This is obfuscated and not the plain customer - * ID as stored internally. Inferred from the caller identity if not - * provided. + * Optional. The unique identifier of the G Suite organization account of + * the customer the alerts are associated with. Inferred from the caller + * identity if not provided. */ customerId?: string; /** - * Optional. Query string for filtering alert results. This string must be - * specified as an expression or list of expressions, using the following - * grammar: ### Expressions An expression has the general form ` - * `. A field or value which contains a space or a colon - * must be enclosed by double quotes. #### Operators Operators follow the - * BNF specification: ` ::= "=" | ":"` - * ` ::= "<" | ">" | "<=" | ">="` Relational operators - * are defined only for timestamp fields. Equality operators are defined - * only for string fields. #### Timestamp fields The value supplied for a - * timestamp field must be an [RFC - * 3339](https://tools.ietf.org/html/rfc3339) date-time string. Supported - * timestamp fields are `create_time`, `start_time`, and `end_time`. #### - * String fields The value supplied for a string field may be an arbitrary - * string. #### Examples To query for all alerts created on or after April - * 5, 2018: `create_time >= "2018-04-05T00:00:00Z"` To query for all - * alerts from the source "Gmail phishing": `source:"Gmail phishing"` ### - * Joining expressions Expressions may be joined to form a more complex - * query. The BNF specification is: ` ::= | - * | - * ` ` ::= "AND" | "OR" | ""` ` ::= - * "NOT"` Using the empty string as a conjunction acts as an implicit AND. - * The precedence of joining operations, from highest to lowest, is NOT, - * AND, OR. #### Examples To query for all alerts which started in 2017: - * `start_time >= "2017-01-01T00:00:00Z" AND start_time < - * "2018-01-01T00:00:00Z"` To query for all user reported phishing alerts - * from the source "Gmail phishing": `type:"User reported phishing" - * source:"Gmail phishing"` + * Optional. A query string for filtering alert results. For more details, + * see [Query filters](/admin-sdk/alertcenter/guides/query-filters) and + * [Supported query filter + * fields](/admin-sdk/alertcenter/reference/filter-fields). */ filter?: string; /** - * Optional. Sort the list results by a certain order. If not specified - * results may be returned in arbitrary order. You can sort the results in a + * Optional. The sort order of the list results. If not specified results + * may be returned in arbitrary order. You can sort the results in * descending order based on the creation timestamp using - * order_by="create_time desc". Currently, only sorting by create_time desc - * is supported. + * `order_by="create_time desc"`. Currently, only sorting by `create_time + * desc` is supported. */ orderBy?: string; /** - * Optional. Requested page size. Server may return fewer items than - * requested. If unspecified, server will pick an appropriate default. + * Optional. The requested page size. Server may return fewer items than + * requested. If unspecified, server picks an appropriate default. */ pageSize?: number; /** @@ -852,13 +875,13 @@ export namespace alertcenter_v1beta1 { /** * alertcenter.alerts.feedback.create - * @desc Creates a new alert feedback. + * @desc Creates new feedback for an alert. * @alias alertcenter.alerts.feedback.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.alertId Required. The identifier of the alert this feedback belongs to. Returns a NOT_FOUND error if no such alert. - * @param {string=} params.customerId Optional. The unique identifier of the Google account of the customer the alert's feedback is associated with. This is obfuscated and not the plain customer ID as stored internally. Inferred from the caller identity if not provided. + * @param {string} params.alertId Required. The identifier of the alert this feedback belongs to. Returns a `NOT_FOUND` error if no such alert. + * @param {string=} params.customerId Optional. The unique identifier of the G Suite organization account of the customer the alert is associated with. Inferred from the caller identity if not provided. * @param {().AlertFeedback} 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. @@ -926,8 +949,9 @@ export namespace alertcenter_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.alertId Required. The alert identifier. If the alert does not exist returns a NOT_FOUND error. - * @param {string=} params.customerId Optional. The unique identifier of the Google account of the customer the alert is associated with. This is obfuscated and not the plain customer ID as stored internally. Inferred from the caller identity if not provided. + * @param {string} params.alertId Required. The alert identifier. The "-" wildcard could be used to represent all alerts. If alert does not exist returns a `NOT_FOUND` error. + * @param {string=} params.customerId Optional. The unique identifier of the G Suite organization account of the customer the alert feedback are associated with. Inferred from the caller identity if not provided. + * @param {string=} params.filter * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -990,7 +1014,8 @@ export namespace alertcenter_v1beta1 { } } - export interface Params$Resource$Alerts$Feedback$Create { + export interface Params$Resource$Alerts$Feedback$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -998,14 +1023,13 @@ export namespace alertcenter_v1beta1 { /** * Required. The identifier of the alert this feedback belongs to. Returns a - * NOT_FOUND error if no such alert. + * `NOT_FOUND` error if no such alert. */ alertId?: string; /** - * Optional. The unique identifier of the Google account of the customer the - * alert's feedback is associated with. This is obfuscated and not the plain - * customer ID as stored internally. Inferred from the caller identity if - * not provided. + * Optional. The unique identifier of the G Suite organization account of + * the customer the alert is associated with. Inferred from the caller + * identity if not provided. */ customerId?: string; @@ -1014,23 +1038,28 @@ export namespace alertcenter_v1beta1 { */ requestBody?: Schema$AlertFeedback; } - export interface Params$Resource$Alerts$Feedback$List { + export interface Params$Resource$Alerts$Feedback$List extends + StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * Required. The alert identifier. If the alert does not exist returns a - * NOT_FOUND error. + * Required. The alert identifier. The "-" wildcard could be used to + * represent all alerts. If alert does not exist returns a `NOT_FOUND` + * error. */ alertId?: string; /** - * Optional. The unique identifier of the Google account of the customer the - * alert is associated with. This is obfuscated and not the plain customer - * ID as stored internally. Inferred from the caller identity if not - * provided. + * Optional. The unique identifier of the G Suite organization account of + * the customer the alert feedback are associated with. Inferred from the + * caller identity if not provided. */ customerId?: string; + /** + * + */ + filter?: string; } } diff --git a/src/apis/analytics/v2.4.ts b/src/apis/analytics/v2.4.ts index 5f99103839..224fe69925 100644 --- a/src/apis/analytics/v2.4.ts +++ b/src/apis/analytics/v2.4.ts @@ -29,6 +29,40 @@ export namespace analytics_v2_4 { version: 'v2_4'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Google Analytics API * @@ -148,7 +182,7 @@ export namespace analytics_v2_4 { } } - export interface Params$Resource$Data$Get { + export interface Params$Resource$Data$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -307,7 +341,8 @@ export namespace analytics_v2_4 { } } - export interface Params$Resource$Management$Accounts$List { + export interface Params$Resource$Management$Accounts$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -408,7 +443,8 @@ export namespace analytics_v2_4 { } } - export interface Params$Resource$Management$Goals$List { + export interface Params$Resource$Management$Goals$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -525,7 +561,8 @@ export namespace analytics_v2_4 { } } - export interface Params$Resource$Management$Profiles$List { + export interface Params$Resource$Management$Profiles$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -633,7 +670,8 @@ export namespace analytics_v2_4 { } } - export interface Params$Resource$Management$Segments$List { + export interface Params$Resource$Management$Segments$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -732,7 +770,8 @@ export namespace analytics_v2_4 { } } - export interface Params$Resource$Management$Webproperties$List { + export interface Params$Resource$Management$Webproperties$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/analytics/v3.ts b/src/apis/analytics/v3.ts index cc73f79cc8..c1cee7ad28 100644 --- a/src/apis/analytics/v3.ts +++ b/src/apis/analytics/v3.ts @@ -29,6 +29,40 @@ export namespace analytics_v3 { version: 'v3'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Google Analytics API * @@ -2749,7 +2783,7 @@ export namespace analytics_v3 { } } - export interface Params$Resource$Data$Ga$Get { + export interface Params$Resource$Data$Ga$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2903,7 +2937,7 @@ export namespace analytics_v3 { } } - export interface Params$Resource$Data$Mcf$Get { + export interface Params$Resource$Data$Mcf$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3043,7 +3077,8 @@ export namespace analytics_v3 { } } - export interface Params$Resource$Data$Realtime$Get { + export interface Params$Resource$Data$Realtime$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3218,7 +3253,8 @@ export namespace analytics_v3 { } } - export interface Params$Resource$Management$Accounts$List { + export interface Params$Resource$Management$Accounts$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3317,7 +3353,8 @@ export namespace analytics_v3 { } } - export interface Params$Resource$Management$Accountsummaries$List { + export interface Params$Resource$Management$Accountsummaries$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3628,7 +3665,8 @@ export namespace analytics_v3 { } } - export interface Params$Resource$Management$Accountuserlinks$Delete { + export interface Params$Resource$Management$Accountuserlinks$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3643,7 +3681,8 @@ export namespace analytics_v3 { */ linkId?: string; } - export interface Params$Resource$Management$Accountuserlinks$Insert { + export interface Params$Resource$Management$Accountuserlinks$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3659,7 +3698,8 @@ export namespace analytics_v3 { */ requestBody?: Schema$EntityUserLink; } - export interface Params$Resource$Management$Accountuserlinks$List { + export interface Params$Resource$Management$Accountuserlinks$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3679,7 +3719,8 @@ export namespace analytics_v3 { */ 'start-index'?: number; } - export interface Params$Resource$Management$Accountuserlinks$Update { + export interface Params$Resource$Management$Accountuserlinks$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3782,7 +3823,8 @@ export namespace analytics_v3 { } } - export interface Params$Resource$Management$Clientid$Hashclientid { + export interface Params$Resource$Management$Clientid$Hashclientid extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3880,7 +3922,8 @@ export namespace analytics_v3 { } } - export interface Params$Resource$Management$Customdatasources$List { + export interface Params$Resource$Management$Customdatasources$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4275,7 +4318,8 @@ export namespace analytics_v3 { } } - export interface Params$Resource$Management$Customdimensions$Get { + export interface Params$Resource$Management$Customdimensions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4294,7 +4338,8 @@ export namespace analytics_v3 { */ webPropertyId?: string; } - export interface Params$Resource$Management$Customdimensions$Insert { + export interface Params$Resource$Management$Customdimensions$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4314,7 +4359,8 @@ export namespace analytics_v3 { */ requestBody?: Schema$CustomDimension; } - export interface Params$Resource$Management$Customdimensions$List { + export interface Params$Resource$Management$Customdimensions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4338,7 +4384,8 @@ export namespace analytics_v3 { */ webPropertyId?: string; } - export interface Params$Resource$Management$Customdimensions$Patch { + export interface Params$Resource$Management$Customdimensions$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4367,7 +4414,8 @@ export namespace analytics_v3 { */ requestBody?: Schema$CustomDimension; } - export interface Params$Resource$Management$Customdimensions$Update { + export interface Params$Resource$Management$Customdimensions$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4767,7 +4815,8 @@ export namespace analytics_v3 { } } - export interface Params$Resource$Management$Custommetrics$Get { + export interface Params$Resource$Management$Custommetrics$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4786,7 +4835,8 @@ export namespace analytics_v3 { */ webPropertyId?: string; } - export interface Params$Resource$Management$Custommetrics$Insert { + export interface Params$Resource$Management$Custommetrics$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4806,7 +4856,8 @@ export namespace analytics_v3 { */ requestBody?: Schema$CustomMetric; } - export interface Params$Resource$Management$Custommetrics$List { + export interface Params$Resource$Management$Custommetrics$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4830,7 +4881,8 @@ export namespace analytics_v3 { */ webPropertyId?: string; } - export interface Params$Resource$Management$Custommetrics$Patch { + export interface Params$Resource$Management$Custommetrics$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4859,7 +4911,8 @@ export namespace analytics_v3 { */ requestBody?: Schema$CustomMetric; } - export interface Params$Resource$Management$Custommetrics$Update { + export interface Params$Resource$Management$Custommetrics$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5336,7 +5389,8 @@ export namespace analytics_v3 { } } - export interface Params$Resource$Management$Experiments$Delete { + export interface Params$Resource$Management$Experiments$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5359,7 +5413,8 @@ export namespace analytics_v3 { */ webPropertyId?: string; } - export interface Params$Resource$Management$Experiments$Get { + export interface Params$Resource$Management$Experiments$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5382,7 +5437,8 @@ export namespace analytics_v3 { */ webPropertyId?: string; } - export interface Params$Resource$Management$Experiments$Insert { + export interface Params$Resource$Management$Experiments$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5406,7 +5462,8 @@ export namespace analytics_v3 { */ requestBody?: Schema$Experiment; } - export interface Params$Resource$Management$Experiments$List { + export interface Params$Resource$Management$Experiments$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5434,7 +5491,8 @@ export namespace analytics_v3 { */ webPropertyId?: string; } - export interface Params$Resource$Management$Experiments$Patch { + export interface Params$Resource$Management$Experiments$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5462,7 +5520,8 @@ export namespace analytics_v3 { */ requestBody?: Schema$Experiment; } - export interface Params$Resource$Management$Experiments$Update { + export interface Params$Resource$Management$Experiments$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5915,7 +5974,8 @@ export namespace analytics_v3 { } } - export interface Params$Resource$Management$Filters$Delete { + export interface Params$Resource$Management$Filters$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5930,7 +5990,8 @@ export namespace analytics_v3 { */ filterId?: string; } - export interface Params$Resource$Management$Filters$Get { + export interface Params$Resource$Management$Filters$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5945,7 +6006,8 @@ export namespace analytics_v3 { */ filterId?: string; } - export interface Params$Resource$Management$Filters$Insert { + export interface Params$Resource$Management$Filters$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5961,7 +6023,8 @@ export namespace analytics_v3 { */ requestBody?: Schema$Filter; } - export interface Params$Resource$Management$Filters$List { + export interface Params$Resource$Management$Filters$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5981,7 +6044,8 @@ export namespace analytics_v3 { */ 'start-index'?: number; } - export interface Params$Resource$Management$Filters$Patch { + export interface Params$Resource$Management$Filters$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6001,7 +6065,8 @@ export namespace analytics_v3 { */ requestBody?: Schema$Filter; } - export interface Params$Resource$Management$Filters$Update { + export interface Params$Resource$Management$Filters$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6389,7 +6454,8 @@ export namespace analytics_v3 { } } - export interface Params$Resource$Management$Goals$Get { + export interface Params$Resource$Management$Goals$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6412,7 +6478,8 @@ export namespace analytics_v3 { */ webPropertyId?: string; } - export interface Params$Resource$Management$Goals$Insert { + export interface Params$Resource$Management$Goals$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6436,7 +6503,8 @@ export namespace analytics_v3 { */ requestBody?: Schema$Goal; } - export interface Params$Resource$Management$Goals$List { + export interface Params$Resource$Management$Goals$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6469,7 +6537,8 @@ export namespace analytics_v3 { */ webPropertyId?: string; } - export interface Params$Resource$Management$Goals$Patch { + export interface Params$Resource$Management$Goals$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6497,7 +6566,8 @@ export namespace analytics_v3 { */ requestBody?: Schema$Goal; } - export interface Params$Resource$Management$Goals$Update { + export interface Params$Resource$Management$Goals$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6969,7 +7039,8 @@ export namespace analytics_v3 { } } - export interface Params$Resource$Management$Profilefilterlinks$Delete { + export interface Params$Resource$Management$Profilefilterlinks$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6992,7 +7063,8 @@ export namespace analytics_v3 { */ webPropertyId?: string; } - export interface Params$Resource$Management$Profilefilterlinks$Get { + export interface Params$Resource$Management$Profilefilterlinks$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7015,7 +7087,8 @@ export namespace analytics_v3 { */ webPropertyId?: string; } - export interface Params$Resource$Management$Profilefilterlinks$Insert { + export interface Params$Resource$Management$Profilefilterlinks$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7039,7 +7112,8 @@ export namespace analytics_v3 { */ requestBody?: Schema$ProfileFilterLink; } - export interface Params$Resource$Management$Profilefilterlinks$List { + export interface Params$Resource$Management$Profilefilterlinks$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7070,7 +7144,8 @@ export namespace analytics_v3 { */ webPropertyId?: string; } - export interface Params$Resource$Management$Profilefilterlinks$Patch { + export interface Params$Resource$Management$Profilefilterlinks$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7098,7 +7173,8 @@ export namespace analytics_v3 { */ requestBody?: Schema$ProfileFilterLink; } - export interface Params$Resource$Management$Profilefilterlinks$Update { + export interface Params$Resource$Management$Profilefilterlinks$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7559,7 +7635,8 @@ export namespace analytics_v3 { } } - export interface Params$Resource$Management$Profiles$Delete { + export interface Params$Resource$Management$Profiles$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7578,7 +7655,8 @@ export namespace analytics_v3 { */ webPropertyId?: string; } - export interface Params$Resource$Management$Profiles$Get { + export interface Params$Resource$Management$Profiles$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7597,7 +7675,8 @@ export namespace analytics_v3 { */ webPropertyId?: string; } - export interface Params$Resource$Management$Profiles$Insert { + export interface Params$Resource$Management$Profiles$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7617,7 +7696,8 @@ export namespace analytics_v3 { */ requestBody?: Schema$Profile; } - export interface Params$Resource$Management$Profiles$List { + export interface Params$Resource$Management$Profiles$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7645,7 +7725,8 @@ export namespace analytics_v3 { */ webPropertyId?: string; } - export interface Params$Resource$Management$Profiles$Patch { + export interface Params$Resource$Management$Profiles$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7669,7 +7750,8 @@ export namespace analytics_v3 { */ requestBody?: Schema$Profile; } - export interface Params$Resource$Management$Profiles$Update { + export interface Params$Resource$Management$Profiles$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7996,7 +8078,8 @@ export namespace analytics_v3 { } } - export interface Params$Resource$Management$Profileuserlinks$Delete { + export interface Params$Resource$Management$Profileuserlinks$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8019,7 +8102,8 @@ export namespace analytics_v3 { */ webPropertyId?: string; } - export interface Params$Resource$Management$Profileuserlinks$Insert { + export interface Params$Resource$Management$Profileuserlinks$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8043,7 +8127,8 @@ export namespace analytics_v3 { */ requestBody?: Schema$EntityUserLink; } - export interface Params$Resource$Management$Profileuserlinks$List { + export interface Params$Resource$Management$Profileuserlinks$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8075,7 +8160,8 @@ export namespace analytics_v3 { */ webPropertyId?: string; } - export interface Params$Resource$Management$Profileuserlinks$Update { + export interface Params$Resource$Management$Profileuserlinks$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8546,7 +8632,8 @@ export namespace analytics_v3 { } } - export interface Params$Resource$Management$Remarketingaudience$Delete { + export interface Params$Resource$Management$Remarketingaudience$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8565,7 +8652,8 @@ export namespace analytics_v3 { */ webPropertyId?: string; } - export interface Params$Resource$Management$Remarketingaudience$Get { + export interface Params$Resource$Management$Remarketingaudience$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8584,7 +8672,8 @@ export namespace analytics_v3 { */ webPropertyId?: string; } - export interface Params$Resource$Management$Remarketingaudience$Insert { + export interface Params$Resource$Management$Remarketingaudience$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8604,7 +8693,8 @@ export namespace analytics_v3 { */ requestBody?: Schema$RemarketingAudience; } - export interface Params$Resource$Management$Remarketingaudience$List { + export interface Params$Resource$Management$Remarketingaudience$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8632,7 +8722,8 @@ export namespace analytics_v3 { */ webPropertyId?: string; } - export interface Params$Resource$Management$Remarketingaudience$Patch { + export interface Params$Resource$Management$Remarketingaudience$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8656,7 +8747,8 @@ export namespace analytics_v3 { */ requestBody?: Schema$RemarketingAudience; } - export interface Params$Resource$Management$Remarketingaudience$Update { + export interface Params$Resource$Management$Remarketingaudience$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8761,7 +8853,8 @@ export namespace analytics_v3 { } } - export interface Params$Resource$Management$Segments$List { + export interface Params$Resource$Management$Segments$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9078,7 +9171,8 @@ export namespace analytics_v3 { } } - export interface Params$Resource$Management$Unsampledreports$Delete { + export interface Params$Resource$Management$Unsampledreports$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9101,7 +9195,8 @@ export namespace analytics_v3 { */ webPropertyId?: string; } - export interface Params$Resource$Management$Unsampledreports$Get { + export interface Params$Resource$Management$Unsampledreports$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9124,7 +9219,8 @@ export namespace analytics_v3 { */ webPropertyId?: string; } - export interface Params$Resource$Management$Unsampledreports$Insert { + export interface Params$Resource$Management$Unsampledreports$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9148,7 +9244,8 @@ export namespace analytics_v3 { */ requestBody?: Schema$UnsampledReport; } - export interface Params$Resource$Management$Unsampledreports$List { + export interface Params$Resource$Management$Unsampledreports$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9481,7 +9578,8 @@ export namespace analytics_v3 { } } - export interface Params$Resource$Management$Uploads$Deleteuploaddata { + export interface Params$Resource$Management$Uploads$Deleteuploaddata extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9505,7 +9603,8 @@ export namespace analytics_v3 { */ requestBody?: Schema$AnalyticsDataimportDeleteUploadDataRequest; } - export interface Params$Resource$Management$Uploads$Get { + export interface Params$Resource$Management$Uploads$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9528,7 +9627,8 @@ export namespace analytics_v3 { */ webPropertyId?: string; } - export interface Params$Resource$Management$Uploads$List { + export interface Params$Resource$Management$Uploads$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9556,7 +9656,8 @@ export namespace analytics_v3 { */ webPropertyId?: string; } - export interface Params$Resource$Management$Uploads$Uploaddata { + export interface Params$Resource$Management$Uploads$Uploaddata extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9957,7 +10058,8 @@ export namespace analytics_v3 { } } - export interface Params$Resource$Management$Webproperties$Get { + export interface Params$Resource$Management$Webproperties$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9972,7 +10074,8 @@ export namespace analytics_v3 { */ webPropertyId?: string; } - export interface Params$Resource$Management$Webproperties$Insert { + export interface Params$Resource$Management$Webproperties$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9988,7 +10091,8 @@ export namespace analytics_v3 { */ requestBody?: Schema$Webproperty; } - export interface Params$Resource$Management$Webproperties$List { + export interface Params$Resource$Management$Webproperties$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10010,7 +10114,8 @@ export namespace analytics_v3 { */ 'start-index'?: number; } - export interface Params$Resource$Management$Webproperties$Patch { + export interface Params$Resource$Management$Webproperties$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10030,7 +10135,8 @@ export namespace analytics_v3 { */ requestBody?: Schema$Webproperty; } - export interface Params$Resource$Management$Webproperties$Update { + export interface Params$Resource$Management$Webproperties$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10501,7 +10607,8 @@ export namespace analytics_v3 { } } - export interface Params$Resource$Management$Webpropertyadwordslinks$Delete { + export interface Params$Resource$Management$Webpropertyadwordslinks$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -10520,7 +10627,8 @@ export namespace analytics_v3 { */ webPropertyId?: string; } - export interface Params$Resource$Management$Webpropertyadwordslinks$Get { + export interface Params$Resource$Management$Webpropertyadwordslinks$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -10539,7 +10647,8 @@ export namespace analytics_v3 { */ webPropertyId?: string; } - export interface Params$Resource$Management$Webpropertyadwordslinks$Insert { + export interface Params$Resource$Management$Webpropertyadwordslinks$Insert + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -10559,7 +10668,8 @@ export namespace analytics_v3 { */ requestBody?: Schema$EntityAdWordsLink; } - export interface Params$Resource$Management$Webpropertyadwordslinks$List { + export interface Params$Resource$Management$Webpropertyadwordslinks$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -10584,7 +10694,8 @@ export namespace analytics_v3 { */ webPropertyId?: string; } - export interface Params$Resource$Management$Webpropertyadwordslinks$Patch { + export interface Params$Resource$Management$Webpropertyadwordslinks$Patch + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -10608,7 +10719,8 @@ export namespace analytics_v3 { */ requestBody?: Schema$EntityAdWordsLink; } - export interface Params$Resource$Management$Webpropertyadwordslinks$Update { + export interface Params$Resource$Management$Webpropertyadwordslinks$Update + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -10933,7 +11045,8 @@ export namespace analytics_v3 { } } - export interface Params$Resource$Management$Webpropertyuserlinks$Delete { + export interface Params$Resource$Management$Webpropertyuserlinks$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -10952,7 +11065,8 @@ export namespace analytics_v3 { */ webPropertyId?: string; } - export interface Params$Resource$Management$Webpropertyuserlinks$Insert { + export interface Params$Resource$Management$Webpropertyuserlinks$Insert + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -10972,7 +11086,8 @@ export namespace analytics_v3 { */ requestBody?: Schema$EntityUserLink; } - export interface Params$Resource$Management$Webpropertyuserlinks$List { + export interface Params$Resource$Management$Webpropertyuserlinks$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10998,7 +11113,8 @@ export namespace analytics_v3 { */ webPropertyId?: string; } - export interface Params$Resource$Management$Webpropertyuserlinks$Update { + export interface Params$Resource$Management$Webpropertyuserlinks$Update + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11118,7 +11234,8 @@ export namespace analytics_v3 { } } - export interface Params$Resource$Metadata$Columns$List { + export interface Params$Resource$Metadata$Columns$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -11281,7 +11398,8 @@ export namespace analytics_v3 { } } - export interface Params$Resource$Provisioning$Createaccountticket { + export interface Params$Resource$Provisioning$Createaccountticket extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -11293,7 +11411,8 @@ export namespace analytics_v3 { */ requestBody?: Schema$AccountTicket; } - export interface Params$Resource$Provisioning$Createaccounttree { + export interface Params$Resource$Provisioning$Createaccounttree extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -11404,7 +11523,8 @@ export namespace analytics_v3 { } } - export interface Params$Resource$Userdeletion$Userdeletionrequest$Upsert { + export interface Params$Resource$Userdeletion$Userdeletionrequest$Upsert + extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/analyticsreporting/v4.ts b/src/apis/analyticsreporting/v4.ts index 70621293b4..80af5e046d 100644 --- a/src/apis/analyticsreporting/v4.ts +++ b/src/apis/analyticsreporting/v4.ts @@ -29,6 +29,57 @@ export namespace analyticsreporting_v4 { version: 'v4'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Analytics Reporting API * @@ -1029,7 +1080,7 @@ export namespace analyticsreporting_v4 { } } - export interface Params$Resource$Reports$Batchget { + export interface Params$Resource$Reports$Batchget extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/androiddeviceprovisioning/v1.ts b/src/apis/androiddeviceprovisioning/v1.ts index ddcea1a683..166a2ae656 100644 --- a/src/apis/androiddeviceprovisioning/v1.ts +++ b/src/apis/androiddeviceprovisioning/v1.ts @@ -29,6 +29,57 @@ export namespace androiddeviceprovisioning_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Android Device Provisioning Partner API * @@ -964,7 +1015,7 @@ export namespace androiddeviceprovisioning_v1 { } } - export interface Params$Resource$Customers$List { + export interface Params$Resource$Customers$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1341,7 +1392,8 @@ export namespace androiddeviceprovisioning_v1 { } } - export interface Params$Resource$Customers$Configurations$Create { + export interface Params$Resource$Customers$Configurations$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1358,7 +1410,8 @@ export namespace androiddeviceprovisioning_v1 { */ requestBody?: Schema$Configuration; } - export interface Params$Resource$Customers$Configurations$Delete { + export interface Params$Resource$Customers$Configurations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1371,7 +1424,8 @@ export namespace androiddeviceprovisioning_v1 { */ name?: string; } - export interface Params$Resource$Customers$Configurations$Get { + export interface Params$Resource$Customers$Configurations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1383,7 +1437,8 @@ export namespace androiddeviceprovisioning_v1 { */ name?: string; } - export interface Params$Resource$Customers$Configurations$List { + export interface Params$Resource$Customers$Configurations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1395,7 +1450,8 @@ export namespace androiddeviceprovisioning_v1 { */ parent?: string; } - export interface Params$Resource$Customers$Configurations$Patch { + export interface Params$Resource$Customers$Configurations$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1782,7 +1838,8 @@ export namespace androiddeviceprovisioning_v1 { } } - export interface Params$Resource$Customers$Devices$Applyconfiguration { + export interface Params$Resource$Customers$Devices$Applyconfiguration extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1799,7 +1856,8 @@ export namespace androiddeviceprovisioning_v1 { */ requestBody?: Schema$CustomerApplyConfigurationRequest; } - export interface Params$Resource$Customers$Devices$Get { + export interface Params$Resource$Customers$Devices$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1811,7 +1869,8 @@ export namespace androiddeviceprovisioning_v1 { */ name?: string; } - export interface Params$Resource$Customers$Devices$List { + export interface Params$Resource$Customers$Devices$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1832,7 +1891,8 @@ export namespace androiddeviceprovisioning_v1 { */ parent?: string; } - export interface Params$Resource$Customers$Devices$Removeconfiguration { + export interface Params$Resource$Customers$Devices$Removeconfiguration extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1849,7 +1909,8 @@ export namespace androiddeviceprovisioning_v1 { */ requestBody?: Schema$CustomerRemoveConfigurationRequest; } - export interface Params$Resource$Customers$Devices$Unclaim { + export interface Params$Resource$Customers$Devices$Unclaim extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1949,7 +2010,8 @@ export namespace androiddeviceprovisioning_v1 { } } - export interface Params$Resource$Customers$Dpcs$List { + export interface Params$Resource$Customers$Dpcs$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2040,7 +2102,7 @@ export namespace androiddeviceprovisioning_v1 { } } - export interface Params$Resource$Operations$Get { + export interface Params$Resource$Operations$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2089,7 +2151,8 @@ export namespace androiddeviceprovisioning_v1 { * @desc Creates a customer for zero-touch enrollment. After the method * returns successfully, admin and owner roles can manage devices and EMM * configs by calling API methods or using their zero-touch enrollment - * portal. The API doesn't notify the customer that they have access. + * portal. The customer receives an email that welcomes them to zero-touch + * enrollment and explains how to sign into the portal. * @alias androiddeviceprovisioning.partners.customers.create * @memberOf! () * @@ -2228,7 +2291,8 @@ export namespace androiddeviceprovisioning_v1 { } } - export interface Params$Resource$Partners$Customers$Create { + export interface Params$Resource$Partners$Customers$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2245,7 +2309,8 @@ export namespace androiddeviceprovisioning_v1 { */ requestBody?: Schema$CreateCustomerRequest; } - export interface Params$Resource$Partners$Customers$List { + export interface Params$Resource$Partners$Customers$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2929,7 +2994,8 @@ export namespace androiddeviceprovisioning_v1 { } } - export interface Params$Resource$Partners$Devices$Claim { + export interface Params$Resource$Partners$Devices$Claim extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2945,7 +3011,8 @@ export namespace androiddeviceprovisioning_v1 { */ requestBody?: Schema$ClaimDeviceRequest; } - export interface Params$Resource$Partners$Devices$Claimasync { + export interface Params$Resource$Partners$Devices$Claimasync extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2961,7 +3028,8 @@ export namespace androiddeviceprovisioning_v1 { */ requestBody?: Schema$ClaimDevicesRequest; } - export interface Params$Resource$Partners$Devices$Findbyidentifier { + export interface Params$Resource$Partners$Devices$Findbyidentifier extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2977,7 +3045,8 @@ export namespace androiddeviceprovisioning_v1 { */ requestBody?: Schema$FindDevicesByDeviceIdentifierRequest; } - export interface Params$Resource$Partners$Devices$Findbyowner { + export interface Params$Resource$Partners$Devices$Findbyowner extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2993,7 +3062,8 @@ export namespace androiddeviceprovisioning_v1 { */ requestBody?: Schema$FindDevicesByOwnerRequest; } - export interface Params$Resource$Partners$Devices$Get { + export interface Params$Resource$Partners$Devices$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3005,7 +3075,8 @@ export namespace androiddeviceprovisioning_v1 { */ name?: string; } - export interface Params$Resource$Partners$Devices$Metadata { + export interface Params$Resource$Partners$Devices$Metadata extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3026,7 +3097,8 @@ export namespace androiddeviceprovisioning_v1 { */ requestBody?: Schema$UpdateDeviceMetadataRequest; } - export interface Params$Resource$Partners$Devices$Unclaim { + export interface Params$Resource$Partners$Devices$Unclaim extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3042,7 +3114,8 @@ export namespace androiddeviceprovisioning_v1 { */ requestBody?: Schema$UnclaimDeviceRequest; } - export interface Params$Resource$Partners$Devices$Unclaimasync { + export interface Params$Resource$Partners$Devices$Unclaimasync extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3058,7 +3131,8 @@ export namespace androiddeviceprovisioning_v1 { */ requestBody?: Schema$UnclaimDevicesRequest; } - export interface Params$Resource$Partners$Devices$Updatemetadataasync { + export interface Params$Resource$Partners$Devices$Updatemetadataasync extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3160,7 +3234,8 @@ export namespace androiddeviceprovisioning_v1 { } } - export interface Params$Resource$Partners$Vendors$List { + export interface Params$Resource$Partners$Vendors$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3268,7 +3343,8 @@ export namespace androiddeviceprovisioning_v1 { } } - export interface Params$Resource$Partners$Vendors$Customers$List { + export interface Params$Resource$Partners$Vendors$Customers$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/androidenterprise/v1.ts b/src/apis/androidenterprise/v1.ts index 15bc629745..7841d9b691 100644 --- a/src/apis/androidenterprise/v1.ts +++ b/src/apis/androidenterprise/v1.ts @@ -29,6 +29,40 @@ export namespace androidenterprise_v1 { version: 'v1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Google Play EMM API * @@ -140,7 +174,7 @@ export namespace androidenterprise_v1 { */ permission?: string[]; /** - * Options for displaying the Play Search page. + * Options for displaying the managed Play Search apps page. */ playSearch?: Schema$AdministratorWebTokenSpecPlaySearch; /** @@ -148,7 +182,7 @@ export namespace androidenterprise_v1 { */ privateApps?: Schema$AdministratorWebTokenSpecPrivateApps; /** - * Options for displaying the Store Builder page. + * Options for displaying the Organize apps page. */ storeBuilder?: Schema$AdministratorWebTokenSpecStoreBuilder; /** @@ -162,7 +196,7 @@ export namespace androidenterprise_v1 { */ approveApps?: boolean; /** - * Whether the Play Search page is displayed. Default is true. + * Whether the managed Play Search apps page is displayed. Default is true. */ enabled?: boolean; } @@ -174,7 +208,7 @@ export namespace androidenterprise_v1 { } export interface Schema$AdministratorWebTokenSpecStoreBuilder { /** - * Whether the Store Builder page is displayed. Default is true. + * Whether the Organize apps page is displayed. Default is true. */ enabled?: boolean; } @@ -333,10 +367,19 @@ export namespace androidenterprise_v1 { */ export interface Schema$AppVersion { /** - * The track that this app was published in. For example if track is - * "alpha", this is an alpha version of the app. + * True if this version is a production APK. + */ + isProduction?: boolean; + /** + * Deprecated, use trackId instead. */ track?: string; + /** + * Track ids that the app version is published in. Replaces the track field + * (deprecated), but doesn't include the production track (see + * isProduction instead). + */ + trackId?: string[]; /** * Unique increasing identifier for the app version. */ @@ -1142,6 +1185,10 @@ export namespace androidenterprise_v1 { * user interface. */ export interface Schema$Product { + /** + * The tracks visible to the enterprise. + */ + appTracks?: Schema$TrackInfo[]; /** * App versions currently available for this product. */ @@ -1155,7 +1202,7 @@ export namespace androidenterprise_v1 { */ availableCountries?: string[]; /** - * The tracks that are visible to the enterprise. + * Deprecated, use appTracks instead. */ availableTracks?: string[]; /** @@ -1325,21 +1372,13 @@ export namespace androidenterprise_v1 { */ productId?: string; /** - * Grants visibility to the specified track(s) of the product to the device. - * 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. + * Grants the device visibility to the specified product release track(s), + * identified by trackIds. The list of release tracks of a product can be + * obtained by calling Products.Get. + */ + trackIds?: string[]; + /** + * Deprecated. Use trackIds instead. */ tracks?: string[]; } @@ -1461,22 +1500,12 @@ export namespace androidenterprise_v1 { */ productId?: string; /** - * Grants visibility to the specified track(s) of the product to the user. - * 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 - * 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. + * Grants the user visibility to the specified product track(s), identified + * by trackIds. + */ + trackIds?: string[]; + /** + * Deprecated. Use trackIds instead. */ tracks?: string[]; } @@ -1681,6 +1710,22 @@ export namespace androidenterprise_v1 { nextPageToken?: string; previousPageToken?: string; } + /** + * Id to name association of a track. + */ + export interface Schema$TrackInfo { + /** + * A modifiable name for a track. This is the visible name in the play + * developer console. + */ + trackAlias?: string; + /** + * Unmodifiable, unique track identifier. This identifier is the + * releaseTrackId in the url of the play developer console page that + * displays the track information. + */ + trackId?: string; + } /** * A Users resource represents an account associated with an enterprise. The * account may be specific to a device or to an individual user (who can then @@ -2231,7 +2276,7 @@ export namespace androidenterprise_v1 { } } - export interface Params$Resource$Devices$Get { + export interface Params$Resource$Devices$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2250,7 +2295,7 @@ export namespace androidenterprise_v1 { */ userId?: string; } - export interface Params$Resource$Devices$Getstate { + export interface Params$Resource$Devices$Getstate extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2269,7 +2314,7 @@ export namespace androidenterprise_v1 { */ userId?: string; } - export interface Params$Resource$Devices$List { + export interface Params$Resource$Devices$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2284,7 +2329,7 @@ export namespace androidenterprise_v1 { */ userId?: string; } - export interface Params$Resource$Devices$Patch { + export interface Params$Resource$Devices$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2314,7 +2359,7 @@ export namespace androidenterprise_v1 { */ requestBody?: Schema$Device; } - export interface Params$Resource$Devices$Setstate { + export interface Params$Resource$Devices$Setstate extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2338,7 +2383,7 @@ export namespace androidenterprise_v1 { */ requestBody?: Schema$DeviceState; } - export interface Params$Resource$Devices$Update { + export interface Params$Resource$Devices$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3542,7 +3587,8 @@ export namespace androidenterprise_v1 { } } - export interface Params$Resource$Enterprises$Acknowledgenotificationset { + export interface Params$Resource$Enterprises$Acknowledgenotificationset + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3554,7 +3600,8 @@ export namespace androidenterprise_v1 { */ notificationSetId?: string; } - export interface Params$Resource$Enterprises$Completesignup { + export interface Params$Resource$Enterprises$Completesignup extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3569,7 +3616,8 @@ export namespace androidenterprise_v1 { */ enterpriseToken?: string; } - export interface Params$Resource$Enterprises$Createwebtoken { + export interface Params$Resource$Enterprises$Createwebtoken extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3585,7 +3633,8 @@ export namespace androidenterprise_v1 { */ requestBody?: Schema$AdministratorWebTokenSpec; } - export interface Params$Resource$Enterprises$Enroll { + export interface Params$Resource$Enterprises$Enroll extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3601,7 +3650,8 @@ export namespace androidenterprise_v1 { */ requestBody?: Schema$Enterprise; } - export interface Params$Resource$Enterprises$Generatesignupurl { + export interface Params$Resource$Enterprises$Generatesignupurl extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3618,7 +3668,7 @@ export namespace androidenterprise_v1 { */ callbackUrl?: string; } - export interface Params$Resource$Enterprises$Get { + export interface Params$Resource$Enterprises$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3629,7 +3679,8 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; } - export interface Params$Resource$Enterprises$Getandroiddevicepolicyconfig { + export interface Params$Resource$Enterprises$Getandroiddevicepolicyconfig + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3640,7 +3691,8 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; } - export interface Params$Resource$Enterprises$Getserviceaccount { + export interface Params$Resource$Enterprises$Getserviceaccount extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3655,7 +3707,8 @@ export namespace androidenterprise_v1 { */ keyType?: string; } - export interface Params$Resource$Enterprises$Getstorelayout { + export interface Params$Resource$Enterprises$Getstorelayout extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3666,7 +3719,7 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; } - export interface Params$Resource$Enterprises$List { + export interface Params$Resource$Enterprises$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3677,7 +3730,8 @@ export namespace androidenterprise_v1 { */ domain?: string; } - export interface Params$Resource$Enterprises$Pullnotificationset { + export interface Params$Resource$Enterprises$Pullnotificationset extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3694,7 +3748,8 @@ export namespace androidenterprise_v1 { */ requestMode?: string; } - export interface Params$Resource$Enterprises$Sendtestpushnotification { + export interface Params$Resource$Enterprises$Sendtestpushnotification extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3705,7 +3760,8 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; } - export interface Params$Resource$Enterprises$Setaccount { + export interface Params$Resource$Enterprises$Setaccount extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3721,7 +3777,8 @@ export namespace androidenterprise_v1 { */ requestBody?: Schema$EnterpriseAccount; } - export interface Params$Resource$Enterprises$Setandroiddevicepolicyconfig { + export interface Params$Resource$Enterprises$Setandroiddevicepolicyconfig + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3737,7 +3794,8 @@ export namespace androidenterprise_v1 { */ requestBody?: Schema$AndroidDevicePolicyConfig; } - export interface Params$Resource$Enterprises$Setstorelayout { + export interface Params$Resource$Enterprises$Setstorelayout extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3753,7 +3811,8 @@ export namespace androidenterprise_v1 { */ requestBody?: Schema$StoreLayout; } - export interface Params$Resource$Enterprises$Unenroll { + export interface Params$Resource$Enterprises$Unenroll extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4129,7 +4188,8 @@ export namespace androidenterprise_v1 { } } - export interface Params$Resource$Entitlements$Delete { + export interface Params$Resource$Entitlements$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4149,7 +4209,7 @@ export namespace androidenterprise_v1 { */ userId?: string; } - export interface Params$Resource$Entitlements$Get { + export interface Params$Resource$Entitlements$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4169,7 +4229,8 @@ export namespace androidenterprise_v1 { */ userId?: string; } - export interface Params$Resource$Entitlements$List { + export interface Params$Resource$Entitlements$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4184,7 +4245,8 @@ export namespace androidenterprise_v1 { */ userId?: string; } - export interface Params$Resource$Entitlements$Patch { + export interface Params$Resource$Entitlements$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4216,7 +4278,8 @@ export namespace androidenterprise_v1 { */ requestBody?: Schema$Entitlement; } - export interface Params$Resource$Entitlements$Update { + export interface Params$Resource$Entitlements$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4400,7 +4463,8 @@ export namespace androidenterprise_v1 { } } - export interface Params$Resource$Grouplicenses$Get { + export interface Params$Resource$Grouplicenses$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4416,7 +4480,8 @@ export namespace androidenterprise_v1 { */ groupLicenseId?: string; } - export interface Params$Resource$Grouplicenses$List { + export interface Params$Resource$Grouplicenses$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4519,7 +4584,8 @@ export namespace androidenterprise_v1 { } } - export interface Params$Resource$Grouplicenseusers$List { + export interface Params$Resource$Grouplicenseusers$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4900,7 +4966,7 @@ export namespace androidenterprise_v1 { } } - export interface Params$Resource$Installs$Delete { + export interface Params$Resource$Installs$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4924,7 +4990,7 @@ export namespace androidenterprise_v1 { */ userId?: string; } - export interface Params$Resource$Installs$Get { + export interface Params$Resource$Installs$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4948,7 +5014,7 @@ export namespace androidenterprise_v1 { */ userId?: string; } - export interface Params$Resource$Installs$List { + export interface Params$Resource$Installs$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4967,7 +5033,7 @@ export namespace androidenterprise_v1 { */ userId?: string; } - export interface Params$Resource$Installs$Patch { + export interface Params$Resource$Installs$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4996,7 +5062,7 @@ export namespace androidenterprise_v1 { */ requestBody?: Schema$Install; } - export interface Params$Resource$Installs$Update { + export interface Params$Resource$Installs$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5435,7 +5501,8 @@ export namespace androidenterprise_v1 { } } - export interface Params$Resource$Managedconfigurationsfordevice$Delete { + export interface Params$Resource$Managedconfigurationsfordevice$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5459,7 +5526,8 @@ export namespace androidenterprise_v1 { */ userId?: string; } - export interface Params$Resource$Managedconfigurationsfordevice$Get { + export interface Params$Resource$Managedconfigurationsfordevice$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5483,7 +5551,8 @@ export namespace androidenterprise_v1 { */ userId?: string; } - export interface Params$Resource$Managedconfigurationsfordevice$List { + export interface Params$Resource$Managedconfigurationsfordevice$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5502,7 +5571,8 @@ export namespace androidenterprise_v1 { */ userId?: string; } - export interface Params$Resource$Managedconfigurationsfordevice$Patch { + export interface Params$Resource$Managedconfigurationsfordevice$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5531,7 +5601,8 @@ export namespace androidenterprise_v1 { */ requestBody?: Schema$ManagedConfiguration; } - export interface Params$Resource$Managedconfigurationsfordevice$Update { + export interface Params$Resource$Managedconfigurationsfordevice$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5952,7 +6023,8 @@ export namespace androidenterprise_v1 { } } - export interface Params$Resource$Managedconfigurationsforuser$Delete { + export interface Params$Resource$Managedconfigurationsforuser$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5972,7 +6044,8 @@ export namespace androidenterprise_v1 { */ userId?: string; } - export interface Params$Resource$Managedconfigurationsforuser$Get { + export interface Params$Resource$Managedconfigurationsforuser$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5992,7 +6065,8 @@ export namespace androidenterprise_v1 { */ userId?: string; } - export interface Params$Resource$Managedconfigurationsforuser$List { + export interface Params$Resource$Managedconfigurationsforuser$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6007,7 +6081,8 @@ export namespace androidenterprise_v1 { */ userId?: string; } - export interface Params$Resource$Managedconfigurationsforuser$Patch { + export interface Params$Resource$Managedconfigurationsforuser$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6032,7 +6107,8 @@ export namespace androidenterprise_v1 { */ requestBody?: Schema$ManagedConfiguration; } - export interface Params$Resource$Managedconfigurationsforuser$Update { + export interface Params$Resource$Managedconfigurationsforuser$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6150,7 +6226,8 @@ export namespace androidenterprise_v1 { } } - export interface Params$Resource$Managedconfigurationssettings$List { + export interface Params$Resource$Managedconfigurationssettings$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6245,7 +6322,7 @@ export namespace androidenterprise_v1 { } } - export interface Params$Resource$Permissions$Get { + export interface Params$Resource$Permissions$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6791,7 +6868,7 @@ export namespace androidenterprise_v1 { } } - export interface Params$Resource$Products$Approve { + export interface Params$Resource$Products$Approve extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6811,7 +6888,8 @@ export namespace androidenterprise_v1 { */ requestBody?: Schema$ProductsApproveRequest; } - export interface Params$Resource$Products$Generateapprovalurl { + export interface Params$Resource$Products$Generateapprovalurl extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6831,7 +6909,7 @@ export namespace androidenterprise_v1 { */ productId?: string; } - export interface Params$Resource$Products$Get { + export interface Params$Resource$Products$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6850,7 +6928,8 @@ export namespace androidenterprise_v1 { */ productId?: string; } - export interface Params$Resource$Products$Getapprestrictionsschema { + export interface Params$Resource$Products$Getapprestrictionsschema extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6869,7 +6948,8 @@ export namespace androidenterprise_v1 { */ productId?: string; } - export interface Params$Resource$Products$Getpermissions { + export interface Params$Resource$Products$Getpermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6884,7 +6964,7 @@ export namespace androidenterprise_v1 { */ productId?: string; } - export interface Params$Resource$Products$List { + export interface Params$Resource$Products$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6927,7 +7007,8 @@ export namespace androidenterprise_v1 { */ token?: string; } - export interface Params$Resource$Products$Unapprove { + export interface Params$Resource$Products$Unapprove extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7182,7 +7263,8 @@ export namespace androidenterprise_v1 { } } - export interface Params$Resource$Serviceaccountkeys$Delete { + export interface Params$Resource$Serviceaccountkeys$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7197,7 +7279,8 @@ export namespace androidenterprise_v1 { */ keyId?: string; } - export interface Params$Resource$Serviceaccountkeys$Insert { + export interface Params$Resource$Serviceaccountkeys$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7213,7 +7296,8 @@ export namespace androidenterprise_v1 { */ requestBody?: Schema$ServiceAccountKey; } - export interface Params$Resource$Serviceaccountkeys$List { + export interface Params$Resource$Serviceaccountkeys$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7668,7 +7752,8 @@ export namespace androidenterprise_v1 { } } - export interface Params$Resource$Storelayoutclusters$Delete { + export interface Params$Resource$Storelayoutclusters$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7687,7 +7772,8 @@ export namespace androidenterprise_v1 { */ pageId?: string; } - export interface Params$Resource$Storelayoutclusters$Get { + export interface Params$Resource$Storelayoutclusters$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7706,7 +7792,8 @@ export namespace androidenterprise_v1 { */ pageId?: string; } - export interface Params$Resource$Storelayoutclusters$Insert { + export interface Params$Resource$Storelayoutclusters$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7726,7 +7813,8 @@ export namespace androidenterprise_v1 { */ requestBody?: Schema$StoreCluster; } - export interface Params$Resource$Storelayoutclusters$List { + export interface Params$Resource$Storelayoutclusters$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7741,7 +7829,8 @@ export namespace androidenterprise_v1 { */ pageId?: string; } - export interface Params$Resource$Storelayoutclusters$Patch { + export interface Params$Resource$Storelayoutclusters$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7765,7 +7854,8 @@ export namespace androidenterprise_v1 { */ requestBody?: Schema$StoreCluster; } - export interface Params$Resource$Storelayoutclusters$Update { + export interface Params$Resource$Storelayoutclusters$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8226,7 +8316,8 @@ export namespace androidenterprise_v1 { } } - export interface Params$Resource$Storelayoutpages$Delete { + export interface Params$Resource$Storelayoutpages$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8241,7 +8332,8 @@ export namespace androidenterprise_v1 { */ pageId?: string; } - export interface Params$Resource$Storelayoutpages$Get { + export interface Params$Resource$Storelayoutpages$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8256,7 +8348,8 @@ export namespace androidenterprise_v1 { */ pageId?: string; } - export interface Params$Resource$Storelayoutpages$Insert { + export interface Params$Resource$Storelayoutpages$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8272,7 +8365,8 @@ export namespace androidenterprise_v1 { */ requestBody?: Schema$StorePage; } - export interface Params$Resource$Storelayoutpages$List { + export interface Params$Resource$Storelayoutpages$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8283,7 +8377,8 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; } - export interface Params$Resource$Storelayoutpages$Patch { + export interface Params$Resource$Storelayoutpages$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8303,7 +8398,8 @@ export namespace androidenterprise_v1 { */ requestBody?: Schema$StorePage; } - export interface Params$Resource$Storelayoutpages$Update { + export interface Params$Resource$Storelayoutpages$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9182,7 +9278,7 @@ export namespace androidenterprise_v1 { } } - export interface Params$Resource$Users$Delete { + export interface Params$Resource$Users$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9197,7 +9293,8 @@ export namespace androidenterprise_v1 { */ userId?: string; } - export interface Params$Resource$Users$Generateauthenticationtoken { + export interface Params$Resource$Users$Generateauthenticationtoken extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9212,7 +9309,8 @@ export namespace androidenterprise_v1 { */ userId?: string; } - export interface Params$Resource$Users$Generatetoken { + export interface Params$Resource$Users$Generatetoken extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9227,7 +9325,7 @@ export namespace androidenterprise_v1 { */ userId?: string; } - export interface Params$Resource$Users$Get { + export interface Params$Resource$Users$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9242,7 +9340,8 @@ export namespace androidenterprise_v1 { */ userId?: string; } - export interface Params$Resource$Users$Getavailableproductset { + export interface Params$Resource$Users$Getavailableproductset extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9257,7 +9356,7 @@ export namespace androidenterprise_v1 { */ userId?: string; } - export interface Params$Resource$Users$Insert { + export interface Params$Resource$Users$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9273,7 +9372,7 @@ export namespace androidenterprise_v1 { */ requestBody?: Schema$User; } - export interface Params$Resource$Users$List { + export interface Params$Resource$Users$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9288,7 +9387,7 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; } - export interface Params$Resource$Users$Patch { + export interface Params$Resource$Users$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9308,7 +9407,8 @@ export namespace androidenterprise_v1 { */ requestBody?: Schema$User; } - export interface Params$Resource$Users$Revokedeviceaccess { + export interface Params$Resource$Users$Revokedeviceaccess extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9323,7 +9423,8 @@ export namespace androidenterprise_v1 { */ userId?: string; } - export interface Params$Resource$Users$Revoketoken { + export interface Params$Resource$Users$Revoketoken extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9338,7 +9439,8 @@ export namespace androidenterprise_v1 { */ userId?: string; } - export interface Params$Resource$Users$Setavailableproductset { + export interface Params$Resource$Users$Setavailableproductset extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9358,7 +9460,7 @@ export namespace androidenterprise_v1 { */ requestBody?: Schema$ProductSet; } - export interface Params$Resource$Users$Update { + export interface Params$Resource$Users$Update extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/androidmanagement/v1.ts b/src/apis/androidmanagement/v1.ts index c93b64e32f..6c6de80868 100644 --- a/src/apis/androidmanagement/v1.ts +++ b/src/apis/androidmanagement/v1.ts @@ -29,6 +29,57 @@ export namespace androidmanagement_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Android Management API * @@ -194,6 +245,12 @@ export namespace androidmanagement_v1 { * objects</td></tr> </table> */ managedConfiguration?: any; + /** + * The managed configurations template for the app, saved from the managed + * configurations iframe. This field is ignored if managed_configuration is + * set. + */ + managedConfigurationTemplate?: Schema$ManagedConfigurationTemplate; /** * The minimum version of the app that runs on the device. If set, the * device attempts to update the app to at least this version code. If the @@ -701,6 +758,11 @@ export namespace androidmanagement_v1 { * notifications are enabled. */ pubsubTopic?: string; + /** + * Sign-in details of the enterprise. Maximum of 1 SigninDetail is + * supported. + */ + signinDetails?: Schema$SigninDetail[]; /** * Terms and conditions that must be accepted when provisioning a device for * this enterprise. A page of terms is generated for each value in this @@ -873,6 +935,21 @@ export namespace androidmanagement_v1 { */ policies?: Schema$Policy[]; } + /** + * The managed configurations template for the app, saved from the managed + * configurations iframe. + */ + export interface Schema$ManagedConfigurationTemplate { + /** + * Optional, a map containing <key, value> configuration variables + * defined for the configuration. + */ + configurationVariables?: any; + /** + * The ID of the managed configurations template. + */ + templateId?: string; + } /** * Managed property. */ @@ -1150,6 +1227,10 @@ export namespace androidmanagement_v1 { * The required password quality. */ passwordQuality?: string; + /** + * The scope that the password requirement applies to. + */ + passwordScope?: string; } /** * Configuration for an Android permission and its grant state. @@ -1412,7 +1493,13 @@ export namespace androidmanagement_v1 { */ outgoingCallsDisabled?: boolean; /** - * Password requirements. + * Password requirement policies. Different policies can be set for work + * profile or fully managed devices by setting the password_scope field in + * the policy. + */ + passwordPolicies?: Schema$PasswordRequirements[]; + /** + * Password requirements. DEPRECATED - Use password_policies */ passwordRequirements?: Schema$PasswordRequirements; /** @@ -1591,6 +1678,33 @@ export namespace androidmanagement_v1 { */ port?: number; } + /** + * A resource containing sign in details for an enterprise. + */ + export interface Schema$SigninDetail { + /** + * A JSON string whose UTF-8 representation can be used to generate a QR + * code to enroll a device with this enrollment token. To enroll a device + * using NFC, the NFC record must contain a serialized java.util.Properties + * representation of the properties in the JSON. This is a read-only field + * generated by the server. + */ + qrCode?: string; + /** + * An enterprise wide enrollment token used to trigger custom sign-in flow. + * This is a read-only field generated by the server. + */ + signinEnrollmentToken?: string; + /** + * Sign-in URL for authentication when device is provisioned with a sign-in + * enrollment token. The sign-in endpoint should finish authentication flow + * with a URL in the form of + * https://enterprise.google.com/android/enroll?et=<token> for a + * successful login, or https://enterprise.google.com/android/enroll/invalid + * for a failed login. + */ + signinUrl?: string; + } /** * An enterprise signup URL. */ @@ -2065,7 +2179,8 @@ export namespace androidmanagement_v1 { } } - export interface Params$Resource$Enterprises$Create { + export interface Params$Resource$Enterprises$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2090,7 +2205,7 @@ export namespace androidmanagement_v1 { */ requestBody?: Schema$Enterprise; } - export interface Params$Resource$Enterprises$Get { + export interface Params$Resource$Enterprises$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2101,7 +2216,8 @@ export namespace androidmanagement_v1 { */ name?: string; } - export interface Params$Resource$Enterprises$Patch { + export interface Params$Resource$Enterprises$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2199,7 +2315,8 @@ export namespace androidmanagement_v1 { } } - export interface Params$Resource$Enterprises$Applications$Get { + export interface Params$Resource$Enterprises$Applications$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2571,7 +2688,8 @@ export namespace androidmanagement_v1 { } } - export interface Params$Resource$Enterprises$Devices$Delete { + export interface Params$Resource$Enterprises$Devices$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2587,7 +2705,8 @@ export namespace androidmanagement_v1 { */ wipeDataFlags?: string; } - export interface Params$Resource$Enterprises$Devices$Get { + export interface Params$Resource$Enterprises$Devices$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2599,7 +2718,8 @@ export namespace androidmanagement_v1 { */ name?: string; } - export interface Params$Resource$Enterprises$Devices$Issuecommand { + export interface Params$Resource$Enterprises$Devices$Issuecommand extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2616,7 +2736,8 @@ export namespace androidmanagement_v1 { */ requestBody?: Schema$Command; } - export interface Params$Resource$Enterprises$Devices$List { + export interface Params$Resource$Enterprises$Devices$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2636,7 +2757,8 @@ export namespace androidmanagement_v1 { */ parent?: string; } - export interface Params$Resource$Enterprises$Devices$Patch { + export interface Params$Resource$Enterprises$Devices$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2961,7 +3083,8 @@ export namespace androidmanagement_v1 { } } - export interface Params$Resource$Enterprises$Devices$Operations$Cancel { + export interface Params$Resource$Enterprises$Devices$Operations$Cancel extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2972,7 +3095,8 @@ export namespace androidmanagement_v1 { */ name?: string; } - export interface Params$Resource$Enterprises$Devices$Operations$Delete { + export interface Params$Resource$Enterprises$Devices$Operations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2983,7 +3107,8 @@ export namespace androidmanagement_v1 { */ name?: string; } - export interface Params$Resource$Enterprises$Devices$Operations$Get { + export interface Params$Resource$Enterprises$Devices$Operations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2994,7 +3119,8 @@ export namespace androidmanagement_v1 { */ name?: string; } - export interface Params$Resource$Enterprises$Devices$Operations$List { + export interface Params$Resource$Enterprises$Devices$Operations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3168,7 +3294,8 @@ export namespace androidmanagement_v1 { } } - export interface Params$Resource$Enterprises$Enrollmenttokens$Create { + export interface Params$Resource$Enterprises$Enrollmenttokens$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3184,7 +3311,8 @@ export namespace androidmanagement_v1 { */ requestBody?: Schema$EnrollmentToken; } - export interface Params$Resource$Enterprises$Enrollmenttokens$Delete { + export interface Params$Resource$Enterprises$Enrollmenttokens$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3478,7 +3606,8 @@ export namespace androidmanagement_v1 { } } - export interface Params$Resource$Enterprises$Policies$Delete { + export interface Params$Resource$Enterprises$Policies$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3490,7 +3619,8 @@ export namespace androidmanagement_v1 { */ name?: string; } - export interface Params$Resource$Enterprises$Policies$Get { + export interface Params$Resource$Enterprises$Policies$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3502,7 +3632,8 @@ export namespace androidmanagement_v1 { */ name?: string; } - export interface Params$Resource$Enterprises$Policies$List { + export interface Params$Resource$Enterprises$Policies$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3522,7 +3653,8 @@ export namespace androidmanagement_v1 { */ parent?: string; } - export interface Params$Resource$Enterprises$Policies$Patch { + export interface Params$Resource$Enterprises$Policies$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3627,7 +3759,8 @@ export namespace androidmanagement_v1 { } } - export interface Params$Resource$Enterprises$Webtokens$Create { + export interface Params$Resource$Enterprises$Webtokens$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3725,7 +3858,8 @@ export namespace androidmanagement_v1 { } } - export interface Params$Resource$Signupurls$Create { + export interface Params$Resource$Signupurls$Create extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/androidpublisher/v1.1.ts b/src/apis/androidpublisher/v1.1.ts index 6866a7220c..33eaf01a11 100644 --- a/src/apis/androidpublisher/v1.1.ts +++ b/src/apis/androidpublisher/v1.1.ts @@ -29,6 +29,40 @@ export namespace androidpublisher_v1_1 { version: 'v1_1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Google Play Developer API * @@ -215,7 +249,8 @@ export namespace androidpublisher_v1_1 { } } - export interface Params$Resource$Inapppurchases$Get { + export interface Params$Resource$Inapppurchases$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -386,7 +421,7 @@ export namespace androidpublisher_v1_1 { } } - export interface Params$Resource$Purchases$Cancel { + export interface Params$Resource$Purchases$Cancel extends StandardParameters { /** * Auth client or API Key for the request */ @@ -407,7 +442,7 @@ export namespace androidpublisher_v1_1 { */ token?: string; } - export interface Params$Resource$Purchases$Get { + export interface Params$Resource$Purchases$Get extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/androidpublisher/v1.ts b/src/apis/androidpublisher/v1.ts index 1a382863de..b0d8c81ba2 100644 --- a/src/apis/androidpublisher/v1.ts +++ b/src/apis/androidpublisher/v1.ts @@ -29,6 +29,40 @@ export namespace androidpublisher_v1 { version: 'v1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Google Play Developer API * @@ -240,7 +274,7 @@ export namespace androidpublisher_v1 { } } - export interface Params$Resource$Purchases$Cancel { + export interface Params$Resource$Purchases$Cancel extends StandardParameters { /** * Auth client or API Key for the request */ @@ -261,7 +295,7 @@ export namespace androidpublisher_v1 { */ token?: string; } - export interface Params$Resource$Purchases$Get { + export interface Params$Resource$Purchases$Get extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/androidpublisher/v2.ts b/src/apis/androidpublisher/v2.ts index 04464ef5cf..7b9332be90 100644 --- a/src/apis/androidpublisher/v2.ts +++ b/src/apis/androidpublisher/v2.ts @@ -29,6 +29,40 @@ export namespace androidpublisher_v2 { version: 'v2'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Google Play Developer API * @@ -1330,7 +1364,7 @@ export namespace androidpublisher_v2 { } } - export interface Params$Resource$Edits$Commit { + export interface Params$Resource$Edits$Commit extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1346,7 +1380,7 @@ export namespace androidpublisher_v2 { */ packageName?: string; } - export interface Params$Resource$Edits$Delete { + export interface Params$Resource$Edits$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1362,7 +1396,7 @@ export namespace androidpublisher_v2 { */ packageName?: string; } - export interface Params$Resource$Edits$Get { + export interface Params$Resource$Edits$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1378,7 +1412,7 @@ export namespace androidpublisher_v2 { */ packageName?: string; } - export interface Params$Resource$Edits$Insert { + export interface Params$Resource$Edits$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1395,7 +1429,7 @@ export namespace androidpublisher_v2 { */ requestBody?: Schema$AppEdit; } - export interface Params$Resource$Edits$Validate { + export interface Params$Resource$Edits$Validate extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1854,7 +1888,8 @@ export namespace androidpublisher_v2 { } } - export interface Params$Resource$Edits$Apklistings$Delete { + export interface Params$Resource$Edits$Apklistings$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1881,7 +1916,8 @@ export namespace androidpublisher_v2 { */ packageName?: string; } - export interface Params$Resource$Edits$Apklistings$Deleteall { + export interface Params$Resource$Edits$Apklistings$Deleteall extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1902,7 +1938,8 @@ export namespace androidpublisher_v2 { */ packageName?: string; } - export interface Params$Resource$Edits$Apklistings$Get { + export interface Params$Resource$Edits$Apklistings$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1929,7 +1966,8 @@ export namespace androidpublisher_v2 { */ packageName?: string; } - export interface Params$Resource$Edits$Apklistings$List { + export interface Params$Resource$Edits$Apklistings$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1950,7 +1988,8 @@ export namespace androidpublisher_v2 { */ packageName?: string; } - export interface Params$Resource$Edits$Apklistings$Patch { + export interface Params$Resource$Edits$Apklistings$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1982,7 +2021,8 @@ export namespace androidpublisher_v2 { */ requestBody?: Schema$ApkListing; } - export interface Params$Resource$Edits$Apklistings$Update { + export interface Params$Resource$Edits$Apklistings$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2252,7 +2292,8 @@ export namespace androidpublisher_v2 { } } - export interface Params$Resource$Edits$Apks$Addexternallyhosted { + export interface Params$Resource$Edits$Apks$Addexternallyhosted extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2273,7 +2314,7 @@ export namespace androidpublisher_v2 { */ requestBody?: Schema$ApksAddExternallyHostedRequest; } - export interface Params$Resource$Edits$Apks$List { + export interface Params$Resource$Edits$Apks$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2289,7 +2330,8 @@ export namespace androidpublisher_v2 { */ packageName?: string; } - export interface Params$Resource$Edits$Apks$Upload { + export interface Params$Resource$Edits$Apks$Upload extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2485,7 +2527,8 @@ export namespace androidpublisher_v2 { } } - export interface Params$Resource$Edits$Bundles$List { + export interface Params$Resource$Edits$Bundles$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2501,7 +2544,8 @@ export namespace androidpublisher_v2 { */ packageName?: string; } - export interface Params$Resource$Edits$Bundles$Upload { + export interface Params$Resource$Edits$Bundles$Upload extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2648,7 +2692,8 @@ export namespace androidpublisher_v2 { } } - export interface Params$Resource$Edits$Deobfuscationfiles$Upload { + export interface Params$Resource$Edits$Deobfuscationfiles$Upload extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2912,7 +2957,8 @@ export namespace androidpublisher_v2 { } } - export interface Params$Resource$Edits$Details$Get { + export interface Params$Resource$Edits$Details$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2928,7 +2974,8 @@ export namespace androidpublisher_v2 { */ packageName?: string; } - export interface Params$Resource$Edits$Details$Patch { + export interface Params$Resource$Edits$Details$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2949,7 +2996,8 @@ export namespace androidpublisher_v2 { */ requestBody?: Schema$AppDetails; } - export interface Params$Resource$Edits$Details$Update { + export interface Params$Resource$Edits$Details$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3295,7 +3343,8 @@ export namespace androidpublisher_v2 { } } - export interface Params$Resource$Edits$Expansionfiles$Get { + export interface Params$Resource$Edits$Expansionfiles$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3320,7 +3369,8 @@ export namespace androidpublisher_v2 { */ packageName?: string; } - export interface Params$Resource$Edits$Expansionfiles$Patch { + export interface Params$Resource$Edits$Expansionfiles$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3350,7 +3400,8 @@ export namespace androidpublisher_v2 { */ requestBody?: Schema$ExpansionFile; } - export interface Params$Resource$Edits$Expansionfiles$Update { + export interface Params$Resource$Edits$Expansionfiles$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3380,7 +3431,8 @@ export namespace androidpublisher_v2 { */ requestBody?: Schema$ExpansionFile; } - export interface Params$Resource$Edits$Expansionfiles$Upload { + export interface Params$Resource$Edits$Expansionfiles$Upload extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3734,7 +3786,8 @@ export namespace androidpublisher_v2 { } } - export interface Params$Resource$Edits$Images$Delete { + export interface Params$Resource$Edits$Images$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3765,7 +3818,8 @@ export namespace androidpublisher_v2 { */ packageName?: string; } - export interface Params$Resource$Edits$Images$Deleteall { + export interface Params$Resource$Edits$Images$Deleteall extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3791,7 +3845,8 @@ export namespace androidpublisher_v2 { */ packageName?: string; } - export interface Params$Resource$Edits$Images$List { + export interface Params$Resource$Edits$Images$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3817,7 +3872,8 @@ export namespace androidpublisher_v2 { */ packageName?: string; } - export interface Params$Resource$Edits$Images$Upload { + export interface Params$Resource$Edits$Images$Upload extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4289,7 +4345,8 @@ export namespace androidpublisher_v2 { } } - export interface Params$Resource$Edits$Listings$Delete { + export interface Params$Resource$Edits$Listings$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4310,7 +4367,8 @@ export namespace androidpublisher_v2 { */ packageName?: string; } - export interface Params$Resource$Edits$Listings$Deleteall { + export interface Params$Resource$Edits$Listings$Deleteall extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4326,7 +4384,8 @@ export namespace androidpublisher_v2 { */ packageName?: string; } - export interface Params$Resource$Edits$Listings$Get { + export interface Params$Resource$Edits$Listings$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4347,7 +4406,8 @@ export namespace androidpublisher_v2 { */ packageName?: string; } - export interface Params$Resource$Edits$Listings$List { + export interface Params$Resource$Edits$Listings$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4363,7 +4423,8 @@ export namespace androidpublisher_v2 { */ packageName?: string; } - export interface Params$Resource$Edits$Listings$Patch { + export interface Params$Resource$Edits$Listings$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4389,7 +4450,8 @@ export namespace androidpublisher_v2 { */ requestBody?: Schema$Listing; } - export interface Params$Resource$Edits$Listings$Update { + export interface Params$Resource$Edits$Listings$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4634,7 +4696,8 @@ export namespace androidpublisher_v2 { } } - export interface Params$Resource$Edits$Testers$Get { + export interface Params$Resource$Edits$Testers$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4655,7 +4718,8 @@ export namespace androidpublisher_v2 { */ track?: string; } - export interface Params$Resource$Edits$Testers$Patch { + export interface Params$Resource$Edits$Testers$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4681,7 +4745,8 @@ export namespace androidpublisher_v2 { */ requestBody?: Schema$Testers; } - export interface Params$Resource$Edits$Testers$Update { + export interface Params$Resource$Edits$Testers$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5002,7 +5067,7 @@ export namespace androidpublisher_v2 { } } - export interface Params$Resource$Edits$Tracks$Get { + export interface Params$Resource$Edits$Tracks$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5022,7 +5087,8 @@ export namespace androidpublisher_v2 { */ track?: string; } - export interface Params$Resource$Edits$Tracks$List { + export interface Params$Resource$Edits$Tracks$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5038,7 +5104,8 @@ export namespace androidpublisher_v2 { */ packageName?: string; } - export interface Params$Resource$Edits$Tracks$Patch { + export interface Params$Resource$Edits$Tracks$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5063,7 +5130,8 @@ export namespace androidpublisher_v2 { */ requestBody?: Schema$Track; } - export interface Params$Resource$Edits$Tracks$Update { + export interface Params$Resource$Edits$Tracks$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5528,7 +5596,8 @@ export namespace androidpublisher_v2 { } } - export interface Params$Resource$Inappproducts$Delete { + export interface Params$Resource$Inappproducts$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5544,7 +5613,8 @@ export namespace androidpublisher_v2 { */ sku?: string; } - export interface Params$Resource$Inappproducts$Get { + export interface Params$Resource$Inappproducts$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5559,7 +5629,8 @@ export namespace androidpublisher_v2 { */ sku?: string; } - export interface Params$Resource$Inappproducts$Insert { + export interface Params$Resource$Inappproducts$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5581,7 +5652,8 @@ export namespace androidpublisher_v2 { */ requestBody?: Schema$InAppProduct; } - export interface Params$Resource$Inappproducts$List { + export interface Params$Resource$Inappproducts$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5605,7 +5677,8 @@ export namespace androidpublisher_v2 { */ token?: string; } - export interface Params$Resource$Inappproducts$Patch { + export interface Params$Resource$Inappproducts$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5632,7 +5705,8 @@ export namespace androidpublisher_v2 { */ requestBody?: Schema$InAppProduct; } - export interface Params$Resource$Inappproducts$Update { + export interface Params$Resource$Inappproducts$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5740,7 +5814,7 @@ export namespace androidpublisher_v2 { } } - export interface Params$Resource$Orders$Refund { + export interface Params$Resource$Orders$Refund extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5864,7 +5938,8 @@ export namespace androidpublisher_v2 { } } - export interface Params$Resource$Purchases$Products$Get { + export interface Params$Resource$Purchases$Products$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6263,7 +6338,8 @@ export namespace androidpublisher_v2 { } } - export interface Params$Resource$Purchases$Subscriptions$Cancel { + export interface Params$Resource$Purchases$Subscriptions$Cancel extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6284,7 +6360,8 @@ export namespace androidpublisher_v2 { */ token?: string; } - export interface Params$Resource$Purchases$Subscriptions$Defer { + export interface Params$Resource$Purchases$Subscriptions$Defer extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6310,7 +6387,8 @@ export namespace androidpublisher_v2 { */ requestBody?: Schema$SubscriptionPurchasesDeferRequest; } - export interface Params$Resource$Purchases$Subscriptions$Get { + export interface Params$Resource$Purchases$Subscriptions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6331,7 +6409,8 @@ export namespace androidpublisher_v2 { */ token?: string; } - export interface Params$Resource$Purchases$Subscriptions$Refund { + export interface Params$Resource$Purchases$Subscriptions$Refund extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6352,7 +6431,8 @@ export namespace androidpublisher_v2 { */ token?: string; } - export interface Params$Resource$Purchases$Subscriptions$Revoke { + export interface Params$Resource$Purchases$Subscriptions$Revoke extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6467,7 +6547,8 @@ export namespace androidpublisher_v2 { } } - export interface Params$Resource$Purchases$Voidedpurchases$List { + export interface Params$Resource$Purchases$Voidedpurchases$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6730,7 +6811,7 @@ export namespace androidpublisher_v2 { } } - export interface Params$Resource$Reviews$Get { + export interface Params$Resource$Reviews$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6750,7 +6831,7 @@ export namespace androidpublisher_v2 { */ translationLanguage?: string; } - export interface Params$Resource$Reviews$List { + export interface Params$Resource$Reviews$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6778,7 +6859,7 @@ export namespace androidpublisher_v2 { */ translationLanguage?: string; } - export interface Params$Resource$Reviews$Reply { + export interface Params$Resource$Reviews$Reply extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/androidpublisher/v3.ts b/src/apis/androidpublisher/v3.ts index 2adb9b5d02..f174c9a261 100644 --- a/src/apis/androidpublisher/v3.ts +++ b/src/apis/androidpublisher/v3.ts @@ -29,6 +29,40 @@ export namespace androidpublisher_v3 { version: 'v3'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Google Play Developer API * @@ -1347,7 +1381,7 @@ export namespace androidpublisher_v3 { } } - export interface Params$Resource$Edits$Commit { + export interface Params$Resource$Edits$Commit extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1363,7 +1397,7 @@ export namespace androidpublisher_v3 { */ packageName?: string; } - export interface Params$Resource$Edits$Delete { + export interface Params$Resource$Edits$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1379,7 +1413,7 @@ export namespace androidpublisher_v3 { */ packageName?: string; } - export interface Params$Resource$Edits$Get { + export interface Params$Resource$Edits$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1395,7 +1429,7 @@ export namespace androidpublisher_v3 { */ packageName?: string; } - export interface Params$Resource$Edits$Insert { + export interface Params$Resource$Edits$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1412,7 +1446,7 @@ export namespace androidpublisher_v3 { */ requestBody?: Schema$AppEdit; } - export interface Params$Resource$Edits$Validate { + export interface Params$Resource$Edits$Validate extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1665,7 +1699,8 @@ export namespace androidpublisher_v3 { } } - export interface Params$Resource$Edits$Apks$Addexternallyhosted { + export interface Params$Resource$Edits$Apks$Addexternallyhosted extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1686,7 +1721,7 @@ export namespace androidpublisher_v3 { */ requestBody?: Schema$ApksAddExternallyHostedRequest; } - export interface Params$Resource$Edits$Apks$List { + export interface Params$Resource$Edits$Apks$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1702,7 +1737,8 @@ export namespace androidpublisher_v3 { */ packageName?: string; } - export interface Params$Resource$Edits$Apks$Upload { + export interface Params$Resource$Edits$Apks$Upload extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1898,7 +1934,8 @@ export namespace androidpublisher_v3 { } } - export interface Params$Resource$Edits$Bundles$List { + export interface Params$Resource$Edits$Bundles$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1914,7 +1951,8 @@ export namespace androidpublisher_v3 { */ packageName?: string; } - export interface Params$Resource$Edits$Bundles$Upload { + export interface Params$Resource$Edits$Bundles$Upload extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2061,7 +2099,8 @@ export namespace androidpublisher_v3 { } } - export interface Params$Resource$Edits$Deobfuscationfiles$Upload { + export interface Params$Resource$Edits$Deobfuscationfiles$Upload extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2325,7 +2364,8 @@ export namespace androidpublisher_v3 { } } - export interface Params$Resource$Edits$Details$Get { + export interface Params$Resource$Edits$Details$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2341,7 +2381,8 @@ export namespace androidpublisher_v3 { */ packageName?: string; } - export interface Params$Resource$Edits$Details$Patch { + export interface Params$Resource$Edits$Details$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2362,7 +2403,8 @@ export namespace androidpublisher_v3 { */ requestBody?: Schema$AppDetails; } - export interface Params$Resource$Edits$Details$Update { + export interface Params$Resource$Edits$Details$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2708,7 +2750,8 @@ export namespace androidpublisher_v3 { } } - export interface Params$Resource$Edits$Expansionfiles$Get { + export interface Params$Resource$Edits$Expansionfiles$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2733,7 +2776,8 @@ export namespace androidpublisher_v3 { */ packageName?: string; } - export interface Params$Resource$Edits$Expansionfiles$Patch { + export interface Params$Resource$Edits$Expansionfiles$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2763,7 +2807,8 @@ export namespace androidpublisher_v3 { */ requestBody?: Schema$ExpansionFile; } - export interface Params$Resource$Edits$Expansionfiles$Update { + export interface Params$Resource$Edits$Expansionfiles$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2793,7 +2838,8 @@ export namespace androidpublisher_v3 { */ requestBody?: Schema$ExpansionFile; } - export interface Params$Resource$Edits$Expansionfiles$Upload { + export interface Params$Resource$Edits$Expansionfiles$Upload extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3147,7 +3193,8 @@ export namespace androidpublisher_v3 { } } - export interface Params$Resource$Edits$Images$Delete { + export interface Params$Resource$Edits$Images$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3178,7 +3225,8 @@ export namespace androidpublisher_v3 { */ packageName?: string; } - export interface Params$Resource$Edits$Images$Deleteall { + export interface Params$Resource$Edits$Images$Deleteall extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3204,7 +3252,8 @@ export namespace androidpublisher_v3 { */ packageName?: string; } - export interface Params$Resource$Edits$Images$List { + export interface Params$Resource$Edits$Images$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3230,7 +3279,8 @@ export namespace androidpublisher_v3 { */ packageName?: string; } - export interface Params$Resource$Edits$Images$Upload { + export interface Params$Resource$Edits$Images$Upload extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3702,7 +3752,8 @@ export namespace androidpublisher_v3 { } } - export interface Params$Resource$Edits$Listings$Delete { + export interface Params$Resource$Edits$Listings$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3723,7 +3774,8 @@ export namespace androidpublisher_v3 { */ packageName?: string; } - export interface Params$Resource$Edits$Listings$Deleteall { + export interface Params$Resource$Edits$Listings$Deleteall extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3739,7 +3791,8 @@ export namespace androidpublisher_v3 { */ packageName?: string; } - export interface Params$Resource$Edits$Listings$Get { + export interface Params$Resource$Edits$Listings$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3760,7 +3813,8 @@ export namespace androidpublisher_v3 { */ packageName?: string; } - export interface Params$Resource$Edits$Listings$List { + export interface Params$Resource$Edits$Listings$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3776,7 +3830,8 @@ export namespace androidpublisher_v3 { */ packageName?: string; } - export interface Params$Resource$Edits$Listings$Patch { + export interface Params$Resource$Edits$Listings$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3802,7 +3857,8 @@ export namespace androidpublisher_v3 { */ requestBody?: Schema$Listing; } - export interface Params$Resource$Edits$Listings$Update { + export interface Params$Resource$Edits$Listings$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4047,7 +4103,8 @@ export namespace androidpublisher_v3 { } } - export interface Params$Resource$Edits$Testers$Get { + export interface Params$Resource$Edits$Testers$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4068,7 +4125,8 @@ export namespace androidpublisher_v3 { */ track?: string; } - export interface Params$Resource$Edits$Testers$Patch { + export interface Params$Resource$Edits$Testers$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4094,7 +4152,8 @@ export namespace androidpublisher_v3 { */ requestBody?: Schema$Testers; } - export interface Params$Resource$Edits$Testers$Update { + export interface Params$Resource$Edits$Testers$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4415,7 +4474,7 @@ export namespace androidpublisher_v3 { } } - export interface Params$Resource$Edits$Tracks$Get { + export interface Params$Resource$Edits$Tracks$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4435,7 +4494,8 @@ export namespace androidpublisher_v3 { */ track?: string; } - export interface Params$Resource$Edits$Tracks$List { + export interface Params$Resource$Edits$Tracks$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4451,7 +4511,8 @@ export namespace androidpublisher_v3 { */ packageName?: string; } - export interface Params$Resource$Edits$Tracks$Patch { + export interface Params$Resource$Edits$Tracks$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4476,7 +4537,8 @@ export namespace androidpublisher_v3 { */ requestBody?: Schema$Track; } - export interface Params$Resource$Edits$Tracks$Update { + export interface Params$Resource$Edits$Tracks$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4941,7 +5003,8 @@ export namespace androidpublisher_v3 { } } - export interface Params$Resource$Inappproducts$Delete { + export interface Params$Resource$Inappproducts$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4957,7 +5020,8 @@ export namespace androidpublisher_v3 { */ sku?: string; } - export interface Params$Resource$Inappproducts$Get { + export interface Params$Resource$Inappproducts$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4972,7 +5036,8 @@ export namespace androidpublisher_v3 { */ sku?: string; } - export interface Params$Resource$Inappproducts$Insert { + export interface Params$Resource$Inappproducts$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4994,7 +5059,8 @@ export namespace androidpublisher_v3 { */ requestBody?: Schema$InAppProduct; } - export interface Params$Resource$Inappproducts$List { + export interface Params$Resource$Inappproducts$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5018,7 +5084,8 @@ export namespace androidpublisher_v3 { */ token?: string; } - export interface Params$Resource$Inappproducts$Patch { + export interface Params$Resource$Inappproducts$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5045,7 +5112,8 @@ export namespace androidpublisher_v3 { */ requestBody?: Schema$InAppProduct; } - export interface Params$Resource$Inappproducts$Update { + export interface Params$Resource$Inappproducts$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5153,7 +5221,7 @@ export namespace androidpublisher_v3 { } } - export interface Params$Resource$Orders$Refund { + export interface Params$Resource$Orders$Refund extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5277,7 +5345,8 @@ export namespace androidpublisher_v3 { } } - export interface Params$Resource$Purchases$Products$Get { + export interface Params$Resource$Purchases$Products$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5676,7 +5745,8 @@ export namespace androidpublisher_v3 { } } - export interface Params$Resource$Purchases$Subscriptions$Cancel { + export interface Params$Resource$Purchases$Subscriptions$Cancel extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5697,7 +5767,8 @@ export namespace androidpublisher_v3 { */ token?: string; } - export interface Params$Resource$Purchases$Subscriptions$Defer { + export interface Params$Resource$Purchases$Subscriptions$Defer extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5723,7 +5794,8 @@ export namespace androidpublisher_v3 { */ requestBody?: Schema$SubscriptionPurchasesDeferRequest; } - export interface Params$Resource$Purchases$Subscriptions$Get { + export interface Params$Resource$Purchases$Subscriptions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5744,7 +5816,8 @@ export namespace androidpublisher_v3 { */ token?: string; } - export interface Params$Resource$Purchases$Subscriptions$Refund { + export interface Params$Resource$Purchases$Subscriptions$Refund extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5765,7 +5838,8 @@ export namespace androidpublisher_v3 { */ token?: string; } - export interface Params$Resource$Purchases$Subscriptions$Revoke { + export interface Params$Resource$Purchases$Subscriptions$Revoke extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5880,7 +5954,8 @@ export namespace androidpublisher_v3 { } } - export interface Params$Resource$Purchases$Voidedpurchases$List { + export interface Params$Resource$Purchases$Voidedpurchases$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6143,7 +6218,7 @@ export namespace androidpublisher_v3 { } } - export interface Params$Resource$Reviews$Get { + export interface Params$Resource$Reviews$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6163,7 +6238,7 @@ export namespace androidpublisher_v3 { */ translationLanguage?: string; } - export interface Params$Resource$Reviews$List { + export interface Params$Resource$Reviews$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6191,7 +6266,7 @@ export namespace androidpublisher_v3 { */ translationLanguage?: string; } - export interface Params$Resource$Reviews$Reply { + export interface Params$Resource$Reviews$Reply extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/appengine/README.md b/src/apis/appengine/README.md index 33f4fb862e..43f3ece8a3 100644 --- a/src/apis/appengine/README.md +++ b/src/apis/appengine/README.md @@ -2,7 +2,7 @@ # @google/appengine -> The App Engine Admin API enables developers to provision and manage their App Engine applications. +> Provisions and manages developers' App Engine applications. ## Installation diff --git a/src/apis/appengine/v1.ts b/src/apis/appengine/v1.ts index c58ec14c66..c87e72762d 100644 --- a/src/apis/appengine/v1.ts +++ b/src/apis/appengine/v1.ts @@ -29,11 +29,61 @@ export namespace appengine_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * App Engine Admin API * - * The App Engine Admin API enables developers to provision and manage their - * App Engine applications. + * Provisions and manages developers' App Engine applications. * * @example * const {google} = require('googleapis'); @@ -2249,7 +2299,7 @@ export namespace appengine_v1 { } } - export interface Params$Resource$Apps$Create { + export interface Params$Resource$Apps$Create extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2261,7 +2311,7 @@ export namespace appengine_v1 { */ requestBody?: Schema$Application; } - export interface Params$Resource$Apps$Get { + export interface Params$Resource$Apps$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2273,7 +2323,7 @@ export namespace appengine_v1 { */ appsId?: string; } - export interface Params$Resource$Apps$Patch { + export interface Params$Resource$Apps$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2294,7 +2344,7 @@ export namespace appengine_v1 { */ requestBody?: Schema$Application; } - export interface Params$Resource$Apps$Repair { + export interface Params$Resource$Apps$Repair extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2687,7 +2737,8 @@ export namespace appengine_v1 { } } - export interface Params$Resource$Apps$Authorizedcertificates$Create { + export interface Params$Resource$Apps$Authorizedcertificates$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2704,7 +2755,8 @@ export namespace appengine_v1 { */ requestBody?: Schema$AuthorizedCertificate; } - export interface Params$Resource$Apps$Authorizedcertificates$Delete { + export interface Params$Resource$Apps$Authorizedcertificates$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2720,7 +2772,8 @@ export namespace appengine_v1 { */ authorizedCertificatesId?: string; } - export interface Params$Resource$Apps$Authorizedcertificates$Get { + export interface Params$Resource$Apps$Authorizedcertificates$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2740,7 +2793,8 @@ export namespace appengine_v1 { */ view?: string; } - export interface Params$Resource$Apps$Authorizedcertificates$List { + export interface Params$Resource$Apps$Authorizedcertificates$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2764,7 +2818,8 @@ export namespace appengine_v1 { */ view?: string; } - export interface Params$Resource$Apps$Authorizedcertificates$Patch { + export interface Params$Resource$Apps$Authorizedcertificates$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2880,7 +2935,8 @@ export namespace appengine_v1 { } } - export interface Params$Resource$Apps$Authorizeddomains$List { + export interface Params$Resource$Apps$Authorizeddomains$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3271,7 +3327,8 @@ export namespace appengine_v1 { } } - export interface Params$Resource$Apps$Domainmappings$Create { + export interface Params$Resource$Apps$Domainmappings$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3293,7 +3350,8 @@ export namespace appengine_v1 { */ requestBody?: Schema$DomainMapping; } - export interface Params$Resource$Apps$Domainmappings$Delete { + export interface Params$Resource$Apps$Domainmappings$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3309,7 +3367,8 @@ export namespace appengine_v1 { */ domainMappingsId?: string; } - export interface Params$Resource$Apps$Domainmappings$Get { + export interface Params$Resource$Apps$Domainmappings$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3325,7 +3384,8 @@ export namespace appengine_v1 { */ domainMappingsId?: string; } - export interface Params$Resource$Apps$Domainmappings$List { + export interface Params$Resource$Apps$Domainmappings$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3345,7 +3405,8 @@ export namespace appengine_v1 { */ pageToken?: string; } - export interface Params$Resource$Apps$Domainmappings$Patch { + export interface Params$Resource$Apps$Domainmappings$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3825,7 +3886,8 @@ export namespace appengine_v1 { } } - export interface Params$Resource$Apps$Firewall$Ingressrules$Batchupdate { + export interface Params$Resource$Apps$Firewall$Ingressrules$Batchupdate + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3842,7 +3904,8 @@ export namespace appengine_v1 { */ requestBody?: Schema$BatchUpdateIngressRulesRequest; } - export interface Params$Resource$Apps$Firewall$Ingressrules$Create { + export interface Params$Resource$Apps$Firewall$Ingressrules$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3859,7 +3922,8 @@ export namespace appengine_v1 { */ requestBody?: Schema$FirewallRule; } - export interface Params$Resource$Apps$Firewall$Ingressrules$Delete { + export interface Params$Resource$Apps$Firewall$Ingressrules$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3875,7 +3939,8 @@ export namespace appengine_v1 { */ ingressRulesId?: string; } - export interface Params$Resource$Apps$Firewall$Ingressrules$Get { + export interface Params$Resource$Apps$Firewall$Ingressrules$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3891,7 +3956,8 @@ export namespace appengine_v1 { */ ingressRulesId?: string; } - export interface Params$Resource$Apps$Firewall$Ingressrules$List { + export interface Params$Resource$Apps$Firewall$Ingressrules$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3917,7 +3983,8 @@ export namespace appengine_v1 { */ pageToken?: string; } - export interface Params$Resource$Apps$Firewall$Ingressrules$Patch { + export interface Params$Resource$Apps$Firewall$Ingressrules$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4090,7 +4157,8 @@ export namespace appengine_v1 { } } - export interface Params$Resource$Apps$Locations$Get { + export interface Params$Resource$Apps$Locations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4105,7 +4173,8 @@ export namespace appengine_v1 { */ locationsId?: string; } - export interface Params$Resource$Apps$Locations$List { + export interface Params$Resource$Apps$Locations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4288,7 +4357,8 @@ export namespace appengine_v1 { } } - export interface Params$Resource$Apps$Operations$Get { + export interface Params$Resource$Apps$Operations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4303,7 +4373,8 @@ export namespace appengine_v1 { */ operationsId?: string; } - export interface Params$Resource$Apps$Operations$List { + export interface Params$Resource$Apps$Operations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4613,7 +4684,8 @@ export namespace appengine_v1 { } } - export interface Params$Resource$Apps$Services$Delete { + export interface Params$Resource$Apps$Services$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4629,7 +4701,8 @@ export namespace appengine_v1 { */ servicesId?: string; } - export interface Params$Resource$Apps$Services$Get { + export interface Params$Resource$Apps$Services$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4645,7 +4718,8 @@ export namespace appengine_v1 { */ servicesId?: string; } - export interface Params$Resource$Apps$Services$List { + export interface Params$Resource$Apps$Services$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4665,7 +4739,8 @@ export namespace appengine_v1 { */ pageToken?: string; } - export interface Params$Resource$Apps$Services$Patch { + export interface Params$Resource$Apps$Services$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5106,7 +5181,8 @@ export namespace appengine_v1 { } } - export interface Params$Resource$Apps$Services$Versions$Create { + export interface Params$Resource$Apps$Services$Versions$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5127,7 +5203,8 @@ export namespace appengine_v1 { */ requestBody?: Schema$Version; } - export interface Params$Resource$Apps$Services$Versions$Delete { + export interface Params$Resource$Apps$Services$Versions$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5147,7 +5224,8 @@ export namespace appengine_v1 { */ versionsId?: string; } - export interface Params$Resource$Apps$Services$Versions$Get { + export interface Params$Resource$Apps$Services$Versions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5171,7 +5249,8 @@ export namespace appengine_v1 { */ view?: string; } - export interface Params$Resource$Apps$Services$Versions$List { + export interface Params$Resource$Apps$Services$Versions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5199,7 +5278,8 @@ export namespace appengine_v1 { */ view?: string; } - export interface Params$Resource$Apps$Services$Versions$Patch { + export interface Params$Resource$Apps$Services$Versions$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5537,7 +5617,8 @@ export namespace appengine_v1 { } } - export interface Params$Resource$Apps$Services$Versions$Instances$Debug { + export interface Params$Resource$Apps$Services$Versions$Instances$Debug + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5566,7 +5647,8 @@ export namespace appengine_v1 { */ requestBody?: Schema$DebugInstanceRequest; } - export interface Params$Resource$Apps$Services$Versions$Instances$Delete { + export interface Params$Resource$Apps$Services$Versions$Instances$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5590,7 +5672,8 @@ export namespace appengine_v1 { */ versionsId?: string; } - export interface Params$Resource$Apps$Services$Versions$Instances$Get { + export interface Params$Resource$Apps$Services$Versions$Instances$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5614,7 +5697,8 @@ export namespace appengine_v1 { */ versionsId?: string; } - export interface Params$Resource$Apps$Services$Versions$Instances$List { + export interface Params$Resource$Apps$Services$Versions$Instances$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/appengine/v1alpha.ts b/src/apis/appengine/v1alpha.ts index ac6e08c984..51a4f29778 100644 --- a/src/apis/appengine/v1alpha.ts +++ b/src/apis/appengine/v1alpha.ts @@ -29,11 +29,61 @@ export namespace appengine_v1alpha { version: 'v1alpha'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * App Engine Admin API * - * The App Engine Admin API enables developers to provision and manage their - * App Engine applications. + * Provisions and manages developers' App Engine applications. * * @example * const {google} = require('googleapis'); @@ -1062,7 +1112,8 @@ export namespace appengine_v1alpha { } } - export interface Params$Resource$Apps$Authorizedcertificates$Create { + export interface Params$Resource$Apps$Authorizedcertificates$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1079,7 +1130,8 @@ export namespace appengine_v1alpha { */ requestBody?: Schema$AuthorizedCertificate; } - export interface Params$Resource$Apps$Authorizedcertificates$Delete { + export interface Params$Resource$Apps$Authorizedcertificates$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1095,7 +1147,8 @@ export namespace appengine_v1alpha { */ authorizedCertificatesId?: string; } - export interface Params$Resource$Apps$Authorizedcertificates$Get { + export interface Params$Resource$Apps$Authorizedcertificates$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1115,7 +1168,8 @@ export namespace appengine_v1alpha { */ view?: string; } - export interface Params$Resource$Apps$Authorizedcertificates$List { + export interface Params$Resource$Apps$Authorizedcertificates$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1139,7 +1193,8 @@ export namespace appengine_v1alpha { */ view?: string; } - export interface Params$Resource$Apps$Authorizedcertificates$Patch { + export interface Params$Resource$Apps$Authorizedcertificates$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1255,7 +1310,8 @@ export namespace appengine_v1alpha { } } - export interface Params$Resource$Apps$Authorizeddomains$List { + export interface Params$Resource$Apps$Authorizeddomains$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1648,7 +1704,8 @@ export namespace appengine_v1alpha { } } - export interface Params$Resource$Apps$Domainmappings$Create { + export interface Params$Resource$Apps$Domainmappings$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1677,7 +1734,8 @@ export namespace appengine_v1alpha { */ requestBody?: Schema$DomainMapping; } - export interface Params$Resource$Apps$Domainmappings$Delete { + export interface Params$Resource$Apps$Domainmappings$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1693,7 +1751,8 @@ export namespace appengine_v1alpha { */ domainMappingsId?: string; } - export interface Params$Resource$Apps$Domainmappings$Get { + export interface Params$Resource$Apps$Domainmappings$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1709,7 +1768,8 @@ export namespace appengine_v1alpha { */ domainMappingsId?: string; } - export interface Params$Resource$Apps$Domainmappings$List { + export interface Params$Resource$Apps$Domainmappings$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1729,7 +1789,8 @@ export namespace appengine_v1alpha { */ pageToken?: string; } - export interface Params$Resource$Apps$Domainmappings$Patch { + export interface Params$Resource$Apps$Domainmappings$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1910,7 +1971,8 @@ export namespace appengine_v1alpha { } } - export interface Params$Resource$Apps$Locations$Get { + export interface Params$Resource$Apps$Locations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1925,7 +1987,8 @@ export namespace appengine_v1alpha { */ locationsId?: string; } - export interface Params$Resource$Apps$Locations$List { + export interface Params$Resource$Apps$Locations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2109,7 +2172,8 @@ export namespace appengine_v1alpha { } } - export interface Params$Resource$Apps$Operations$Get { + export interface Params$Resource$Apps$Operations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2124,7 +2188,8 @@ export namespace appengine_v1alpha { */ operationsId?: string; } - export interface Params$Resource$Apps$Operations$List { + export interface Params$Resource$Apps$Operations$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/appengine/v1beta.ts b/src/apis/appengine/v1beta.ts index 501ec4068d..4d86bf3924 100644 --- a/src/apis/appengine/v1beta.ts +++ b/src/apis/appengine/v1beta.ts @@ -29,11 +29,61 @@ export namespace appengine_v1beta { version: 'v1beta'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * App Engine Admin API * - * The App Engine Admin API enables developers to provision and manage their - * App Engine applications. + * Provisions and manages developers' App Engine applications. * * @example * const {google} = require('googleapis'); @@ -2342,7 +2392,7 @@ export namespace appengine_v1beta { } } - export interface Params$Resource$Apps$Create { + export interface Params$Resource$Apps$Create extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2354,7 +2404,7 @@ export namespace appengine_v1beta { */ requestBody?: Schema$Application; } - export interface Params$Resource$Apps$Get { + export interface Params$Resource$Apps$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2366,7 +2416,7 @@ export namespace appengine_v1beta { */ appsId?: string; } - export interface Params$Resource$Apps$Patch { + export interface Params$Resource$Apps$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2387,7 +2437,7 @@ export namespace appengine_v1beta { */ requestBody?: Schema$Application; } - export interface Params$Resource$Apps$Repair { + export interface Params$Resource$Apps$Repair extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2780,7 +2830,8 @@ export namespace appengine_v1beta { } } - export interface Params$Resource$Apps$Authorizedcertificates$Create { + export interface Params$Resource$Apps$Authorizedcertificates$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2797,7 +2848,8 @@ export namespace appengine_v1beta { */ requestBody?: Schema$AuthorizedCertificate; } - export interface Params$Resource$Apps$Authorizedcertificates$Delete { + export interface Params$Resource$Apps$Authorizedcertificates$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2813,7 +2865,8 @@ export namespace appengine_v1beta { */ authorizedCertificatesId?: string; } - export interface Params$Resource$Apps$Authorizedcertificates$Get { + export interface Params$Resource$Apps$Authorizedcertificates$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2833,7 +2886,8 @@ export namespace appengine_v1beta { */ view?: string; } - export interface Params$Resource$Apps$Authorizedcertificates$List { + export interface Params$Resource$Apps$Authorizedcertificates$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2857,7 +2911,8 @@ export namespace appengine_v1beta { */ view?: string; } - export interface Params$Resource$Apps$Authorizedcertificates$Patch { + export interface Params$Resource$Apps$Authorizedcertificates$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2973,7 +3028,8 @@ export namespace appengine_v1beta { } } - export interface Params$Resource$Apps$Authorizeddomains$List { + export interface Params$Resource$Apps$Authorizeddomains$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3364,7 +3420,8 @@ export namespace appengine_v1beta { } } - export interface Params$Resource$Apps$Domainmappings$Create { + export interface Params$Resource$Apps$Domainmappings$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3386,7 +3443,8 @@ export namespace appengine_v1beta { */ requestBody?: Schema$DomainMapping; } - export interface Params$Resource$Apps$Domainmappings$Delete { + export interface Params$Resource$Apps$Domainmappings$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3402,7 +3460,8 @@ export namespace appengine_v1beta { */ domainMappingsId?: string; } - export interface Params$Resource$Apps$Domainmappings$Get { + export interface Params$Resource$Apps$Domainmappings$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3418,7 +3477,8 @@ export namespace appengine_v1beta { */ domainMappingsId?: string; } - export interface Params$Resource$Apps$Domainmappings$List { + export interface Params$Resource$Apps$Domainmappings$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3438,7 +3498,8 @@ export namespace appengine_v1beta { */ pageToken?: string; } - export interface Params$Resource$Apps$Domainmappings$Patch { + export interface Params$Resource$Apps$Domainmappings$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3921,7 +3982,8 @@ export namespace appengine_v1beta { } } - export interface Params$Resource$Apps$Firewall$Ingressrules$Batchupdate { + export interface Params$Resource$Apps$Firewall$Ingressrules$Batchupdate + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3938,7 +4000,8 @@ export namespace appengine_v1beta { */ requestBody?: Schema$BatchUpdateIngressRulesRequest; } - export interface Params$Resource$Apps$Firewall$Ingressrules$Create { + export interface Params$Resource$Apps$Firewall$Ingressrules$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3955,7 +4018,8 @@ export namespace appengine_v1beta { */ requestBody?: Schema$FirewallRule; } - export interface Params$Resource$Apps$Firewall$Ingressrules$Delete { + export interface Params$Resource$Apps$Firewall$Ingressrules$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3971,7 +4035,8 @@ export namespace appengine_v1beta { */ ingressRulesId?: string; } - export interface Params$Resource$Apps$Firewall$Ingressrules$Get { + export interface Params$Resource$Apps$Firewall$Ingressrules$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3987,7 +4052,8 @@ export namespace appengine_v1beta { */ ingressRulesId?: string; } - export interface Params$Resource$Apps$Firewall$Ingressrules$List { + export interface Params$Resource$Apps$Firewall$Ingressrules$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4013,7 +4079,8 @@ export namespace appengine_v1beta { */ pageToken?: string; } - export interface Params$Resource$Apps$Firewall$Ingressrules$Patch { + export interface Params$Resource$Apps$Firewall$Ingressrules$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4186,7 +4253,8 @@ export namespace appengine_v1beta { } } - export interface Params$Resource$Apps$Locations$Get { + export interface Params$Resource$Apps$Locations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4201,7 +4269,8 @@ export namespace appengine_v1beta { */ locationsId?: string; } - export interface Params$Resource$Apps$Locations$List { + export interface Params$Resource$Apps$Locations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4384,7 +4453,8 @@ export namespace appengine_v1beta { } } - export interface Params$Resource$Apps$Operations$Get { + export interface Params$Resource$Apps$Operations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4399,7 +4469,8 @@ export namespace appengine_v1beta { */ operationsId?: string; } - export interface Params$Resource$Apps$Operations$List { + export interface Params$Resource$Apps$Operations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4709,7 +4780,8 @@ export namespace appengine_v1beta { } } - export interface Params$Resource$Apps$Services$Delete { + export interface Params$Resource$Apps$Services$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4725,7 +4797,8 @@ export namespace appengine_v1beta { */ servicesId?: string; } - export interface Params$Resource$Apps$Services$Get { + export interface Params$Resource$Apps$Services$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4741,7 +4814,8 @@ export namespace appengine_v1beta { */ servicesId?: string; } - export interface Params$Resource$Apps$Services$List { + export interface Params$Resource$Apps$Services$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4761,7 +4835,8 @@ export namespace appengine_v1beta { */ pageToken?: string; } - export interface Params$Resource$Apps$Services$Patch { + export interface Params$Resource$Apps$Services$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5202,7 +5277,8 @@ export namespace appengine_v1beta { } } - export interface Params$Resource$Apps$Services$Versions$Create { + export interface Params$Resource$Apps$Services$Versions$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5223,7 +5299,8 @@ export namespace appengine_v1beta { */ requestBody?: Schema$Version; } - export interface Params$Resource$Apps$Services$Versions$Delete { + export interface Params$Resource$Apps$Services$Versions$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5243,7 +5320,8 @@ export namespace appengine_v1beta { */ versionsId?: string; } - export interface Params$Resource$Apps$Services$Versions$Get { + export interface Params$Resource$Apps$Services$Versions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5267,7 +5345,8 @@ export namespace appengine_v1beta { */ view?: string; } - export interface Params$Resource$Apps$Services$Versions$List { + export interface Params$Resource$Apps$Services$Versions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5295,7 +5374,8 @@ export namespace appengine_v1beta { */ view?: string; } - export interface Params$Resource$Apps$Services$Versions$Patch { + export interface Params$Resource$Apps$Services$Versions$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5633,7 +5713,8 @@ export namespace appengine_v1beta { } } - export interface Params$Resource$Apps$Services$Versions$Instances$Debug { + export interface Params$Resource$Apps$Services$Versions$Instances$Debug + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5662,7 +5743,8 @@ export namespace appengine_v1beta { */ requestBody?: Schema$DebugInstanceRequest; } - export interface Params$Resource$Apps$Services$Versions$Instances$Delete { + export interface Params$Resource$Apps$Services$Versions$Instances$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5686,7 +5768,8 @@ export namespace appengine_v1beta { */ versionsId?: string; } - export interface Params$Resource$Apps$Services$Versions$Instances$Get { + export interface Params$Resource$Apps$Services$Versions$Instances$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5710,7 +5793,8 @@ export namespace appengine_v1beta { */ versionsId?: string; } - export interface Params$Resource$Apps$Services$Versions$Instances$List { + export interface Params$Resource$Apps$Services$Versions$Instances$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/appengine/v1beta4.ts b/src/apis/appengine/v1beta4.ts index de72d7dc7e..213e2aeea6 100644 --- a/src/apis/appengine/v1beta4.ts +++ b/src/apis/appengine/v1beta4.ts @@ -29,11 +29,61 @@ export namespace appengine_v1beta4 { version: 'v1beta4'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * App Engine Admin API * - * The App Engine Admin API enables developers to provision and manage their - * App Engine applications. + * Provisions and manages developers' App Engine applications. * * @example * const {google} = require('googleapis'); @@ -1670,7 +1720,7 @@ export namespace appengine_v1beta4 { } } - export interface Params$Resource$Apps$Create { + export interface Params$Resource$Apps$Create extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1682,7 +1732,7 @@ export namespace appengine_v1beta4 { */ requestBody?: Schema$Application; } - export interface Params$Resource$Apps$Get { + export interface Params$Resource$Apps$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1701,7 +1751,7 @@ export namespace appengine_v1beta4 { */ ensureResourcesExist?: boolean; } - export interface Params$Resource$Apps$Patch { + export interface Params$Resource$Apps$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1868,7 +1918,8 @@ export namespace appengine_v1beta4 { } } - export interface Params$Resource$Apps$Locations$Get { + export interface Params$Resource$Apps$Locations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1883,7 +1934,8 @@ export namespace appengine_v1beta4 { */ locationsId?: string; } - export interface Params$Resource$Apps$Locations$List { + export interface Params$Resource$Apps$Locations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2191,7 +2243,8 @@ export namespace appengine_v1beta4 { } } - export interface Params$Resource$Apps$Modules$Delete { + export interface Params$Resource$Apps$Modules$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2207,7 +2260,7 @@ export namespace appengine_v1beta4 { */ modulesId?: string; } - export interface Params$Resource$Apps$Modules$Get { + export interface Params$Resource$Apps$Modules$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2223,7 +2276,8 @@ export namespace appengine_v1beta4 { */ modulesId?: string; } - export interface Params$Resource$Apps$Modules$List { + export interface Params$Resource$Apps$Modules$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2242,7 +2296,8 @@ export namespace appengine_v1beta4 { */ pageToken?: string; } - export interface Params$Resource$Apps$Modules$Patch { + export interface Params$Resource$Apps$Modules$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2668,7 +2723,8 @@ export namespace appengine_v1beta4 { } } - export interface Params$Resource$Apps$Modules$Versions$Create { + export interface Params$Resource$Apps$Modules$Versions$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2689,7 +2745,8 @@ export namespace appengine_v1beta4 { */ requestBody?: Schema$Version; } - export interface Params$Resource$Apps$Modules$Versions$Delete { + export interface Params$Resource$Apps$Modules$Versions$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2709,7 +2766,8 @@ export namespace appengine_v1beta4 { */ versionsId?: string; } - export interface Params$Resource$Apps$Modules$Versions$Get { + export interface Params$Resource$Apps$Modules$Versions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2733,7 +2791,8 @@ export namespace appengine_v1beta4 { */ view?: string; } - export interface Params$Resource$Apps$Modules$Versions$List { + export interface Params$Resource$Apps$Modules$Versions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2761,7 +2820,8 @@ export namespace appengine_v1beta4 { */ view?: string; } - export interface Params$Resource$Apps$Modules$Versions$Patch { + export interface Params$Resource$Apps$Modules$Versions$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3098,7 +3158,8 @@ export namespace appengine_v1beta4 { } } - export interface Params$Resource$Apps$Modules$Versions$Instances$Debug { + export interface Params$Resource$Apps$Modules$Versions$Instances$Debug extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3127,7 +3188,8 @@ export namespace appengine_v1beta4 { */ requestBody?: Schema$DebugInstanceRequest; } - export interface Params$Resource$Apps$Modules$Versions$Instances$Delete { + export interface Params$Resource$Apps$Modules$Versions$Instances$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3151,7 +3213,8 @@ export namespace appengine_v1beta4 { */ versionsId?: string; } - export interface Params$Resource$Apps$Modules$Versions$Instances$Get { + export interface Params$Resource$Apps$Modules$Versions$Instances$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3175,7 +3238,8 @@ export namespace appengine_v1beta4 { */ versionsId?: string; } - export interface Params$Resource$Apps$Modules$Versions$Instances$List { + export interface Params$Resource$Apps$Modules$Versions$Instances$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3364,7 +3428,8 @@ export namespace appengine_v1beta4 { } } - export interface Params$Resource$Apps$Operations$Get { + export interface Params$Resource$Apps$Operations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3379,7 +3444,8 @@ export namespace appengine_v1beta4 { */ operationsId?: string; } - export interface Params$Resource$Apps$Operations$List { + export interface Params$Resource$Apps$Operations$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/appengine/v1beta5.ts b/src/apis/appengine/v1beta5.ts index 041a84ffee..7eb6177243 100644 --- a/src/apis/appengine/v1beta5.ts +++ b/src/apis/appengine/v1beta5.ts @@ -29,11 +29,61 @@ export namespace appengine_v1beta5 { version: 'v1beta5'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * App Engine Admin API * - * The App Engine Admin API enables developers to provision and manage their - * App Engine applications. + * Provisions and manages developers' App Engine applications. * * @example * const {google} = require('googleapis'); @@ -1646,7 +1696,7 @@ export namespace appengine_v1beta5 { } } - export interface Params$Resource$Apps$Create { + export interface Params$Resource$Apps$Create extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1658,7 +1708,7 @@ export namespace appengine_v1beta5 { */ requestBody?: Schema$Application; } - export interface Params$Resource$Apps$Get { + export interface Params$Resource$Apps$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1678,7 +1728,7 @@ export namespace appengine_v1beta5 { */ ensureResourcesExist?: boolean; } - export interface Params$Resource$Apps$Patch { + export interface Params$Resource$Apps$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1845,7 +1895,8 @@ export namespace appengine_v1beta5 { } } - export interface Params$Resource$Apps$Locations$Get { + export interface Params$Resource$Apps$Locations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1860,7 +1911,8 @@ export namespace appengine_v1beta5 { */ locationsId?: string; } - export interface Params$Resource$Apps$Locations$List { + export interface Params$Resource$Apps$Locations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2044,7 +2096,8 @@ export namespace appengine_v1beta5 { } } - export interface Params$Resource$Apps$Operations$Get { + export interface Params$Resource$Apps$Operations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2059,7 +2112,8 @@ export namespace appengine_v1beta5 { */ operationsId?: string; } - export interface Params$Resource$Apps$Operations$List { + export interface Params$Resource$Apps$Operations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2369,7 +2423,8 @@ export namespace appengine_v1beta5 { } } - export interface Params$Resource$Apps$Services$Delete { + export interface Params$Resource$Apps$Services$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2385,7 +2440,8 @@ export namespace appengine_v1beta5 { */ servicesId?: string; } - export interface Params$Resource$Apps$Services$Get { + export interface Params$Resource$Apps$Services$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2401,7 +2457,8 @@ export namespace appengine_v1beta5 { */ servicesId?: string; } - export interface Params$Resource$Apps$Services$List { + export interface Params$Resource$Apps$Services$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2420,7 +2477,8 @@ export namespace appengine_v1beta5 { */ pageToken?: string; } - export interface Params$Resource$Apps$Services$Patch { + export interface Params$Resource$Apps$Services$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2846,7 +2904,8 @@ export namespace appengine_v1beta5 { } } - export interface Params$Resource$Apps$Services$Versions$Create { + export interface Params$Resource$Apps$Services$Versions$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2867,7 +2926,8 @@ export namespace appengine_v1beta5 { */ requestBody?: Schema$Version; } - export interface Params$Resource$Apps$Services$Versions$Delete { + export interface Params$Resource$Apps$Services$Versions$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2887,7 +2947,8 @@ export namespace appengine_v1beta5 { */ versionsId?: string; } - export interface Params$Resource$Apps$Services$Versions$Get { + export interface Params$Resource$Apps$Services$Versions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2911,7 +2972,8 @@ export namespace appengine_v1beta5 { */ view?: string; } - export interface Params$Resource$Apps$Services$Versions$List { + export interface Params$Resource$Apps$Services$Versions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2939,7 +3001,8 @@ export namespace appengine_v1beta5 { */ view?: string; } - export interface Params$Resource$Apps$Services$Versions$Patch { + export interface Params$Resource$Apps$Services$Versions$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3277,7 +3340,8 @@ export namespace appengine_v1beta5 { } } - export interface Params$Resource$Apps$Services$Versions$Instances$Debug { + export interface Params$Resource$Apps$Services$Versions$Instances$Debug + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3306,7 +3370,8 @@ export namespace appengine_v1beta5 { */ requestBody?: Schema$DebugInstanceRequest; } - export interface Params$Resource$Apps$Services$Versions$Instances$Delete { + export interface Params$Resource$Apps$Services$Versions$Instances$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3330,7 +3395,8 @@ export namespace appengine_v1beta5 { */ versionsId?: string; } - export interface Params$Resource$Apps$Services$Versions$Instances$Get { + export interface Params$Resource$Apps$Services$Versions$Instances$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3354,7 +3420,8 @@ export namespace appengine_v1beta5 { */ versionsId?: string; } - export interface Params$Resource$Apps$Services$Versions$Instances$List { + export interface Params$Resource$Apps$Services$Versions$Instances$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/appsactivity/v1.ts b/src/apis/appsactivity/v1.ts index 2c49fc4f0d..a8a822c990 100644 --- a/src/apis/appsactivity/v1.ts +++ b/src/apis/appsactivity/v1.ts @@ -29,6 +29,40 @@ export namespace appsactivity_v1 { version: 'v1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Drive Activity API * @@ -379,7 +413,7 @@ export namespace appsactivity_v1 { } } - export interface Params$Resource$Activities$List { + export interface Params$Resource$Activities$List extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/appstate/v1.ts b/src/apis/appstate/v1.ts index c8302b2505..bb58fa875d 100644 --- a/src/apis/appstate/v1.ts +++ b/src/apis/appstate/v1.ts @@ -29,6 +29,40 @@ export namespace appstate_v1 { version: 'v1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Google App State API * @@ -482,7 +516,7 @@ export namespace appstate_v1 { } } - export interface Params$Resource$States$Clear { + export interface Params$Resource$States$Clear extends StandardParameters { /** * Auth client or API Key for the request */ @@ -498,7 +532,7 @@ export namespace appstate_v1 { */ stateKey?: number; } - export interface Params$Resource$States$Delete { + export interface Params$Resource$States$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -509,7 +543,7 @@ export namespace appstate_v1 { */ stateKey?: number; } - export interface Params$Resource$States$Get { + export interface Params$Resource$States$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -520,7 +554,7 @@ export namespace appstate_v1 { */ stateKey?: number; } - export interface Params$Resource$States$List { + export interface Params$Resource$States$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -531,7 +565,7 @@ export namespace appstate_v1 { */ includeData?: boolean; } - export interface Params$Resource$States$Update { + export interface Params$Resource$States$Update extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/bigquery/v2.ts b/src/apis/bigquery/v2.ts index 218c97aa90..70b1ba80a8 100644 --- a/src/apis/bigquery/v2.ts +++ b/src/apis/bigquery/v2.ts @@ -29,6 +29,40 @@ export namespace bigquery_v2 { version: 'v2'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * BigQuery API * @@ -1002,6 +1036,11 @@ export namespace bigquery_v2 { * set the allowQuotedNewlines property to true. */ quote?: string; + /** + * [Experimental] Range partitioning specification for this table. Only one + * of timePartitioning and rangePartitioning should be specified. + */ + rangePartitioning?: Schema$RangePartitioning; /** * [Optional] The schema for the destination table. The schema can be * omitted if the destination table already exists, or if you're loading @@ -1059,9 +1098,16 @@ export namespace bigquery_v2 { */ sourceUris?: string[]; /** - * Time-based partitioning specification for the destination table. + * Time-based partitioning specification for the destination table. Only one + * of timePartitioning and rangePartitioning should be specified. */ timePartitioning?: Schema$TimePartitioning; + /** + * [Optional] If sourceFormat is set to "AVRO", indicates whether + * to enable interpreting logical types into their corresponding types (ie. + * TIMESTAMP), instead of only using their raw types (ie. INTEGER). + */ + useAvroLogicalTypes?: boolean; /** * [Optional] Specifies the action that occurs if the destination table * already exists. The following values are supported: WRITE_TRUNCATE: If @@ -1160,6 +1206,11 @@ export namespace bigquery_v2 { * Query parameters for standard SQL queries. */ queryParameters?: Schema$QueryParameter[]; + /** + * [Experimental] Range partitioning specification for this table. Only one + * of timePartitioning and rangePartitioning should be specified. + */ + rangePartitioning?: Schema$RangePartitioning; /** * Allows the schema of the destination table to be updated as a side effect * of the query job. Schema update options are supported in two cases: when @@ -1180,7 +1231,8 @@ export namespace bigquery_v2 { */ tableDefinitions?: any; /** - * Time-based partitioning specification for the destination table. + * Time-based partitioning specification for the destination table. Only one + * of timePartitioning and rangePartitioning should be specified. */ timePartitioning?: Schema$TimePartitioning; /** @@ -1283,9 +1335,8 @@ export namespace bigquery_v2 { */ jobId?: string; /** - * 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. + * The geographic location of the job. See details at + * https://cloud.google.com/bigquery/docs/locations#specifying_your_location. */ location?: string; /** @@ -1757,6 +1808,18 @@ export namespace bigquery_v2 { */ totalSlotMs?: string; } + export interface Schema$RangePartitioning { + /** + * [Experimental] [Required] The table is partitioned by this field. The + * field must be a top-level NULLABLE/REQUIRED field. The only supported + * type is INTEGER/INT64. + */ + field?: string; + /** + * [Experimental] [Required] Defines the ranges for range partitioning. + */ + range?: any; + } export interface Schema$Streamingbuffer { /** * [Output-only] A lower-bound estimate of the number of bytes currently in @@ -1777,8 +1840,8 @@ export namespace bigquery_v2 { } export interface Schema$Table { /** - * [Beta] Clustering specification for the table. Must be specified with - * time-based partitioning, data in the table will be first partitioned and + * [Experimental] Clustering specification for the table. Must be specified + * with partitioning, data in the table will be first partitioned and * subsequently clustered. */ clustering?: Schema$Clustering; @@ -1863,11 +1926,28 @@ export namespace bigquery_v2 { * "long-term storage". */ numLongTermBytes?: string; + /** + * [Output-only] [Experimental] The physical size of this table in bytes, + * excluding any data in the streaming buffer. This includes compression and + * storage used for time travel. + */ + numPhysicalBytes?: string; /** * [Output-only] The number of rows of data in this table, excluding any * data in the streaming buffer. */ numRows?: string; + /** + * [Experimental] Range partitioning specification for this table. Only one + * of timePartitioning and rangePartitioning should be specified. + */ + rangePartitioning?: Schema$RangePartitioning; + /** + * [Experimental] [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; /** * [Optional] Describes the schema of this table. */ @@ -1887,7 +1967,8 @@ export namespace bigquery_v2 { */ tableReference?: Schema$TableReference; /** - * Time-based partitioning specification for this table. + * Time-based partitioning specification for this table. Only one of + * timePartitioning and rangePartitioning should be specified. */ timePartitioning?: Schema$TimePartitioning; /** @@ -2912,7 +2993,7 @@ export namespace bigquery_v2 { } } - export interface Params$Resource$Datasets$Delete { + export interface Params$Resource$Datasets$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2932,7 +3013,7 @@ export namespace bigquery_v2 { */ projectId?: string; } - export interface Params$Resource$Datasets$Get { + export interface Params$Resource$Datasets$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2947,7 +3028,7 @@ export namespace bigquery_v2 { */ projectId?: string; } - export interface Params$Resource$Datasets$Insert { + export interface Params$Resource$Datasets$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2963,7 +3044,7 @@ export namespace bigquery_v2 { */ requestBody?: Schema$Dataset; } - export interface Params$Resource$Datasets$List { + export interface Params$Resource$Datasets$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2995,7 +3076,7 @@ export namespace bigquery_v2 { */ projectId?: string; } - export interface Params$Resource$Datasets$Patch { + export interface Params$Resource$Datasets$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3015,7 +3096,7 @@ export namespace bigquery_v2 { */ requestBody?: Schema$Dataset; } - export interface Params$Resource$Datasets$Update { + export interface Params$Resource$Datasets$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3841,7 +3922,7 @@ export namespace bigquery_v2 { } } - export interface Params$Resource$Jobs$Cancel { + export interface Params$Resource$Jobs$Cancel extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3862,7 +3943,7 @@ export namespace bigquery_v2 { */ projectId?: string; } - export interface Params$Resource$Jobs$Get { + export interface Params$Resource$Jobs$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3883,7 +3964,8 @@ export namespace bigquery_v2 { */ projectId?: string; } - export interface Params$Resource$Jobs$Getqueryresults { + export interface Params$Resource$Jobs$Getqueryresults extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3923,7 +4005,7 @@ export namespace bigquery_v2 { */ timeoutMs?: number; } - export interface Params$Resource$Jobs$Insert { + export interface Params$Resource$Jobs$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3954,7 +4036,7 @@ export namespace bigquery_v2 { body?: any; }; } - export interface Params$Resource$Jobs$List { + export interface Params$Resource$Jobs$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3996,7 +4078,7 @@ export namespace bigquery_v2 { */ stateFilter?: string; } - export interface Params$Resource$Jobs$Query { + export interface Params$Resource$Jobs$Query extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4281,7 +4363,8 @@ export namespace bigquery_v2 { } } - export interface Params$Resource$Projects$Getserviceaccount { + export interface Params$Resource$Projects$Getserviceaccount extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4292,7 +4375,7 @@ export namespace bigquery_v2 { */ projectId?: string; } - export interface Params$Resource$Projects$List { + export interface Params$Resource$Projects$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4610,7 +4693,8 @@ export namespace bigquery_v2 { } } - export interface Params$Resource$Tabledata$Insertall { + export interface Params$Resource$Tabledata$Insertall extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4634,7 +4718,7 @@ export namespace bigquery_v2 { */ requestBody?: Schema$TableDataInsertAllRequest; } - export interface Params$Resource$Tabledata$List { + export interface Params$Resource$Tabledata$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5476,7 +5560,7 @@ export namespace bigquery_v2 { } } - export interface Params$Resource$Tables$Delete { + export interface Params$Resource$Tables$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5495,7 +5579,7 @@ export namespace bigquery_v2 { */ tableId?: string; } - export interface Params$Resource$Tables$Get { + export interface Params$Resource$Tables$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5519,7 +5603,7 @@ export namespace bigquery_v2 { */ tableId?: string; } - export interface Params$Resource$Tables$Insert { + export interface Params$Resource$Tables$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5539,7 +5623,7 @@ export namespace bigquery_v2 { */ requestBody?: Schema$Table; } - export interface Params$Resource$Tables$List { + export interface Params$Resource$Tables$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5563,7 +5647,7 @@ export namespace bigquery_v2 { */ projectId?: string; } - export interface Params$Resource$Tables$Patch { + export interface Params$Resource$Tables$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5587,7 +5671,7 @@ export namespace bigquery_v2 { */ requestBody?: Schema$Table; } - export interface Params$Resource$Tables$Update { + export interface Params$Resource$Tables$Update extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/bigquerydatatransfer/v1.ts b/src/apis/bigquerydatatransfer/v1.ts index d905633b90..c08b2a5c7d 100644 --- a/src/apis/bigquerydatatransfer/v1.ts +++ b/src/apis/bigquerydatatransfer/v1.ts @@ -29,6 +29,57 @@ export namespace bigquerydatatransfer_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * BigQuery Data Transfer API * @@ -844,7 +895,8 @@ export namespace bigquerydatatransfer_v1 { } } - export interface Params$Resource$Projects$Datasources$Checkvalidcreds { + export interface Params$Resource$Projects$Datasources$Checkvalidcreds extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -861,7 +913,8 @@ export namespace bigquerydatatransfer_v1 { */ requestBody?: Schema$CheckValidCredsRequest; } - export interface Params$Resource$Projects$Datasources$Get { + export interface Params$Resource$Projects$Datasources$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -873,7 +926,8 @@ export namespace bigquerydatatransfer_v1 { */ name?: string; } - export interface Params$Resource$Projects$Datasources$List { + export interface Params$Resource$Projects$Datasources$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1049,7 +1103,8 @@ export namespace bigquerydatatransfer_v1 { } } - export interface Params$Resource$Projects$Locations$Get { + export interface Params$Resource$Projects$Locations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1060,7 +1115,8 @@ export namespace bigquerydatatransfer_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$List { + export interface Params$Resource$Projects$Locations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1310,7 +1366,8 @@ export namespace bigquerydatatransfer_v1 { } } - export interface Params$Resource$Projects$Locations$Datasources$Checkvalidcreds { + export interface Params$Resource$Projects$Locations$Datasources$Checkvalidcreds + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1327,7 +1384,8 @@ export namespace bigquerydatatransfer_v1 { */ requestBody?: Schema$CheckValidCredsRequest; } - export interface Params$Resource$Projects$Locations$Datasources$Get { + export interface Params$Resource$Projects$Locations$Datasources$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1339,7 +1397,8 @@ export namespace bigquerydatatransfer_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasources$List { + export interface Params$Resource$Projects$Locations$Datasources$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1817,7 +1876,8 @@ export namespace bigquerydatatransfer_v1 { } } - export interface Params$Resource$Projects$Locations$Transferconfigs$Create { + export interface Params$Resource$Projects$Locations$Transferconfigs$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1854,7 +1914,8 @@ export namespace bigquerydatatransfer_v1 { */ requestBody?: Schema$TransferConfig; } - export interface Params$Resource$Projects$Locations$Transferconfigs$Delete { + export interface Params$Resource$Projects$Locations$Transferconfigs$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1866,7 +1927,8 @@ export namespace bigquerydatatransfer_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Transferconfigs$Get { + export interface Params$Resource$Projects$Locations$Transferconfigs$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1878,7 +1940,8 @@ export namespace bigquerydatatransfer_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Transferconfigs$List { + export interface Params$Resource$Projects$Locations$Transferconfigs$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1906,7 +1969,8 @@ export namespace bigquerydatatransfer_v1 { */ parent?: string; } - export interface Params$Resource$Projects$Locations$Transferconfigs$Patch { + export interface Params$Resource$Projects$Locations$Transferconfigs$Patch + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1949,7 +2013,8 @@ export namespace bigquerydatatransfer_v1 { */ requestBody?: Schema$TransferConfig; } - export interface Params$Resource$Projects$Locations$Transferconfigs$Scheduleruns { + export interface Params$Resource$Projects$Locations$Transferconfigs$Scheduleruns + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2192,7 +2257,8 @@ export namespace bigquerydatatransfer_v1 { } } - export interface Params$Resource$Projects$Locations$Transferconfigs$Runs$Delete { + export interface Params$Resource$Projects$Locations$Transferconfigs$Runs$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2204,7 +2270,8 @@ export namespace bigquerydatatransfer_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Transferconfigs$Runs$Get { + export interface Params$Resource$Projects$Locations$Transferconfigs$Runs$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2216,7 +2283,8 @@ export namespace bigquerydatatransfer_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Transferconfigs$Runs$List { + export interface Params$Resource$Projects$Locations$Transferconfigs$Runs$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2339,7 +2407,8 @@ export namespace bigquerydatatransfer_v1 { } } - export interface Params$Resource$Projects$Locations$Transferconfigs$Runs$Transferlogs$List { + export interface Params$Resource$Projects$Locations$Transferconfigs$Runs$Transferlogs$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2813,7 +2882,8 @@ export namespace bigquerydatatransfer_v1 { } } - export interface Params$Resource$Projects$Transferconfigs$Create { + export interface Params$Resource$Projects$Transferconfigs$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2850,7 +2920,8 @@ export namespace bigquerydatatransfer_v1 { */ requestBody?: Schema$TransferConfig; } - export interface Params$Resource$Projects$Transferconfigs$Delete { + export interface Params$Resource$Projects$Transferconfigs$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2862,7 +2933,8 @@ export namespace bigquerydatatransfer_v1 { */ name?: string; } - export interface Params$Resource$Projects$Transferconfigs$Get { + export interface Params$Resource$Projects$Transferconfigs$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2874,7 +2946,8 @@ export namespace bigquerydatatransfer_v1 { */ name?: string; } - export interface Params$Resource$Projects$Transferconfigs$List { + export interface Params$Resource$Projects$Transferconfigs$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2902,7 +2975,8 @@ export namespace bigquerydatatransfer_v1 { */ parent?: string; } - export interface Params$Resource$Projects$Transferconfigs$Patch { + export interface Params$Resource$Projects$Transferconfigs$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2945,7 +3019,8 @@ export namespace bigquerydatatransfer_v1 { */ requestBody?: Schema$TransferConfig; } - export interface Params$Resource$Projects$Transferconfigs$Scheduleruns { + export interface Params$Resource$Projects$Transferconfigs$Scheduleruns extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3180,7 +3255,8 @@ export namespace bigquerydatatransfer_v1 { } } - export interface Params$Resource$Projects$Transferconfigs$Runs$Delete { + export interface Params$Resource$Projects$Transferconfigs$Runs$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3192,7 +3268,8 @@ export namespace bigquerydatatransfer_v1 { */ name?: string; } - export interface Params$Resource$Projects$Transferconfigs$Runs$Get { + export interface Params$Resource$Projects$Transferconfigs$Runs$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3204,7 +3281,8 @@ export namespace bigquerydatatransfer_v1 { */ name?: string; } - export interface Params$Resource$Projects$Transferconfigs$Runs$List { + export interface Params$Resource$Projects$Transferconfigs$Runs$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3325,7 +3403,8 @@ export namespace bigquerydatatransfer_v1 { } } - export interface Params$Resource$Projects$Transferconfigs$Runs$Transferlogs$List { + export interface Params$Resource$Projects$Transferconfigs$Runs$Transferlogs$List + extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/binaryauthorization/v1beta1.ts b/src/apis/binaryauthorization/v1beta1.ts index 68292cdf20..ce0cce55e2 100644 --- a/src/apis/binaryauthorization/v1beta1.ts +++ b/src/apis/binaryauthorization/v1beta1.ts @@ -29,6 +29,57 @@ export namespace binaryauthorization_v1beta1 { version: 'v1beta1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Binary Authorization API * @@ -540,7 +591,8 @@ export namespace binaryauthorization_v1beta1 { } } - export interface Params$Resource$Projects$Getpolicy { + export interface Params$Resource$Projects$Getpolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -552,7 +604,8 @@ export namespace binaryauthorization_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Updatepolicy { + export interface Params$Resource$Projects$Updatepolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1142,7 +1195,8 @@ export namespace binaryauthorization_v1beta1 { } } - export interface Params$Resource$Projects$Attestors$Create { + export interface Params$Resource$Projects$Attestors$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1162,7 +1216,8 @@ export namespace binaryauthorization_v1beta1 { */ requestBody?: Schema$Attestor; } - export interface Params$Resource$Projects$Attestors$Delete { + export interface Params$Resource$Projects$Attestors$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1174,7 +1229,8 @@ export namespace binaryauthorization_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Attestors$Get { + export interface Params$Resource$Projects$Attestors$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1186,7 +1242,8 @@ export namespace binaryauthorization_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Attestors$Getiampolicy { + export interface Params$Resource$Projects$Attestors$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1198,7 +1255,8 @@ export namespace binaryauthorization_v1beta1 { */ resource?: string; } - export interface Params$Resource$Projects$Attestors$List { + export interface Params$Resource$Projects$Attestors$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1221,7 +1279,8 @@ export namespace binaryauthorization_v1beta1 { */ parent?: string; } - export interface Params$Resource$Projects$Attestors$Setiampolicy { + export interface Params$Resource$Projects$Attestors$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1238,7 +1297,8 @@ export namespace binaryauthorization_v1beta1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Attestors$Testiampermissions { + export interface Params$Resource$Projects$Attestors$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1255,7 +1315,8 @@ export namespace binaryauthorization_v1beta1 { */ requestBody?: Schema$TestIamPermissionsRequest; } - export interface Params$Resource$Projects$Attestors$Update { + export interface Params$Resource$Projects$Attestors$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1505,7 +1566,8 @@ export namespace binaryauthorization_v1beta1 { } } - export interface Params$Resource$Projects$Policy$Getiampolicy { + export interface Params$Resource$Projects$Policy$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1517,7 +1579,8 @@ export namespace binaryauthorization_v1beta1 { */ resource?: string; } - export interface Params$Resource$Projects$Policy$Setiampolicy { + export interface Params$Resource$Projects$Policy$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1534,7 +1597,8 @@ export namespace binaryauthorization_v1beta1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Policy$Testiampermissions { + export interface Params$Resource$Projects$Policy$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/blogger/v2.ts b/src/apis/blogger/v2.ts index 6332202710..5afc578c4a 100644 --- a/src/apis/blogger/v2.ts +++ b/src/apis/blogger/v2.ts @@ -29,6 +29,40 @@ export namespace blogger_v2 { version: 'v2'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Blogger API * @@ -422,7 +456,7 @@ export namespace blogger_v2 { } } - export interface Params$Resource$Blogs$Get { + export interface Params$Resource$Blogs$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -583,7 +617,7 @@ export namespace blogger_v2 { } } - export interface Params$Resource$Comments$Get { + export interface Params$Resource$Comments$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -602,7 +636,7 @@ export namespace blogger_v2 { */ postId?: string; } - export interface Params$Resource$Comments$List { + export interface Params$Resource$Comments$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -774,7 +808,7 @@ export namespace blogger_v2 { } } - export interface Params$Resource$Pages$Get { + export interface Params$Resource$Pages$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -789,7 +823,7 @@ export namespace blogger_v2 { */ pageId?: string; } - export interface Params$Resource$Pages$List { + export interface Params$Resource$Pages$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -948,7 +982,7 @@ export namespace blogger_v2 { } } - export interface Params$Resource$Posts$Get { + export interface Params$Resource$Posts$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -963,7 +997,7 @@ export namespace blogger_v2 { */ postId?: string; } - export interface Params$Resource$Posts$List { + export interface Params$Resource$Posts$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1067,7 +1101,7 @@ export namespace blogger_v2 { } } - export interface Params$Resource$Users$Get { + export interface Params$Resource$Users$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1155,7 +1189,7 @@ export namespace blogger_v2 { } } - export interface Params$Resource$Users$Blogs$List { + export interface Params$Resource$Users$Blogs$List extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/blogger/v3.ts b/src/apis/blogger/v3.ts index fdde7eb4b2..9d44195029 100644 --- a/src/apis/blogger/v3.ts +++ b/src/apis/blogger/v3.ts @@ -29,6 +29,40 @@ export namespace blogger_v3 { version: 'v3'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Blogger API * @@ -733,7 +767,7 @@ export namespace blogger_v3 { } } - export interface Params$Resource$Blogs$Get { + export interface Params$Resource$Blogs$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -753,7 +787,7 @@ export namespace blogger_v3 { */ view?: string; } - export interface Params$Resource$Blogs$Getbyurl { + export interface Params$Resource$Blogs$Getbyurl extends StandardParameters { /** * Auth client or API Key for the request */ @@ -769,7 +803,7 @@ export namespace blogger_v3 { */ view?: string; } - export interface Params$Resource$Blogs$Listbyuser { + export interface Params$Resource$Blogs$Listbyuser extends StandardParameters { /** * Auth client or API Key for the request */ @@ -881,7 +915,8 @@ export namespace blogger_v3 { } } - export interface Params$Resource$Bloguserinfos$Get { + export interface Params$Resource$Bloguserinfos$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1404,7 +1439,7 @@ export namespace blogger_v3 { } } - export interface Params$Resource$Comments$Approve { + export interface Params$Resource$Comments$Approve extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1423,7 +1458,7 @@ export namespace blogger_v3 { */ postId?: string; } - export interface Params$Resource$Comments$Delete { + export interface Params$Resource$Comments$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1442,7 +1477,7 @@ export namespace blogger_v3 { */ postId?: string; } - export interface Params$Resource$Comments$Get { + export interface Params$Resource$Comments$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1468,7 +1503,7 @@ export namespace blogger_v3 { */ view?: string; } - export interface Params$Resource$Comments$List { + export interface Params$Resource$Comments$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1512,7 +1547,8 @@ export namespace blogger_v3 { */ view?: string; } - export interface Params$Resource$Comments$Listbyblog { + export interface Params$Resource$Comments$Listbyblog extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1547,7 +1583,8 @@ export namespace blogger_v3 { */ status?: string; } - export interface Params$Resource$Comments$Markasspam { + export interface Params$Resource$Comments$Markasspam extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1566,7 +1603,8 @@ export namespace blogger_v3 { */ postId?: string; } - export interface Params$Resource$Comments$Removecontent { + export interface Params$Resource$Comments$Removecontent extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2130,7 +2168,7 @@ export namespace blogger_v3 { } } - export interface Params$Resource$Pages$Delete { + export interface Params$Resource$Pages$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2145,7 +2183,7 @@ export namespace blogger_v3 { */ pageId?: string; } - export interface Params$Resource$Pages$Get { + export interface Params$Resource$Pages$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2164,7 +2202,7 @@ export namespace blogger_v3 { */ view?: string; } - export interface Params$Resource$Pages$Insert { + export interface Params$Resource$Pages$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2184,7 +2222,7 @@ export namespace blogger_v3 { */ requestBody?: Schema$Page; } - export interface Params$Resource$Pages$List { + export interface Params$Resource$Pages$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2216,7 +2254,7 @@ export namespace blogger_v3 { */ view?: string; } - export interface Params$Resource$Pages$Patch { + export interface Params$Resource$Pages$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2246,7 +2284,7 @@ export namespace blogger_v3 { */ requestBody?: Schema$Page; } - export interface Params$Resource$Pages$Publish { + export interface Params$Resource$Pages$Publish extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2261,7 +2299,7 @@ export namespace blogger_v3 { */ pageId?: string; } - export interface Params$Resource$Pages$Revert { + export interface Params$Resource$Pages$Revert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2276,7 +2314,7 @@ export namespace blogger_v3 { */ pageId?: string; } - export interface Params$Resource$Pages$Update { + export interface Params$Resource$Pages$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2383,7 +2421,7 @@ export namespace blogger_v3 { } } - export interface Params$Resource$Pageviews$Get { + export interface Params$Resource$Pageviews$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3095,7 +3133,7 @@ export namespace blogger_v3 { } } - export interface Params$Resource$Posts$Delete { + export interface Params$Resource$Posts$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3110,7 +3148,7 @@ export namespace blogger_v3 { */ postId?: string; } - export interface Params$Resource$Posts$Get { + export interface Params$Resource$Posts$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3144,7 +3182,7 @@ export namespace blogger_v3 { */ view?: string; } - export interface Params$Resource$Posts$Getbypath { + export interface Params$Resource$Posts$Getbypath extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3168,7 +3206,7 @@ export namespace blogger_v3 { */ view?: string; } - export interface Params$Resource$Posts$Insert { + export interface Params$Resource$Posts$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3198,7 +3236,7 @@ export namespace blogger_v3 { */ requestBody?: Schema$Post; } - export interface Params$Resource$Posts$List { + export interface Params$Resource$Posts$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3252,7 +3290,7 @@ export namespace blogger_v3 { */ view?: string; } - export interface Params$Resource$Posts$Patch { + export interface Params$Resource$Posts$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3296,7 +3334,7 @@ export namespace blogger_v3 { */ requestBody?: Schema$Post; } - export interface Params$Resource$Posts$Publish { + export interface Params$Resource$Posts$Publish extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3318,7 +3356,7 @@ export namespace blogger_v3 { */ publishDate?: string; } - export interface Params$Resource$Posts$Revert { + export interface Params$Resource$Posts$Revert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3333,7 +3371,7 @@ export namespace blogger_v3 { */ postId?: string; } - export interface Params$Resource$Posts$Search { + export interface Params$Resource$Posts$Search extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3358,7 +3396,7 @@ export namespace blogger_v3 { */ q?: string; } - export interface Params$Resource$Posts$Update { + export interface Params$Resource$Posts$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3563,7 +3601,8 @@ export namespace blogger_v3 { } } - export interface Params$Resource$Postuserinfos$Get { + export interface Params$Resource$Postuserinfos$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3587,7 +3626,8 @@ export namespace blogger_v3 { */ userId?: string; } - export interface Params$Resource$Postuserinfos$List { + export interface Params$Resource$Postuserinfos$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3715,7 +3755,7 @@ export namespace blogger_v3 { } } - export interface Params$Resource$Users$Get { + export interface Params$Resource$Users$Get extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/books/v1.ts b/src/apis/books/v1.ts index 78aaec904f..1dd12479ca 100644 --- a/src/apis/books/v1.ts +++ b/src/apis/books/v1.ts @@ -29,6 +29,40 @@ export namespace books_v1 { version: 'v1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Books API * @@ -1027,7 +1061,7 @@ export namespace books_v1 { } } - export interface Params$Resource$Bookshelves$Get { + export interface Params$Resource$Bookshelves$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1046,7 +1080,7 @@ export namespace books_v1 { */ userId?: string; } - export interface Params$Resource$Bookshelves$List { + export interface Params$Resource$Bookshelves$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1146,7 +1180,8 @@ export namespace books_v1 { } } - export interface Params$Resource$Bookshelves$Volumes$List { + export interface Params$Resource$Bookshelves$Volumes$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1399,7 +1434,8 @@ export namespace books_v1 { } } - export interface Params$Resource$Cloudloading$Addbook { + export interface Params$Resource$Cloudloading$Addbook extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1423,7 +1459,8 @@ export namespace books_v1 { */ upload_client_token?: string; } - export interface Params$Resource$Cloudloading$Deletebook { + export interface Params$Resource$Cloudloading$Deletebook extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1434,7 +1471,8 @@ export namespace books_v1 { */ volumeId?: string; } - export interface Params$Resource$Cloudloading$Updatebook { + export interface Params$Resource$Cloudloading$Updatebook extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1526,7 +1564,8 @@ export namespace books_v1 { } } - export interface Params$Resource$Dictionary$Listofflinemetadata { + export interface Params$Resource$Dictionary$Listofflinemetadata extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1754,7 +1793,8 @@ export namespace books_v1 { } } - export interface Params$Resource$Familysharing$Getfamilyinfo { + export interface Params$Resource$Familysharing$Getfamilyinfo extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1765,7 +1805,8 @@ export namespace books_v1 { */ source?: string; } - export interface Params$Resource$Familysharing$Share { + export interface Params$Resource$Familysharing$Share extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1784,7 +1825,8 @@ export namespace books_v1 { */ volumeId?: string; } - export interface Params$Resource$Familysharing$Unshare { + export interface Params$Resource$Familysharing$Unshare extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1956,7 +1998,7 @@ export namespace books_v1 { } } - export interface Params$Resource$Layers$Get { + export interface Params$Resource$Layers$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1979,7 +2021,7 @@ export namespace books_v1 { */ volumeId?: string; } - export interface Params$Resource$Layers$List { + export interface Params$Resource$Layers$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2174,7 +2216,8 @@ export namespace books_v1 { } } - export interface Params$Resource$Layers$Annotationdata$Get { + export interface Params$Resource$Layers$Annotationdata$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2224,7 +2267,8 @@ export namespace books_v1 { */ w?: number; } - export interface Params$Resource$Layers$Annotationdata$List { + export interface Params$Resource$Layers$Annotationdata$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2453,7 +2497,8 @@ export namespace books_v1 { } } - export interface Params$Resource$Layers$Volumeannotations$Get { + export interface Params$Resource$Layers$Volumeannotations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2481,7 +2526,8 @@ export namespace books_v1 { */ volumeId?: string; } - export interface Params$Resource$Layers$Volumeannotations$List { + export interface Params$Resource$Layers$Volumeannotations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2920,13 +2966,15 @@ export namespace books_v1 { } } - export interface Params$Resource$Myconfig$Getusersettings { + export interface Params$Resource$Myconfig$Getusersettings extends + StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; } - export interface Params$Resource$Myconfig$Releasedownloadaccess { + export interface Params$Resource$Myconfig$Releasedownloadaccess extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2949,7 +2997,8 @@ export namespace books_v1 { */ volumeIds?: string; } - export interface Params$Resource$Myconfig$Requestaccess { + export interface Params$Resource$Myconfig$Requestaccess extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2981,7 +3030,8 @@ export namespace books_v1 { */ volumeId?: string; } - export interface Params$Resource$Myconfig$Syncvolumelicenses { + export interface Params$Resource$Myconfig$Syncvolumelicenses extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3020,7 +3070,8 @@ export namespace books_v1 { */ volumeIds?: string; } - export interface Params$Resource$Myconfig$Updateusersettings { + export interface Params$Resource$Myconfig$Updateusersettings extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3415,7 +3466,8 @@ export namespace books_v1 { } } - export interface Params$Resource$Mylibrary$Annotations$Delete { + export interface Params$Resource$Mylibrary$Annotations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3430,7 +3482,8 @@ export namespace books_v1 { */ source?: string; } - export interface Params$Resource$Mylibrary$Annotations$Insert { + export interface Params$Resource$Mylibrary$Annotations$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3459,7 +3512,8 @@ export namespace books_v1 { */ requestBody?: Schema$Annotation; } - export interface Params$Resource$Mylibrary$Annotations$List { + export interface Params$Resource$Mylibrary$Annotations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3509,7 +3563,8 @@ export namespace books_v1 { */ volumeId?: string; } - export interface Params$Resource$Mylibrary$Annotations$Summary { + export interface Params$Resource$Mylibrary$Annotations$Summary extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3524,7 +3579,8 @@ export namespace books_v1 { */ volumeId?: string; } - export interface Params$Resource$Mylibrary$Annotations$Update { + export interface Params$Resource$Mylibrary$Annotations$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3967,7 +4023,8 @@ export namespace books_v1 { } } - export interface Params$Resource$Mylibrary$Bookshelves$Addvolume { + export interface Params$Resource$Mylibrary$Bookshelves$Addvolume extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3990,7 +4047,8 @@ export namespace books_v1 { */ volumeId?: string; } - export interface Params$Resource$Mylibrary$Bookshelves$Clearvolumes { + export interface Params$Resource$Mylibrary$Bookshelves$Clearvolumes extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4005,7 +4063,8 @@ export namespace books_v1 { */ source?: string; } - export interface Params$Resource$Mylibrary$Bookshelves$Get { + export interface Params$Resource$Mylibrary$Bookshelves$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4020,7 +4079,8 @@ export namespace books_v1 { */ source?: string; } - export interface Params$Resource$Mylibrary$Bookshelves$List { + export interface Params$Resource$Mylibrary$Bookshelves$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4031,7 +4091,8 @@ export namespace books_v1 { */ source?: string; } - export interface Params$Resource$Mylibrary$Bookshelves$Movevolume { + export interface Params$Resource$Mylibrary$Bookshelves$Movevolume extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4055,7 +4116,8 @@ export namespace books_v1 { */ volumePosition?: number; } - export interface Params$Resource$Mylibrary$Bookshelves$Removevolume { + export interface Params$Resource$Mylibrary$Bookshelves$Removevolume extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4164,7 +4226,8 @@ export namespace books_v1 { } } - export interface Params$Resource$Mylibrary$Bookshelves$Volumes$List { + export interface Params$Resource$Mylibrary$Bookshelves$Volumes$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4357,7 +4420,8 @@ export namespace books_v1 { } } - export interface Params$Resource$Mylibrary$Readingpositions$Get { + export interface Params$Resource$Mylibrary$Readingpositions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4376,7 +4440,8 @@ export namespace books_v1 { */ volumeId?: string; } - export interface Params$Resource$Mylibrary$Readingpositions$Setposition { + export interface Params$Resource$Mylibrary$Readingpositions$Setposition + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4490,7 +4555,7 @@ export namespace books_v1 { } } - export interface Params$Resource$Notification$Get { + export interface Params$Resource$Notification$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4660,7 +4725,8 @@ export namespace books_v1 { } } - export interface Params$Resource$Onboarding$Listcategories { + export interface Params$Resource$Onboarding$Listcategories extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4672,7 +4738,8 @@ export namespace books_v1 { */ locale?: string; } - export interface Params$Resource$Onboarding$Listcategoryvolumes { + export interface Params$Resource$Onboarding$Listcategoryvolumes extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4780,7 +4847,8 @@ export namespace books_v1 { } } - export interface Params$Resource$Personalizedstream$Get { + export interface Params$Resource$Personalizedstream$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5021,7 +5089,8 @@ export namespace books_v1 { } } - export interface Params$Resource$Promooffer$Accept { + export interface Params$Resource$Promooffer$Accept extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5060,7 +5129,8 @@ export namespace books_v1 { */ volumeId?: string; } - export interface Params$Resource$Promooffer$Dismiss { + export interface Params$Resource$Promooffer$Dismiss extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5095,7 +5165,7 @@ export namespace books_v1 { */ serial?: string; } - export interface Params$Resource$Promooffer$Get { + export interface Params$Resource$Promooffer$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5203,7 +5273,7 @@ export namespace books_v1 { } } - export interface Params$Resource$Series$Get { + export interface Params$Resource$Series$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5292,7 +5362,8 @@ export namespace books_v1 { } } - export interface Params$Resource$Series$Membership$Get { + export interface Params$Resource$Series$Membership$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5478,7 +5549,7 @@ export namespace books_v1 { } } - export interface Params$Resource$Volumes$Get { + export interface Params$Resource$Volumes$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5513,7 +5584,7 @@ export namespace books_v1 { */ volumeId?: string; } - export interface Params$Resource$Volumes$List { + export interface Params$Resource$Volumes$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5660,7 +5731,8 @@ export namespace books_v1 { } } - export interface Params$Resource$Volumes$Associated$List { + export interface Params$Resource$Volumes$Associated$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5775,7 +5847,8 @@ export namespace books_v1 { } } - export interface Params$Resource$Volumes$Mybooks$List { + export interface Params$Resource$Volumes$Mybooks$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5975,7 +6048,8 @@ export namespace books_v1 { } } - export interface Params$Resource$Volumes$Recommended$List { + export interface Params$Resource$Volumes$Recommended$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5996,7 +6070,8 @@ export namespace books_v1 { */ source?: string; } - export interface Params$Resource$Volumes$Recommended$Rate { + export interface Params$Resource$Volumes$Recommended$Rate extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6105,7 +6180,8 @@ export namespace books_v1 { } } - export interface Params$Resource$Volumes$Useruploaded$List { + export interface Params$Resource$Volumes$Useruploaded$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/calendar/v3.ts b/src/apis/calendar/v3.ts index 3ec4c25a74..9bce6976c1 100644 --- a/src/apis/calendar/v3.ts +++ b/src/apis/calendar/v3.ts @@ -29,6 +29,40 @@ export namespace calendar_v3 { version: 'v3'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Calendar API * @@ -1665,7 +1699,7 @@ export namespace calendar_v3 { } } - export interface Params$Resource$Acl$Delete { + export interface Params$Resource$Acl$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1682,7 +1716,7 @@ export namespace calendar_v3 { */ ruleId?: string; } - export interface Params$Resource$Acl$Get { + export interface Params$Resource$Acl$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1699,7 +1733,7 @@ export namespace calendar_v3 { */ ruleId?: string; } - export interface Params$Resource$Acl$Insert { + export interface Params$Resource$Acl$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1722,7 +1756,7 @@ export namespace calendar_v3 { */ requestBody?: Schema$AclRule; } - export interface Params$Resource$Acl$List { + export interface Params$Resource$Acl$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1763,7 +1797,7 @@ export namespace calendar_v3 { */ syncToken?: string; } - export interface Params$Resource$Acl$Patch { + export interface Params$Resource$Acl$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1791,7 +1825,7 @@ export namespace calendar_v3 { */ requestBody?: Schema$AclRule; } - export interface Params$Resource$Acl$Update { + export interface Params$Resource$Acl$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1819,7 +1853,7 @@ export namespace calendar_v3 { */ requestBody?: Schema$AclRule; } - export interface Params$Resource$Acl$Watch { + export interface Params$Resource$Acl$Watch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2354,7 +2388,8 @@ export namespace calendar_v3 { } } - export interface Params$Resource$Calendarlist$Delete { + export interface Params$Resource$Calendarlist$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2367,7 +2402,7 @@ export namespace calendar_v3 { */ calendarId?: string; } - export interface Params$Resource$Calendarlist$Get { + export interface Params$Resource$Calendarlist$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2380,7 +2415,8 @@ export namespace calendar_v3 { */ calendarId?: string; } - export interface Params$Resource$Calendarlist$Insert { + export interface Params$Resource$Calendarlist$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2399,7 +2435,8 @@ export namespace calendar_v3 { */ requestBody?: Schema$CalendarListEntry; } - export interface Params$Resource$Calendarlist$List { + export interface Params$Resource$Calendarlist$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2446,7 +2483,8 @@ export namespace calendar_v3 { */ syncToken?: string; } - export interface Params$Resource$Calendarlist$Patch { + export interface Params$Resource$Calendarlist$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2471,7 +2509,8 @@ export namespace calendar_v3 { */ requestBody?: Schema$CalendarListEntry; } - export interface Params$Resource$Calendarlist$Update { + export interface Params$Resource$Calendarlist$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2496,7 +2535,8 @@ export namespace calendar_v3 { */ requestBody?: Schema$CalendarListEntry; } - export interface Params$Resource$Calendarlist$Watch { + export interface Params$Resource$Calendarlist$Watch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2946,7 +2986,7 @@ export namespace calendar_v3 { } } - export interface Params$Resource$Calendars$Clear { + export interface Params$Resource$Calendars$Clear extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2959,7 +2999,7 @@ export namespace calendar_v3 { */ calendarId?: string; } - export interface Params$Resource$Calendars$Delete { + export interface Params$Resource$Calendars$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2972,7 +3012,7 @@ export namespace calendar_v3 { */ calendarId?: string; } - export interface Params$Resource$Calendars$Get { + export interface Params$Resource$Calendars$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2985,7 +3025,7 @@ export namespace calendar_v3 { */ calendarId?: string; } - export interface Params$Resource$Calendars$Insert { + export interface Params$Resource$Calendars$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2997,7 +3037,7 @@ export namespace calendar_v3 { */ requestBody?: Schema$Calendar; } - export interface Params$Resource$Calendars$Patch { + export interface Params$Resource$Calendars$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3015,7 +3055,7 @@ export namespace calendar_v3 { */ requestBody?: Schema$Calendar; } - export interface Params$Resource$Calendars$Update { + export interface Params$Resource$Calendars$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3110,7 +3150,7 @@ export namespace calendar_v3 { } } - export interface Params$Resource$Channels$Stop { + export interface Params$Resource$Channels$Stop extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3196,7 +3236,7 @@ export namespace calendar_v3 { } } - export interface Params$Resource$Colors$Get { + export interface Params$Resource$Colors$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3983,7 +4023,7 @@ import(paramsOrCallback?: Params$Resource$Events$Import|BodyResponseCallback; + getIamPolicy( + params: Params$Resource$Projects$Locations$Functions$Getiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Functions$Getiampolicy, + callback: BodyResponseCallback): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + Params$Resource$Projects$Locations$Functions$Getiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Functions$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Functions$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudfunctions.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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); + } + } + + /** * cloudfunctions.projects.locations.functions.list * @desc Returns a list of functions that belong to the requested project. @@ -1456,9 +1796,164 @@ export namespace cloudfunctions_v1 { return createAPIRequest(parameters); } } + + + /** + * cloudfunctions.projects.locations.functions.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces + * any existing policy. + * @alias cloudfunctions.projects.locations.functions.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$Locations$Functions$Setiampolicy, + options?: MethodOptions): AxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Functions$Setiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Functions$Setiampolicy, + callback: BodyResponseCallback): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + Params$Resource$Projects$Locations$Functions$Setiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Functions$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Functions$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudfunctions.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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); + } + } + + + /** + * cloudfunctions.projects.locations.functions.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 cloudfunctions.projects.locations.functions.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$Locations$Functions$Testiampermissions, + options?: MethodOptions): + AxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Functions$Testiampermissions, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Functions$Testiampermissions, + callback: BodyResponseCallback): + void; + testIamPermissions( + callback: BodyResponseCallback): + void; + testIamPermissions( + paramsOrCallback?: + Params$Resource$Projects$Locations$Functions$Testiampermissions| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Functions$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Functions$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudfunctions.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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$Locations$Functions$Call { + export interface Params$Resource$Projects$Locations$Functions$Call extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1474,7 +1969,8 @@ export namespace cloudfunctions_v1 { */ requestBody?: Schema$CallFunctionRequest; } - export interface Params$Resource$Projects$Locations$Functions$Create { + export interface Params$Resource$Projects$Locations$Functions$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1491,7 +1987,8 @@ export namespace cloudfunctions_v1 { */ requestBody?: Schema$CloudFunction; } - export interface Params$Resource$Projects$Locations$Functions$Delete { + export interface Params$Resource$Projects$Locations$Functions$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1502,7 +1999,8 @@ export namespace cloudfunctions_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Functions$Generatedownloadurl { + export interface Params$Resource$Projects$Locations$Functions$Generatedownloadurl + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1519,7 +2017,8 @@ export namespace cloudfunctions_v1 { */ requestBody?: Schema$GenerateDownloadUrlRequest; } - export interface Params$Resource$Projects$Locations$Functions$Generateuploadurl { + export interface Params$Resource$Projects$Locations$Functions$Generateuploadurl + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1536,7 +2035,8 @@ export namespace cloudfunctions_v1 { */ requestBody?: Schema$GenerateUploadUrlRequest; } - export interface Params$Resource$Projects$Locations$Functions$Get { + export interface Params$Resource$Projects$Locations$Functions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1547,7 +2047,21 @@ export namespace cloudfunctions_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Functions$List { + export interface Params$Resource$Projects$Locations$Functions$Getiampolicy + extends StandardParameters { + /** + * 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$Locations$Functions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1570,7 +2084,8 @@ export namespace cloudfunctions_v1 { */ parent?: string; } - export interface Params$Resource$Projects$Locations$Functions$Patch { + export interface Params$Resource$Projects$Locations$Functions$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1591,4 +2106,40 @@ export namespace cloudfunctions_v1 { */ requestBody?: Schema$CloudFunction; } + export interface Params$Resource$Projects$Locations$Functions$Setiampolicy + extends StandardParameters { + /** + * 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$Locations$Functions$Testiampermissions + extends StandardParameters { + /** + * 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/cloudfunctions/v1beta2.ts b/src/apis/cloudfunctions/v1beta2.ts index e463e9ec17..f83c8c64d3 100644 --- a/src/apis/cloudfunctions/v1beta2.ts +++ b/src/apis/cloudfunctions/v1beta2.ts @@ -29,6 +29,57 @@ export namespace cloudfunctions_v1beta2 { version: 'v1beta2'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Functions API * @@ -154,7 +205,8 @@ export namespace cloudfunctions_v1beta2 { * organization. The format of this field is either * `projects/{project}/global/networks/{network}` or `{network}`, where * {project} is a project id where the network is defined, and {network} is - * the short name of the network. See [the VPC + * the short name of the network. This field is mutually exclusive with + * `vpc_connector` and will be replaced by it. See [the VPC * documentation](https://cloud.google.com/compute/docs/vpc) for more * information on connecting Cloud projects. This feature is currently in * alpha, available only for whitelisted users. @@ -215,6 +267,17 @@ export namespace cloudfunctions_v1beta2 { * deployment attempt results in a new version of a function being created. */ versionId?: string; + /** + * The VPC Network Connector that this cloud function can connect to. It can + * be either the fully-qualified URI, or the short name of the network + * connector resource. The format of this field is + * `projects/x/locations/x/connectors/x This field is mutually exclusive + * with `network` field and will eventually replace it. See [the VPC + * documentation](https://cloud.google.com/compute/docs/vpc) for more + * information on connecting Cloud projects. This feature is currently in + * alpha, available only for whitelisted users. + */ + vpcConnector?: string; } /** * Describes EventTrigger, used to request events be sent from another @@ -725,7 +788,7 @@ export namespace cloudfunctions_v1beta2 { } } - export interface Params$Resource$Operations$Get { + export interface Params$Resource$Operations$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -736,7 +799,7 @@ export namespace cloudfunctions_v1beta2 { */ name?: string; } - export interface Params$Resource$Operations$List { + export interface Params$Resource$Operations$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -862,7 +925,8 @@ export namespace cloudfunctions_v1beta2 { } } - export interface Params$Resource$Projects$Locations$List { + export interface Params$Resource$Projects$Locations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1480,7 +1544,8 @@ export namespace cloudfunctions_v1beta2 { } } - export interface Params$Resource$Projects$Locations$Functions$Call { + export interface Params$Resource$Projects$Locations$Functions$Call extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1496,7 +1561,8 @@ export namespace cloudfunctions_v1beta2 { */ requestBody?: Schema$CallFunctionRequest; } - export interface Params$Resource$Projects$Locations$Functions$Create { + export interface Params$Resource$Projects$Locations$Functions$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1513,7 +1579,8 @@ export namespace cloudfunctions_v1beta2 { */ requestBody?: Schema$CloudFunction; } - export interface Params$Resource$Projects$Locations$Functions$Delete { + export interface Params$Resource$Projects$Locations$Functions$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1524,7 +1591,8 @@ export namespace cloudfunctions_v1beta2 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Functions$Generatedownloadurl { + export interface Params$Resource$Projects$Locations$Functions$Generatedownloadurl + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1541,7 +1609,8 @@ export namespace cloudfunctions_v1beta2 { */ requestBody?: Schema$GenerateDownloadUrlRequest; } - export interface Params$Resource$Projects$Locations$Functions$Generateuploadurl { + export interface Params$Resource$Projects$Locations$Functions$Generateuploadurl + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1558,7 +1627,8 @@ export namespace cloudfunctions_v1beta2 { */ requestBody?: Schema$GenerateUploadUrlRequest; } - export interface Params$Resource$Projects$Locations$Functions$Get { + export interface Params$Resource$Projects$Locations$Functions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1569,7 +1639,8 @@ export namespace cloudfunctions_v1beta2 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Functions$List { + export interface Params$Resource$Projects$Locations$Functions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1592,7 +1663,8 @@ export namespace cloudfunctions_v1beta2 { */ pageToken?: string; } - export interface Params$Resource$Projects$Locations$Functions$Update { + export interface Params$Resource$Projects$Locations$Functions$Update extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/cloudiot/v1.ts b/src/apis/cloudiot/v1.ts index 3747600b15..1717f89964 100644 --- a/src/apis/cloudiot/v1.ts +++ b/src/apis/cloudiot/v1.ts @@ -29,6 +29,57 @@ export namespace cloudiot_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud IoT API * @@ -1326,7 +1377,8 @@ export namespace cloudiot_v1 { } } - export interface Params$Resource$Projects$Locations$Registries$Create { + export interface Params$Resource$Projects$Locations$Registries$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1343,7 +1395,8 @@ export namespace cloudiot_v1 { */ requestBody?: Schema$DeviceRegistry; } - export interface Params$Resource$Projects$Locations$Registries$Delete { + export interface Params$Resource$Projects$Locations$Registries$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1355,7 +1408,8 @@ export namespace cloudiot_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Registries$Get { + export interface Params$Resource$Projects$Locations$Registries$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1367,7 +1421,8 @@ export namespace cloudiot_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Registries$Getiampolicy { + export interface Params$Resource$Projects$Locations$Registries$Getiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1384,7 +1439,8 @@ export namespace cloudiot_v1 { */ requestBody?: Schema$GetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Registries$List { + export interface Params$Resource$Projects$Locations$Registries$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1409,7 +1465,8 @@ export namespace cloudiot_v1 { */ parent?: string; } - export interface Params$Resource$Projects$Locations$Registries$Patch { + export interface Params$Resource$Projects$Locations$Registries$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1434,7 +1491,8 @@ export namespace cloudiot_v1 { */ requestBody?: Schema$DeviceRegistry; } - export interface Params$Resource$Projects$Locations$Registries$Setiampolicy { + export interface Params$Resource$Projects$Locations$Registries$Setiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1451,7 +1509,8 @@ export namespace cloudiot_v1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Registries$Testiampermissions { + export interface Params$Resource$Projects$Locations$Registries$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2001,7 +2060,8 @@ export namespace cloudiot_v1 { } } - export interface Params$Resource$Projects$Locations$Registries$Devices$Create { + export interface Params$Resource$Projects$Locations$Registries$Devices$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2019,7 +2079,8 @@ export namespace cloudiot_v1 { */ requestBody?: Schema$Device; } - export interface Params$Resource$Projects$Locations$Registries$Devices$Delete { + export interface Params$Resource$Projects$Locations$Registries$Devices$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2033,7 +2094,8 @@ export namespace cloudiot_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Registries$Devices$Get { + export interface Params$Resource$Projects$Locations$Registries$Devices$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2052,7 +2114,8 @@ export namespace cloudiot_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Registries$Devices$List { + export interface Params$Resource$Projects$Locations$Registries$Devices$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2093,7 +2156,8 @@ export namespace cloudiot_v1 { */ parent?: string; } - export interface Params$Resource$Projects$Locations$Registries$Devices$Modifycloudtodeviceconfig { + export interface Params$Resource$Projects$Locations$Registries$Devices$Modifycloudtodeviceconfig + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2112,7 +2176,8 @@ export namespace cloudiot_v1 { */ requestBody?: Schema$ModifyCloudToDeviceConfigRequest; } - export interface Params$Resource$Projects$Locations$Registries$Devices$Patch { + export interface Params$Resource$Projects$Locations$Registries$Devices$Patch + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2139,7 +2204,8 @@ export namespace cloudiot_v1 { */ requestBody?: Schema$Device; } - export interface Params$Resource$Projects$Locations$Registries$Devices$Sendcommandtodevice { + export interface Params$Resource$Projects$Locations$Registries$Devices$Sendcommandtodevice + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2256,7 +2322,8 @@ export namespace cloudiot_v1 { } } - export interface Params$Resource$Projects$Locations$Registries$Devices$Configversions$List { + export interface Params$Resource$Projects$Locations$Registries$Devices$Configversions$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2365,7 +2432,8 @@ export namespace cloudiot_v1 { } } - export interface Params$Resource$Projects$Locations$Registries$Devices$States$List { + export interface Params$Resource$Projects$Locations$Registries$Devices$States$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2631,7 +2699,8 @@ export namespace cloudiot_v1 { } } - export interface Params$Resource$Projects$Locations$Registries$Groups$Getiampolicy { + export interface Params$Resource$Projects$Locations$Registries$Groups$Getiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2648,7 +2717,8 @@ export namespace cloudiot_v1 { */ requestBody?: Schema$GetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Registries$Groups$Setiampolicy { + export interface Params$Resource$Projects$Locations$Registries$Groups$Setiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2665,7 +2735,8 @@ export namespace cloudiot_v1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Registries$Groups$Testiampermissions { + export interface Params$Resource$Projects$Locations$Registries$Groups$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3090,7 +3161,8 @@ export namespace cloudiot_v1 { } } - export interface Params$Resource$Projects$Locations$Registries$Groups$Devices$Get { + export interface Params$Resource$Projects$Locations$Registries$Groups$Devices$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3109,7 +3181,8 @@ export namespace cloudiot_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Registries$Groups$Devices$List { + export interface Params$Resource$Projects$Locations$Registries$Groups$Devices$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3150,7 +3223,8 @@ export namespace cloudiot_v1 { */ parent?: string; } - export interface Params$Resource$Projects$Locations$Registries$Groups$Devices$Modifycloudtodeviceconfig { + export interface Params$Resource$Projects$Locations$Registries$Groups$Devices$Modifycloudtodeviceconfig + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3169,7 +3243,8 @@ export namespace cloudiot_v1 { */ requestBody?: Schema$ModifyCloudToDeviceConfigRequest; } - export interface Params$Resource$Projects$Locations$Registries$Groups$Devices$Patch { + export interface Params$Resource$Projects$Locations$Registries$Groups$Devices$Patch + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3196,7 +3271,8 @@ export namespace cloudiot_v1 { */ requestBody?: Schema$Device; } - export interface Params$Resource$Projects$Locations$Registries$Groups$Devices$Sendcommandtodevice { + export interface Params$Resource$Projects$Locations$Registries$Groups$Devices$Sendcommandtodevice + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3315,7 +3391,8 @@ export namespace cloudiot_v1 { } } - export interface Params$Resource$Projects$Locations$Registries$Groups$Devices$Configversions$List { + export interface Params$Resource$Projects$Locations$Registries$Groups$Devices$Configversions$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3424,7 +3501,8 @@ export namespace cloudiot_v1 { } } - export interface Params$Resource$Projects$Locations$Registries$Groups$Devices$States$List { + export interface Params$Resource$Projects$Locations$Registries$Groups$Devices$States$List + extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/cloudkms/v1.ts b/src/apis/cloudkms/v1.ts index 01417e14f1..8482412513 100644 --- a/src/apis/cloudkms/v1.ts +++ b/src/apis/cloudkms/v1.ts @@ -29,6 +29,57 @@ export namespace cloudkms_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Key Management Service (KMS) API * @@ -847,7 +898,8 @@ export namespace cloudkms_v1 { } } - export interface Params$Resource$Projects$Locations$Get { + export interface Params$Resource$Projects$Locations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -858,7 +910,8 @@ export namespace cloudkms_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$List { + export interface Params$Resource$Projects$Locations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1314,7 +1367,8 @@ export namespace cloudkms_v1 { } } - export interface Params$Resource$Projects$Locations$Keyrings$Create { + export interface Params$Resource$Projects$Locations$Keyrings$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1336,7 +1390,8 @@ export namespace cloudkms_v1 { */ requestBody?: Schema$KeyRing; } - export interface Params$Resource$Projects$Locations$Keyrings$Get { + export interface Params$Resource$Projects$Locations$Keyrings$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1347,7 +1402,8 @@ export namespace cloudkms_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Keyrings$Getiampolicy { + export interface Params$Resource$Projects$Locations$Keyrings$Getiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1359,7 +1415,8 @@ export namespace cloudkms_v1 { */ resource?: string; } - export interface Params$Resource$Projects$Locations$Keyrings$List { + export interface Params$Resource$Projects$Locations$Keyrings$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1383,7 +1440,8 @@ export namespace cloudkms_v1 { */ parent?: string; } - export interface Params$Resource$Projects$Locations$Keyrings$Setiampolicy { + export interface Params$Resource$Projects$Locations$Keyrings$Setiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1400,7 +1458,8 @@ export namespace cloudkms_v1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Keyrings$Testiampermissions { + export interface Params$Resource$Projects$Locations$Keyrings$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2162,7 +2221,8 @@ export namespace cloudkms_v1 { } } - export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Create { + export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2183,7 +2243,8 @@ export namespace cloudkms_v1 { */ requestBody?: Schema$CryptoKey; } - export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Decrypt { + export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Decrypt + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2200,7 +2261,8 @@ export namespace cloudkms_v1 { */ requestBody?: Schema$DecryptRequest; } - export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Encrypt { + export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Encrypt + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2218,7 +2280,8 @@ export namespace cloudkms_v1 { */ requestBody?: Schema$EncryptRequest; } - export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Get { + export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2229,7 +2292,8 @@ export namespace cloudkms_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Getiampolicy { + export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Getiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2241,7 +2305,8 @@ export namespace cloudkms_v1 { */ resource?: string; } - export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$List { + export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2269,7 +2334,8 @@ export namespace cloudkms_v1 { */ versionView?: string; } - export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Patch { + export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Patch + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2290,7 +2356,8 @@ export namespace cloudkms_v1 { */ requestBody?: Schema$CryptoKey; } - export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Setiampolicy { + export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Setiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2307,7 +2374,8 @@ export namespace cloudkms_v1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Testiampermissions { + export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2324,7 +2392,8 @@ export namespace cloudkms_v1 { */ requestBody?: Schema$TestIamPermissionsRequest; } - export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Updateprimaryversion { + export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Updateprimaryversion + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3043,7 +3112,8 @@ export namespace cloudkms_v1 { } } - export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Cryptokeyversions$Asymmetricdecrypt { + export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Cryptokeyversions$Asymmetricdecrypt + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3060,7 +3130,8 @@ export namespace cloudkms_v1 { */ requestBody?: Schema$AsymmetricDecryptRequest; } - export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Cryptokeyversions$Asymmetricsign { + export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Cryptokeyversions$Asymmetricsign + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3076,7 +3147,8 @@ export namespace cloudkms_v1 { */ requestBody?: Schema$AsymmetricSignRequest; } - export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Cryptokeyversions$Create { + export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Cryptokeyversions$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3093,7 +3165,8 @@ export namespace cloudkms_v1 { */ requestBody?: Schema$CryptoKeyVersion; } - export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Cryptokeyversions$Destroy { + export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Cryptokeyversions$Destroy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3109,7 +3182,8 @@ export namespace cloudkms_v1 { */ requestBody?: Schema$DestroyCryptoKeyVersionRequest; } - export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Cryptokeyversions$Get { + export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Cryptokeyversions$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3120,7 +3194,8 @@ export namespace cloudkms_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Cryptokeyversions$Getpublickey { + export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Cryptokeyversions$Getpublickey + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3131,7 +3206,8 @@ export namespace cloudkms_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Cryptokeyversions$List { + export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Cryptokeyversions$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3160,7 +3236,8 @@ export namespace cloudkms_v1 { */ view?: string; } - export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Cryptokeyversions$Patch { + export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Cryptokeyversions$Patch + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3181,7 +3258,8 @@ export namespace cloudkms_v1 { */ requestBody?: Schema$CryptoKeyVersion; } - export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Cryptokeyversions$Restore { + export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Cryptokeyversions$Restore + extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/cloudprofiler/v2.ts b/src/apis/cloudprofiler/v2.ts index 1d93e665e3..018d2a4276 100644 --- a/src/apis/cloudprofiler/v2.ts +++ b/src/apis/cloudprofiler/v2.ts @@ -29,6 +29,57 @@ export namespace cloudprofiler_v2 { version: 'v2'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Stackdriver Profiler API * @@ -398,7 +449,8 @@ export namespace cloudprofiler_v2 { } } - export interface Params$Resource$Projects$Profiles$Create { + export interface Params$Resource$Projects$Profiles$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -414,7 +466,8 @@ export namespace cloudprofiler_v2 { */ requestBody?: Schema$CreateProfileRequest; } - export interface Params$Resource$Projects$Profiles$Createoffline { + export interface Params$Resource$Projects$Profiles$Createoffline extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -430,7 +483,8 @@ export namespace cloudprofiler_v2 { */ requestBody?: Schema$Profile; } - export interface Params$Resource$Projects$Profiles$Patch { + export interface Params$Resource$Projects$Profiles$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/cloudresourcemanager/README.md b/src/apis/cloudresourcemanager/README.md index eede155b50..da9a531fac 100644 --- a/src/apis/cloudresourcemanager/README.md +++ b/src/apis/cloudresourcemanager/README.md @@ -2,7 +2,7 @@ # @google/cloudresourcemanager -> The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata. +> Creates, reads, and updates metadata for Google Cloud Platform resource containers. ## Installation diff --git a/src/apis/cloudresourcemanager/v1.ts b/src/apis/cloudresourcemanager/v1.ts index 5d286500e1..595b758fe0 100644 --- a/src/apis/cloudresourcemanager/v1.ts +++ b/src/apis/cloudresourcemanager/v1.ts @@ -29,11 +29,62 @@ export namespace cloudresourcemanager_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Resource Manager API * - * The Google Cloud Resource Manager API provides methods for creating, - * reading, and updating project metadata. + * Creates, reads, and updates metadata for Google Cloud Platform resource + * containers. * * @example * const {google} = require('googleapis'); @@ -848,11 +899,12 @@ export namespace cloudresourcemanager_v1 { * and 63 characters long and must conform to the following regular * expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be * between 0 and 63 characters long and must conform to the regular - * expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 256 labels - * can be associated with a given resource. Clients should store labels in - * a representation such as JSON that does not depend on specific characters - * being disallowed. Example: <code>"environment" : - * "dev"</code> Read-write. + * expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label value can be + * empty. No more than 256 labels can be associated with a given resource. + * Clients should store labels in a representation such as JSON that does + * not depend on specific characters being disallowed. Example: + * <code>"environment" : "dev"</code> + * Read-write. */ labels?: any; /** @@ -1908,7 +1960,8 @@ export namespace cloudresourcemanager_v1 { } } - export interface Params$Resource$Folders$Clearorgpolicy { + export interface Params$Resource$Folders$Clearorgpolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1924,7 +1977,8 @@ export namespace cloudresourcemanager_v1 { */ requestBody?: Schema$ClearOrgPolicyRequest; } - export interface Params$Resource$Folders$Geteffectiveorgpolicy { + export interface Params$Resource$Folders$Geteffectiveorgpolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1940,7 +1994,8 @@ export namespace cloudresourcemanager_v1 { */ requestBody?: Schema$GetEffectiveOrgPolicyRequest; } - export interface Params$Resource$Folders$Getorgpolicy { + export interface Params$Resource$Folders$Getorgpolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1956,7 +2011,8 @@ export namespace cloudresourcemanager_v1 { */ requestBody?: Schema$GetOrgPolicyRequest; } - export interface Params$Resource$Folders$Listavailableorgpolicyconstraints { + export interface Params$Resource$Folders$Listavailableorgpolicyconstraints + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1972,7 +2028,8 @@ export namespace cloudresourcemanager_v1 { */ requestBody?: Schema$ListAvailableOrgPolicyConstraintsRequest; } - export interface Params$Resource$Folders$Listorgpolicies { + export interface Params$Resource$Folders$Listorgpolicies extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1988,7 +2045,8 @@ export namespace cloudresourcemanager_v1 { */ requestBody?: Schema$ListOrgPoliciesRequest; } - export interface Params$Resource$Folders$Setorgpolicy { + export interface Params$Resource$Folders$Setorgpolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2454,7 +2512,7 @@ export namespace cloudresourcemanager_v1 { } } - export interface Params$Resource$Liens$Create { + export interface Params$Resource$Liens$Create extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2466,7 +2524,7 @@ export namespace cloudresourcemanager_v1 { */ requestBody?: Schema$Lien; } - export interface Params$Resource$Liens$Delete { + export interface Params$Resource$Liens$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2477,7 +2535,7 @@ export namespace cloudresourcemanager_v1 { */ name?: string; } - export interface Params$Resource$Liens$Get { + export interface Params$Resource$Liens$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2488,7 +2546,7 @@ export namespace cloudresourcemanager_v1 { */ name?: string; } - export interface Params$Resource$Liens$List { + export interface Params$Resource$Liens$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2641,7 +2699,7 @@ export namespace cloudresourcemanager_v1 { } } - export interface Params$Resource$Operations$Get { + export interface Params$Resource$Operations$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4134,7 +4192,8 @@ export namespace cloudresourcemanager_v1 { } } - export interface Params$Resource$Organizations$Clearorgpolicy { + export interface Params$Resource$Organizations$Clearorgpolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4150,7 +4209,8 @@ export namespace cloudresourcemanager_v1 { */ requestBody?: Schema$ClearOrgPolicyRequest; } - export interface Params$Resource$Organizations$Get { + export interface Params$Resource$Organizations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4162,7 +4222,8 @@ export namespace cloudresourcemanager_v1 { */ name?: string; } - export interface Params$Resource$Organizations$Geteffectiveorgpolicy { + export interface Params$Resource$Organizations$Geteffectiveorgpolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4178,7 +4239,8 @@ export namespace cloudresourcemanager_v1 { */ requestBody?: Schema$GetEffectiveOrgPolicyRequest; } - export interface Params$Resource$Organizations$Getiampolicy { + export interface Params$Resource$Organizations$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4195,7 +4257,8 @@ export namespace cloudresourcemanager_v1 { */ requestBody?: Schema$GetIamPolicyRequest; } - export interface Params$Resource$Organizations$Getorgpolicy { + export interface Params$Resource$Organizations$Getorgpolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4211,7 +4274,8 @@ export namespace cloudresourcemanager_v1 { */ requestBody?: Schema$GetOrgPolicyRequest; } - export interface Params$Resource$Organizations$Listavailableorgpolicyconstraints { + export interface Params$Resource$Organizations$Listavailableorgpolicyconstraints + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4227,7 +4291,8 @@ export namespace cloudresourcemanager_v1 { */ requestBody?: Schema$ListAvailableOrgPolicyConstraintsRequest; } - export interface Params$Resource$Organizations$Listorgpolicies { + export interface Params$Resource$Organizations$Listorgpolicies extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4243,7 +4308,8 @@ export namespace cloudresourcemanager_v1 { */ requestBody?: Schema$ListOrgPoliciesRequest; } - export interface Params$Resource$Organizations$Search { + export interface Params$Resource$Organizations$Search extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4255,7 +4321,8 @@ export namespace cloudresourcemanager_v1 { */ requestBody?: Schema$SearchOrganizationsRequest; } - export interface Params$Resource$Organizations$Setiampolicy { + export interface Params$Resource$Organizations$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4272,7 +4339,8 @@ export namespace cloudresourcemanager_v1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Organizations$Setorgpolicy { + export interface Params$Resource$Organizations$Setorgpolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4288,7 +4356,8 @@ export namespace cloudresourcemanager_v1 { */ requestBody?: Schema$SetOrgPolicyRequest; } - export interface Params$Resource$Organizations$Testiampermissions { + export interface Params$Resource$Organizations$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6432,7 +6501,8 @@ export namespace cloudresourcemanager_v1 { } } - export interface Params$Resource$Projects$Clearorgpolicy { + export interface Params$Resource$Projects$Clearorgpolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6448,7 +6518,7 @@ export namespace cloudresourcemanager_v1 { */ requestBody?: Schema$ClearOrgPolicyRequest; } - export interface Params$Resource$Projects$Create { + export interface Params$Resource$Projects$Create extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6460,7 +6530,7 @@ export namespace cloudresourcemanager_v1 { */ requestBody?: Schema$Project; } - export interface Params$Resource$Projects$Delete { + export interface Params$Resource$Projects$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6471,7 +6541,7 @@ export namespace cloudresourcemanager_v1 { */ projectId?: string; } - export interface Params$Resource$Projects$Get { + export interface Params$Resource$Projects$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6482,7 +6552,8 @@ export namespace cloudresourcemanager_v1 { */ projectId?: string; } - export interface Params$Resource$Projects$Getancestry { + export interface Params$Resource$Projects$Getancestry extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6498,7 +6569,8 @@ export namespace cloudresourcemanager_v1 { */ requestBody?: Schema$GetAncestryRequest; } - export interface Params$Resource$Projects$Geteffectiveorgpolicy { + export interface Params$Resource$Projects$Geteffectiveorgpolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6514,7 +6586,8 @@ export namespace cloudresourcemanager_v1 { */ requestBody?: Schema$GetEffectiveOrgPolicyRequest; } - export interface Params$Resource$Projects$Getiampolicy { + export interface Params$Resource$Projects$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6531,7 +6604,8 @@ export namespace cloudresourcemanager_v1 { */ requestBody?: Schema$GetIamPolicyRequest; } - export interface Params$Resource$Projects$Getorgpolicy { + export interface Params$Resource$Projects$Getorgpolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6547,7 +6621,7 @@ export namespace cloudresourcemanager_v1 { */ requestBody?: Schema$GetOrgPolicyRequest; } - export interface Params$Resource$Projects$List { + export interface Params$Resource$Projects$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6587,7 +6661,8 @@ export namespace cloudresourcemanager_v1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Listavailableorgpolicyconstraints { + export interface Params$Resource$Projects$Listavailableorgpolicyconstraints + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6603,7 +6678,8 @@ export namespace cloudresourcemanager_v1 { */ requestBody?: Schema$ListAvailableOrgPolicyConstraintsRequest; } - export interface Params$Resource$Projects$Listorgpolicies { + export interface Params$Resource$Projects$Listorgpolicies extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6619,7 +6695,8 @@ export namespace cloudresourcemanager_v1 { */ requestBody?: Schema$ListOrgPoliciesRequest; } - export interface Params$Resource$Projects$Setiampolicy { + export interface Params$Resource$Projects$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6636,7 +6713,8 @@ export namespace cloudresourcemanager_v1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Setorgpolicy { + export interface Params$Resource$Projects$Setorgpolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6652,7 +6730,8 @@ export namespace cloudresourcemanager_v1 { */ requestBody?: Schema$SetOrgPolicyRequest; } - export interface Params$Resource$Projects$Testiampermissions { + export interface Params$Resource$Projects$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6669,7 +6748,8 @@ export namespace cloudresourcemanager_v1 { */ requestBody?: Schema$TestIamPermissionsRequest; } - export interface Params$Resource$Projects$Undelete { + export interface Params$Resource$Projects$Undelete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6685,7 +6765,7 @@ export namespace cloudresourcemanager_v1 { */ requestBody?: Schema$UndeleteProjectRequest; } - export interface Params$Resource$Projects$Update { + export interface Params$Resource$Projects$Update extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/cloudresourcemanager/v1beta1.ts b/src/apis/cloudresourcemanager/v1beta1.ts index 882211eca7..cf9f8224d4 100644 --- a/src/apis/cloudresourcemanager/v1beta1.ts +++ b/src/apis/cloudresourcemanager/v1beta1.ts @@ -29,11 +29,62 @@ export namespace cloudresourcemanager_v1beta1 { version: 'v1beta1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Resource Manager API * - * The Google Cloud Resource Manager API provides methods for creating, - * reading, and updating project metadata. + * Creates, reads, and updates metadata for Google Cloud Platform resource + * containers. * * @example * const {google} = require('googleapis'); @@ -409,11 +460,12 @@ export namespace cloudresourcemanager_v1beta1 { * and 63 characters long and must conform to the following regular * expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be * between 0 and 63 characters long and must conform to the regular - * expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 256 labels - * can be associated with a given resource. Clients should store labels in - * a representation such as JSON that does not depend on specific characters - * being disallowed. Example: <code>"environment" : - * "dev"</code> Read-write. + * expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label value can be + * empty. No more than 256 labels can be associated with a given resource. + * Clients should store labels in a representation such as JSON that does + * not depend on specific characters being disallowed. Example: + * <code>"environment" : "dev"</code> + * Read-write. */ labels?: any; /** @@ -1322,7 +1374,8 @@ export namespace cloudresourcemanager_v1beta1 { } } - export interface Params$Resource$Organizations$Get { + export interface Params$Resource$Organizations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1339,7 +1392,8 @@ export namespace cloudresourcemanager_v1beta1 { */ organizationId?: string; } - export interface Params$Resource$Organizations$Getiampolicy { + export interface Params$Resource$Organizations$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1356,7 +1410,8 @@ export namespace cloudresourcemanager_v1beta1 { */ requestBody?: Schema$GetIamPolicyRequest; } - export interface Params$Resource$Organizations$List { + export interface Params$Resource$Organizations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1385,7 +1440,8 @@ export namespace cloudresourcemanager_v1beta1 { */ pageToken?: string; } - export interface Params$Resource$Organizations$Setiampolicy { + export interface Params$Resource$Organizations$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1402,7 +1458,8 @@ export namespace cloudresourcemanager_v1beta1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Organizations$Testiampermissions { + export interface Params$Resource$Organizations$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1419,7 +1476,8 @@ export namespace cloudresourcemanager_v1beta1 { */ requestBody?: Schema$TestIamPermissionsRequest; } - export interface Params$Resource$Organizations$Update { + export interface Params$Resource$Organizations$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2752,7 +2810,7 @@ export namespace cloudresourcemanager_v1beta1 { } } - export interface Params$Resource$Projects$Create { + export interface Params$Resource$Projects$Create extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2768,7 +2826,7 @@ export namespace cloudresourcemanager_v1beta1 { */ requestBody?: Schema$Project; } - export interface Params$Resource$Projects$Delete { + export interface Params$Resource$Projects$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2779,7 +2837,7 @@ export namespace cloudresourcemanager_v1beta1 { */ projectId?: string; } - export interface Params$Resource$Projects$Get { + export interface Params$Resource$Projects$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2790,7 +2848,8 @@ export namespace cloudresourcemanager_v1beta1 { */ projectId?: string; } - export interface Params$Resource$Projects$Getancestry { + export interface Params$Resource$Projects$Getancestry extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2806,7 +2865,8 @@ export namespace cloudresourcemanager_v1beta1 { */ requestBody?: Schema$GetAncestryRequest; } - export interface Params$Resource$Projects$Getiampolicy { + export interface Params$Resource$Projects$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2823,7 +2883,7 @@ export namespace cloudresourcemanager_v1beta1 { */ requestBody?: Schema$GetIamPolicyRequest; } - export interface Params$Resource$Projects$List { + export interface Params$Resource$Projects$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2863,7 +2923,8 @@ export namespace cloudresourcemanager_v1beta1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Setiampolicy { + export interface Params$Resource$Projects$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2880,7 +2941,8 @@ export namespace cloudresourcemanager_v1beta1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Testiampermissions { + export interface Params$Resource$Projects$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2897,7 +2959,8 @@ export namespace cloudresourcemanager_v1beta1 { */ requestBody?: Schema$TestIamPermissionsRequest; } - export interface Params$Resource$Projects$Undelete { + export interface Params$Resource$Projects$Undelete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2913,7 +2976,7 @@ export namespace cloudresourcemanager_v1beta1 { */ requestBody?: Schema$UndeleteProjectRequest; } - export interface Params$Resource$Projects$Update { + export interface Params$Resource$Projects$Update extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/cloudresourcemanager/v2.ts b/src/apis/cloudresourcemanager/v2.ts index e3ab34e8b2..0fcfc953ba 100644 --- a/src/apis/cloudresourcemanager/v2.ts +++ b/src/apis/cloudresourcemanager/v2.ts @@ -29,11 +29,62 @@ export namespace cloudresourcemanager_v2 { version: 'v2'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Resource Manager API * - * The Google Cloud Resource Manager API provides methods for creating, - * reading, and updating project metadata. + * Creates, reads, and updates metadata for Google Cloud Platform resource + * containers. * * @example * const {google} = require('googleapis'); @@ -1358,7 +1409,7 @@ export namespace cloudresourcemanager_v2 { } } - export interface Params$Resource$Folders$Create { + export interface Params$Resource$Folders$Create extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1375,7 +1426,7 @@ export namespace cloudresourcemanager_v2 { */ requestBody?: Schema$Folder; } - export interface Params$Resource$Folders$Delete { + export interface Params$Resource$Folders$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1387,7 +1438,7 @@ export namespace cloudresourcemanager_v2 { */ name?: string; } - export interface Params$Resource$Folders$Get { + export interface Params$Resource$Folders$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1399,7 +1450,8 @@ export namespace cloudresourcemanager_v2 { */ name?: string; } - export interface Params$Resource$Folders$Getiampolicy { + export interface Params$Resource$Folders$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1416,7 +1468,7 @@ export namespace cloudresourcemanager_v2 { */ requestBody?: Schema$GetIamPolicyRequest; } - export interface Params$Resource$Folders$List { + export interface Params$Resource$Folders$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1446,7 +1498,7 @@ export namespace cloudresourcemanager_v2 { */ showDeleted?: boolean; } - export interface Params$Resource$Folders$Move { + export interface Params$Resource$Folders$Move extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1463,7 +1515,7 @@ export namespace cloudresourcemanager_v2 { */ requestBody?: Schema$MoveFolderRequest; } - export interface Params$Resource$Folders$Patch { + export interface Params$Resource$Folders$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1484,7 +1536,7 @@ export namespace cloudresourcemanager_v2 { */ requestBody?: Schema$Folder; } - export interface Params$Resource$Folders$Search { + export interface Params$Resource$Folders$Search extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1496,7 +1548,8 @@ export namespace cloudresourcemanager_v2 { */ requestBody?: Schema$SearchFoldersRequest; } - export interface Params$Resource$Folders$Setiampolicy { + export interface Params$Resource$Folders$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1513,7 +1566,8 @@ export namespace cloudresourcemanager_v2 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Folders$Testiampermissions { + export interface Params$Resource$Folders$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1530,7 +1584,7 @@ export namespace cloudresourcemanager_v2 { */ requestBody?: Schema$TestIamPermissionsRequest; } - export interface Params$Resource$Folders$Undelete { + export interface Params$Resource$Folders$Undelete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1625,7 +1679,7 @@ export namespace cloudresourcemanager_v2 { } } - export interface Params$Resource$Operations$Get { + export interface Params$Resource$Operations$Get extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/cloudresourcemanager/v2beta1.ts b/src/apis/cloudresourcemanager/v2beta1.ts index bb790e034d..df3778ac13 100644 --- a/src/apis/cloudresourcemanager/v2beta1.ts +++ b/src/apis/cloudresourcemanager/v2beta1.ts @@ -29,11 +29,62 @@ export namespace cloudresourcemanager_v2beta1 { version: 'v2beta1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Resource Manager API * - * The Google Cloud Resource Manager API provides methods for creating, - * reading, and updating project metadata. + * Creates, reads, and updates metadata for Google Cloud Platform resource + * containers. * * @example * const {google} = require('googleapis'); @@ -1358,7 +1409,7 @@ export namespace cloudresourcemanager_v2beta1 { } } - export interface Params$Resource$Folders$Create { + export interface Params$Resource$Folders$Create extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1375,7 +1426,7 @@ export namespace cloudresourcemanager_v2beta1 { */ requestBody?: Schema$Folder; } - export interface Params$Resource$Folders$Delete { + export interface Params$Resource$Folders$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1387,7 +1438,7 @@ export namespace cloudresourcemanager_v2beta1 { */ name?: string; } - export interface Params$Resource$Folders$Get { + export interface Params$Resource$Folders$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1399,7 +1450,8 @@ export namespace cloudresourcemanager_v2beta1 { */ name?: string; } - export interface Params$Resource$Folders$Getiampolicy { + export interface Params$Resource$Folders$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1416,7 +1468,7 @@ export namespace cloudresourcemanager_v2beta1 { */ requestBody?: Schema$GetIamPolicyRequest; } - export interface Params$Resource$Folders$List { + export interface Params$Resource$Folders$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1446,7 +1498,7 @@ export namespace cloudresourcemanager_v2beta1 { */ showDeleted?: boolean; } - export interface Params$Resource$Folders$Move { + export interface Params$Resource$Folders$Move extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1463,7 +1515,7 @@ export namespace cloudresourcemanager_v2beta1 { */ requestBody?: Schema$MoveFolderRequest; } - export interface Params$Resource$Folders$Patch { + export interface Params$Resource$Folders$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1484,7 +1536,7 @@ export namespace cloudresourcemanager_v2beta1 { */ requestBody?: Schema$Folder; } - export interface Params$Resource$Folders$Search { + export interface Params$Resource$Folders$Search extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1496,7 +1548,8 @@ export namespace cloudresourcemanager_v2beta1 { */ requestBody?: Schema$SearchFoldersRequest; } - export interface Params$Resource$Folders$Setiampolicy { + export interface Params$Resource$Folders$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1513,7 +1566,8 @@ export namespace cloudresourcemanager_v2beta1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Folders$Testiampermissions { + export interface Params$Resource$Folders$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1530,7 +1584,7 @@ export namespace cloudresourcemanager_v2beta1 { */ requestBody?: Schema$TestIamPermissionsRequest; } - export interface Params$Resource$Folders$Undelete { + export interface Params$Resource$Folders$Undelete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1625,7 +1679,7 @@ export namespace cloudresourcemanager_v2beta1 { } } - export interface Params$Resource$Operations$Get { + export interface Params$Resource$Operations$Get extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/serviceuser/README.md b/src/apis/cloudsearch/README.md similarity index 81% rename from src/apis/serviceuser/README.md rename to src/apis/cloudsearch/README.md index 2791498588..9e634bffc1 100644 --- a/src/apis/serviceuser/README.md +++ b/src/apis/cloudsearch/README.md @@ -1,13 +1,13 @@ Google Inc. logo -# @google/serviceuser +# @google/cloudsearch -> Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use. +> Cloud Search provides cloud-based search capabilities over G Suite data. The Cloud Search API allows indexing of non-G Suite data into Cloud Search. ## Installation ```sh -$ npm install @google/serviceuser +$ npm install @google/cloudsearch ``` ## Usage diff --git a/src/apis/serviceuser/index.ts b/src/apis/cloudsearch/index.ts similarity index 63% rename from src/apis/serviceuser/index.ts rename to src/apis/cloudsearch/index.ts index 367ddc5fb6..309f1a62a7 100644 --- a/src/apis/serviceuser/index.ts +++ b/src/apis/cloudsearch/index.ts @@ -14,16 +14,16 @@ /*! THIS FILE IS AUTO-GENERATED */ import {getAPI, GoogleConfigurable} from 'googleapis-common'; -import {serviceuser_v1} from './v1'; +import {cloudsearch_v1} from './v1'; export const VERSIONS = { - 'v1': serviceuser_v1.Serviceuser, + 'v1': cloudsearch_v1.Cloudsearch, }; -export function serviceuser(version: 'v1'): serviceuser_v1.Serviceuser; -export function serviceuser(options: serviceuser_v1.Options): - serviceuser_v1.Serviceuser; -export function serviceuser( - this: GoogleConfigurable, versionOrOptions: 'v1'|serviceuser_v1.Options) { - return getAPI('serviceuser', versionOrOptions, VERSIONS, this); +export function cloudsearch(version: 'v1'): cloudsearch_v1.Cloudsearch; +export function cloudsearch(options: cloudsearch_v1.Options): + cloudsearch_v1.Cloudsearch; +export function cloudsearch( + this: GoogleConfigurable, versionOrOptions: 'v1'|cloudsearch_v1.Options) { + return getAPI('cloudsearch', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/serviceuser/package.json b/src/apis/cloudsearch/package.json similarity index 88% rename from src/apis/serviceuser/package.json rename to src/apis/cloudsearch/package.json index 057b6cafed..5de15babdf 100644 --- a/src/apis/serviceuser/package.json +++ b/src/apis/cloudsearch/package.json @@ -1,7 +1,7 @@ { - "name": "@google/serviceuser", + "name": "@google/cloudsearch", "version": "0.1.0", - "description": "serviceuser", + "description": "cloudsearch", "main": "index.js", "types": "index.d.ts", "keywords": ["google"], diff --git a/src/apis/cloudsearch/v1.ts b/src/apis/cloudsearch/v1.ts new file mode 100644 index 0000000000..34feb9a492 --- /dev/null +++ b/src/apis/cloudsearch/v1.ts @@ -0,0 +1,5862 @@ +/** + * 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 cloudsearch_v1 { + export interface Options extends GlobalOptions { + version: 'v1'; + } + + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * Cloud Search API + * + * Cloud Search provides cloud-based search capabilities over G Suite data. + * The Cloud Search API allows indexing of non-G Suite data into Cloud Search. + * + * @example + * const {google} = require('googleapis'); + * const cloudsearch = google.cloudsearch('v1'); + * + * @namespace cloudsearch + * @type {Function} + * @version v1 + * @variation v1 + * @param {object=} options Options for Cloudsearch + */ + export class Cloudsearch { + _options: GlobalOptions; + google?: GoogleConfigurable; + root = this; + + debug: Resource$Debug; + indexing: Resource$Indexing; + media: Resource$Media; + operations: Resource$Operations; + query: Resource$Query; + settings: Resource$Settings; + stats: Resource$Stats; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this._options = options || {}; + this.google = google; + this.getRoot.bind(this); + + this.debug = new Resource$Debug(this); + this.indexing = new Resource$Indexing(this); + this.media = new Resource$Media(this); + this.operations = new Resource$Operations(this); + this.query = new Resource$Query(this); + this.settings = new Resource$Settings(this); + this.stats = new Resource$Stats(this); + } + + getRoot() { + return this.root; + } + } + + /** + * Used to provide a search operator for boolean properties. This is optional. + * Search operators let users restrict the query to specific fields relevant + * to the type of item being searched. + */ + export interface Schema$BooleanOperatorOptions { + /** + * Indicates the operator name required in the query in order to isolate the + * boolean property. For example, if operatorName is *closed* and the + * property's name is *isClosed*, then queries like + * *closed:&lt;value&gt;* will show results only where the value of + * the property named *isClosed* matches *&lt;value&gt;*. By + * contrast, a search that uses the same *&lt;value&gt;* without an + * operator will return all items where *&lt;value&gt;* matches the + * value of any String properties or text within the content field for the + * item. The operator name can only contain lowercase letters (a-z). The + * maximum length is 32 characters. + */ + operatorName?: string; + } + /** + * Options for boolean properties. + */ + export interface Schema$BooleanPropertyOptions { + /** + * If set, describes how the boolean should be used as a search operator. + */ + operatorOptions?: Schema$BooleanOperatorOptions; + } + export interface Schema$CompositeFilter { + /** + * The logic operator of the sub filter. + */ + logicOperator?: string; + /** + * Sub filters. + */ + subFilters?: Schema$Filter[]; + } + /** + * Aggregation of items by status code as of the specified date. + */ + export interface Schema$CustomerIndexStats { + /** + * Date for which statistics were calculated. + */ + date?: Schema$Date; + /** + * Number of items aggregrated by status code. + */ + itemCountByStatus?: Schema$ItemCountByStatus[]; + } + /** + * Data source is a logical namespace for items to be indexed. All items must + * belong to a data source. This is the prerequisite before items can be + * indexed into Cloud Search. + */ + export interface Schema$DataSource { + /** + * If true, Indexing API rejects any modification calls to this data source + * such as create, update, and delete. Disabling this does not imply halting + * process of previously accepted data. + */ + disableModifications?: boolean; + /** + * Disable serving any search or assist results. + */ + disableServing?: boolean; + /** + * Required. Display name of the data source The maximum length is 300 + * characters. + */ + displayName?: string; + /** + * List of service accounts that have indexing access. + */ + indexingServiceAccounts?: string[]; + /** + * This restricts visibility to items at a data source level to the + * disjunction of users/groups mentioned with the field. Note that, this + * does not ensure access to a specific item, as users need to have ACL + * permissions on the contained items. This ensures a high level access on + * the entire data source, and that the individual items are not shared + * outside this visibility. + */ + itemsVisibility?: Schema$GSuitePrincipal[]; + /** + * Name of the data source resource. Format: datasources/{source_id}. <br + * />The name is ignored when creating a data source. + */ + name?: string; + /** + * IDs of the Long Running Operations (LROs) currently running for this + * schema. + */ + operationIds?: string[]; + /** + * A short name or alias for the source. This value will be used to match + * the 'source' operator. For example, if the short name is + * *&lt;value&gt;* then queries like *source:&lt;value&gt;* + * will only return results for this source. The value must be unique across + * all data sources. The value must only contain alphanumeric characters + * (a-zA-Z0-9). The value cannot start with 'google' and cannot be + * one of the following: mail, gmail, docs, drive, groups, sites, calendar, + * hangouts, gplus, keep. Its maximum length is 32 characters. + */ + shortName?: string; + } + /** + * Aggregation of items by status code as of the specified date. + */ + export interface Schema$DataSourceIndexStats { + /** + * Date for which index stats were calculated. If the date of request is not + * the current date then stats calculated on the next day are returned. + * Stats are calculated close to mid night in this case. If date of request + * is current date, then real time stats are returned. + */ + date?: Schema$Date; + /** + * Number of items aggregrated by status code. + */ + itemCountByStatus?: Schema$ItemCountByStatus[]; + } + /** + * Restriction on Datasource. + */ + export interface Schema$DataSourceRestriction { + /** + * Filter options restricting the results. If multiple filters are present, + * they are grouped by object type before joining. Filters with the same + * object type are joined conjunctively, then the resulting expressions are + * joined disjunctively. The maximum number of elements is 20. + */ + filterOptions?: Schema$FilterOptions[]; + /** + * The source of restriction. + */ + source?: Schema$Source; + } + /** + * Represents a whole calendar date, for example a date of birth. The time of + * day and time zone are either specified elsewhere or are not significant. + * The date is relative to the [Proleptic Gregorian + * Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The + * date must be a valid calendar date between the year 1 and 9999. + */ + export interface Schema$Date { + /** + * Day of month. Must be from 1 to 31 and valid for the year and month. + */ + day?: number; + /** + * Month of date. Must be from 1 to 12. + */ + month?: number; + /** + * Year of date. Must be from 1 to 9999. + */ + year?: number; + } + /** + * Optional. Provides a search operator for date properties. Search operators + * let users restrict the query to specific fields relevant to the type of + * item being searched. + */ + export interface Schema$DateOperatorOptions { + /** + * Indicates the operator name required in the query in order to isolate the + * date property using the greater-than operator. For example, if + * greaterThanOperatorName is *closedafter* and the property's name is + * *closeDate*, then queries like *closedafter:&lt;value&gt;* will + * show results only where the value of the property named *closeDate* is + * later than *&lt;value&gt;*. The operator name can only contain + * lowercase letters (a-z). The maximum length is 32 characters. + */ + greaterThanOperatorName?: string; + /** + * Indicates the operator name required in the query in order to isolate the + * date property using the less-than operator. For example, if + * lessThanOperatorName is *closedbefore* and the property's name is + * *closeDate*, then queries like *closedbefore:&lt;value&gt;* will + * show results only where the value of the property named *closeDate* is + * earlier than *&lt;value&gt;*. The operator name can only contain + * lowercase letters (a-z). The maximum length is 32 characters. + */ + lessThanOperatorName?: string; + /** + * Indicates the actual string required in the query in order to isolate the + * date property. For example, suppose an issue tracking schema object has a + * property named *closeDate* that specifies an operator with an + * operatorName of *closedon*. For searches on that data, queries like + * *closedon:&lt;value&gt;* will show results only where the value + * of the *closeDate* property matches *&lt;value&gt;*. By contrast, + * a search that uses the same *&lt;value&gt;* without an operator + * will return all items where *&lt;value&gt;* matches the value of + * any String properties or text within the content field for the indexed + * datasource. The operator name can only contain lowercase letters (a-z). + * The maximum length is 32 characters. + */ + operatorName?: string; + } + /** + * Options for date properties. + */ + export interface Schema$DatePropertyOptions { + /** + * If set, describes how the date should be used as a search operator. + */ + operatorOptions?: Schema$DateOperatorOptions; + } + /** + * List of date values. + */ + export interface Schema$DateValues { + /** + * The maximum number of elements is 100. + */ + values?: Schema$Date[]; + } + /** + * Shared request debug options for all cloudsearch RPC methods. + */ + export interface Schema$DebugOptions { + /** + * If set, the request will enable debugging features of Cloud Search. Only + * turn on this field, if asked by Google to help with debugging. + */ + enableDebugging?: boolean; + } + export interface Schema$DeleteQueueItemsRequest { + /** + * Name of connector making this call. <br />Format: + * datasources/{source_id}/connectors/{ID} + */ + connectorName?: string; + /** + * Common debug options. + */ + debugOptions?: Schema$DebugOptions; + /** + * Name of a queue to delete items from. + */ + queue?: string; + } + /** + * A reference to a top-level property within the object that should be + * displayed in search results. The values of the chosen properties will be + * displayed in the search results along with the dislpay label for that + * property if one is specified. If a display label is not specified, only the + * values will be shown. + */ + export interface Schema$DisplayedProperty { + /** + * The name of the top-level property as defined in a property definition + * for the object. If the name is not a defined property in the schema, an + * error will be given when attempting to update the schema. + */ + propertyName?: string; + } + /** + * Used to provide a search operator for double properties. This is optional. + * Search operators let users restrict the query to specific fields relevant + * to the type of item being searched. + */ + export interface Schema$DoubleOperatorOptions { + /** + * Indicates the operator name required in the query in order to use the + * double property in sorting or as a facet. The operator name can only + * contain lowercase letters (a-z). The maximum length is 32 characters. + */ + operatorName?: string; + } + /** + * Options for double properties. + */ + export interface Schema$DoublePropertyOptions { + /** + * If set, describes how the double should be used as a search operator. + */ + operatorOptions?: Schema$DoubleOperatorOptions; + } + /** + * List of double values. + */ + export interface Schema$DoubleValues { + /** + * The maximum number of elements is 100. + */ + values?: number[]; + } + /** + * Drive follow-up search restricts (e.g. "followup:suggestions"). + */ + export interface Schema$DriveFollowUpRestrict { + type?: string; + } + /** + * Drive location search restricts (e.g. "is:starred"). + */ + export interface Schema$DriveLocationRestrict { + type?: string; + } + /** + * Drive mime-type search restricts (e.g. "type:pdf"). + */ + export interface Schema$DriveMimeTypeRestrict { + type?: string; + } + /** + * The time span search restrict (e.g. "after:2017-09-11 + * before:2017-09-12"). + */ + export interface Schema$DriveTimeSpanRestrict { + type?: string; + } + /** + * A person's email address. + */ + export interface Schema$EmailAddress { + /** + * The email address. + */ + emailAddress?: string; + } + /** + * Used to provide a search operator for enum properties. This is optional. + * Search operators let users restrict the query to specific fields relevant + * to the type of item being searched. For example, if you provide no operator + * for a *priority* enum property with possible values *p0* and *p1*, a query + * that contains the term *p0* will return items that have *p0* as the value + * of the *priority* property, as well as any items that contain the string + * *p0* in other fields. If you provide an operator name for the enum, such as + * *priority*, then search users can use that operator to refine results to + * only items that have *p0* as this property's value, with the query + * *priority:p0*. + */ + export interface Schema$EnumOperatorOptions { + /** + * Indicates the operator name required in the query in order to isolate the + * enum property. For example, if operatorName is *priority* and the + * property's name is *priorityVal*, then queries like + * *priority:&lt;value&gt;* will show results only where the value + * of the property named *priorityVal* matches *&lt;value&gt;*. By + * contrast, a search that uses the same *&lt;value&gt;* without an + * operator will return all items where *&lt;value&gt;* matches the + * value of any String properties or text within the content field for the + * item. The operator name can only contain lowercase letters (a-z). The + * maximum length is 32 characters. + */ + operatorName?: string; + } + /** + * Options for enum properties, which allow you to define a restricted set of + * strings to match user queries, set rankings for those string values, and + * define an operator name to be paired with those strings so that users can + * narrow results to only items with a specific value. For example, for items + * in a request tracking system with priority information, you could define + * *p0* as an allowable enum value and tie this enum to the operator name + * *priority* so that search users could add *priority:p0* to their query to + * restrict the set of results to only those items indexed with the value + * *p0*. + */ + export interface Schema$EnumPropertyOptions { + /** + * If set, describes how the enum should be used as a search operator. + */ + operatorOptions?: Schema$EnumOperatorOptions; + /** + * Used to specify the ordered ranking for the enumeration that determines + * how the integer values provided in the possible EnumValuePairs are used + * to rank results. If specified, integer values must be provided for all + * possible EnumValuePair values given for this property. Can only be used + * if isRepeatable is false. + */ + orderedRanking?: string; + /** + * The list of possible values for the enumeration property. All + * EnumValuePairs must provide a string value. If you specify an integer + * value for one EnumValuePair, then all possible EnumValuePairs must + * provide an integer value. Both the string value and integer value must be + * unique over all possible values. Once set, possible values cannot be + * removed or modified. If you supply an ordered ranking and think you might + * insert additional enum values in the future, leave gaps in the initial + * integer values to allow adding a value in between previously registered + * values. The maximum number of elements is 100. + */ + possibleValues?: Schema$EnumValuePair[]; + } + /** + * The enumeration value pair defines two things: a required string value and + * an optional integer value. The string value defines the necessary query + * term required to retrieve that item, such as *p0* for a priority item. The + * integer value determines the ranking of that string value relative to other + * enumerated values for the same property. For example, you might associate + * *p0* with *0* and define another enum pair such as *p1* and *1*. You must + * use the integer value in combination with ordered ranking to set the + * ranking of a given value relative to other enumerated values for the same + * property name. Here, a ranking order of DESCENDING for *priority* + * properties results in a ranking boost for items indexed with a value of + * *p0* compared to items indexed with a value of *p1*. Without a specified + * ranking order, the integer value has no effect on item ranking. + */ + export interface Schema$EnumValuePair { + /** + * The integer value of the EnumValuePair which must be non-negative. + * Optional. + */ + integerValue?: number; + /** + * The string value of the EnumValuePair. The maximum length is 32 + * characters. + */ + stringValue?: string; + } + /** + * List of enum values. + */ + export interface Schema$EnumValues { + /** + * The maximum allowable length for string values is 32 characters. The + * maximum number of elements is 100. + */ + values?: string[]; + } + /** + * Error information about the response. + */ + export interface Schema$ErrorInfo { + errorMessages?: Schema$ErrorMessage[]; + } + /** + * Error message per source response. + */ + export interface Schema$ErrorMessage { + errorMessage?: string; + source?: Schema$Source; + } + /** + * A bucket in a facet is the basic unit of operation. A bucket can comprise + * either a single value OR a contiguous range of values, depending on the + * type of the field bucketed. FacetBucket is currently used only for + * returning the response object. + */ + export interface Schema$FacetBucket { + /** + * Number of results that match the bucket value. + */ + count?: number; + /** + * Percent of results that match the bucket value. This value is between + * (0-100]. This may not be accurate and is a best effort estimate. + */ + percentage?: number; + value?: Schema$Value; + } + /** + * Specifies operators to return facet results for. There will be one + * FacetResult for every source_name/object_type/operator_name combination. + */ + export interface Schema$FacetOptions { + /** + * If object_type is set, only those objects of that type will be used to + * compute facets. If empty, then all objects will be used to compute + * facets. + */ + objectType?: string; + /** + * Name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions + */ + operatorName?: string; + /** + * Source name to facet on. Format: datasources/{source_id} If empty, all + * data sources will be used. + */ + sourceName?: string; + } + /** + * Source specific facet response + */ + export interface Schema$FacetResult { + /** + * FacetBuckets for values in response containing atleast a single result. + */ + buckets?: Schema$FacetBucket[]; + /** + * Object type for which facet results are returned. Can be empty. + */ + objectType?: string; + /** + * Name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions + */ + operatorName?: string; + /** + * Source name for which facet results are returned. Will not be empty. + */ + sourceName?: string; + } + export interface Schema$FieldViolation { + /** + * Description of the error. + */ + description?: string; + /** + * Path of field with violation. + */ + field?: string; + } + /** + * A generic way of expressing filters in a query, which supports two + * approaches: <br/><br/> **1. Setting a ValueFilter.** The name + * must match an operator_name defined in the schema for your data source. + * <br/> **2. Setting a CompositeFilter.** The filters are evaluated + * using the logical operator. The top-level operators can only be either an + * AND or a NOT. AND can appear only at the top-most level. OR can appear only + * under a top-level AND. + */ + export interface Schema$Filter { + compositeFilter?: Schema$CompositeFilter; + valueFilter?: Schema$ValueFilter; + } + /** + * Filter options to be applied on query. + */ + export interface Schema$FilterOptions { + /** + * Generic filter to restrict the search, such as `lang:en`, `site:xyz`. + */ + filter?: Schema$Filter; + /** + * If object_type is set, only objects of that type are returned. This + * should correspond to the name of the object that was registered within + * the definition of schema. The maximum length is 256 characters. + */ + objectType?: string; + } + /** + * Indicates which freshness property to use when adjusting search ranking for + * an item. Fresher, more recent dates indicate higher quality. Use the + * freshness option property that best works with your data. For fileshare + * documents, last modified time is most relevant. For calendar event data, + * the time when the event occurs is a more relevant freshness indicator. In + * this way, calendar events that occur closer to the time of the search query + * are considered higher quality and ranked accordingly. + */ + export interface Schema$FreshnessOptions { + /** + * The duration (in seconds) after which an object should be considered + * stale. + */ + freshnessDuration?: string; + /** + * This property indicates the freshness level of the object in the index. + * If set, this property must be a top-level property within the + * PropertyDefinitions and it must be a timestamp type or date type. + * Otherwise, the Indexing API uses updateTime as the freshness indicator. + * The maximum length is 256 characters. + */ + freshnessProperty?: string; + } + export interface Schema$GetCustomerIndexStatsResponse { + /** + * Summary of indexed item counts, one for each day in the requested range. + */ + stats?: Schema$CustomerIndexStats[]; + } + export interface Schema$GetDataSourceIndexStatsResponse { + /** + * Summary of indexed item counts, one for each day in the requested range. + */ + stats?: Schema$DataSourceIndexStats[]; + } + export interface Schema$GSuitePrincipal { + /** + * This principal represents all users of the G Suite domain of the + * customer. + */ + gsuiteDomain?: boolean; + /** + * This principal references a G Suite group account + */ + gsuiteGroupEmail?: string; + /** + * This principal references a G Suite user account + */ + gsuiteUserEmail?: string; + } + /** + * Used to provide a search operator for html properties. This is optional. + * Search operators let users restrict the query to specific fields relevant + * to the type of item being searched. + */ + export interface Schema$HtmlOperatorOptions { + /** + * Indicates the operator name required in the query in order to isolate the + * html property. For example, if operatorName is *subject* and the + * property's name is *subjectLine*, then queries like + * *subject:&lt;value&gt;* will show results only where the value of + * the property named *subjectLine* matches *&lt;value&gt;*. By + * contrast, a search that uses the same *&lt;value&gt;* without an + * operator will return all items where *&lt;value&gt;* matches the + * value of any html properties or text within the content field for the + * item. The operator name can only contain lowercase letters (a-z). The + * maximum length is 32 characters. + */ + operatorName?: string; + } + /** + * Options for html properties. + */ + export interface Schema$HtmlPropertyOptions { + /** + * If set, describes how the property should be used as a search operator. + */ + operatorOptions?: Schema$HtmlOperatorOptions; + /** + * Indicates the search quality importance of the tokens within the field + * when used for retrieval. Can only be set to DEFAULT or NONE. + */ + retrievalImportance?: Schema$RetrievalImportance; + } + /** + * List of html values. + */ + export interface Schema$HtmlValues { + /** + * The maximum allowable length for html values is 2048 characters. The + * maximum number of string elements is 100. + */ + values?: string[]; + } + export interface Schema$IndexItemRequest { + /** + * Name of connector making this call. <br />Format: + * datasources/{source_id}/connectors/{ID} + */ + connectorName?: string; + /** + * Common debug options. + */ + debugOptions?: Schema$DebugOptions; + /** + * Name of the item. Format: datasources/{source_id}/items/{item_id} + */ + item?: Schema$Item; + /** + * Required. The RequestMode for this request. + */ + mode?: string; + } + /** + * Used to provide a search operator for integer properties. This is optional. + * Search operators let users restrict the query to specific fields relevant + * to the type of item being searched. + */ + export interface Schema$IntegerOperatorOptions { + /** + * Indicates the operator name required in the query in order to isolate the + * integer property using the greater-than operator. For example, if + * greaterThanOperatorName is *priorityabove* and the property's name is + * *priorityVal*, then queries like *priorityabove:&lt;value&gt;* + * will show results only where the value of the property named + * *priorityVal* is greater than *&lt;value&gt;*. The operator name + * can only contain lowercase letters (a-z). The maximum length is 32 + * characters. + */ + greaterThanOperatorName?: string; + /** + * Indicates the operator name required in the query in order to isolate the + * integer property using the less-than operator. For example, if + * lessThanOperatorName is *prioritybelow* and the property's name is + * *priorityVal*, then queries like *prioritybelow:&lt;value&gt;* + * will show results only where the value of the property named + * *priorityVal* is less than *&lt;value&gt;*. The operator name can + * only contain lowercase letters (a-z). The maximum length is 32 + * characters. + */ + lessThanOperatorName?: string; + /** + * Indicates the operator name required in the query in order to isolate the + * integer property. For example, if operatorName is *priority* and the + * property's name is *priorityVal*, then queries like + * *priority:&lt;value&gt;* will show results only where the value + * of the property named *priorityVal* matches *&lt;value&gt;*. By + * contrast, a search that uses the same *&lt;value&gt;* without an + * operator will return all items where *&lt;value&gt;* matches the + * value of any String properties or text within the content field for the + * item. The operator name can only contain lowercase letters (a-z). The + * maximum length is 32 characters. + */ + operatorName?: string; + } + /** + * Options for integer properties. + */ + export interface Schema$IntegerPropertyOptions { + /** + * The maximum value of the property. The minimum and maximum values for the + * property are used to rank results according to the ordered ranking. + * Indexing requests with values greater than the maximum are accepted and + * ranked with the same weight as items indexed with the maximum value. + */ + maximumValue?: string; + /** + * The minimum value of the property. The minimum and maximum values for the + * property are used to rank results according to the ordered ranking. + * Indexing requests with values less than the minimum are accepted and + * ranked with the same weight as items indexed with the minimum value. + */ + minimumValue?: string; + /** + * If set, describes how the integer should be used as a search operator. + */ + operatorOptions?: Schema$IntegerOperatorOptions; + /** + * Used to specify the ordered ranking for the integer. Can only be used if + * isRepeatable is false. + */ + orderedRanking?: string; + } + /** + * List of integer values. + */ + export interface Schema$IntegerValues { + /** + * The maximum number of elements is 100. + */ + values?: string[]; + } + /** + * Represents an interaction between a user and an item. + */ + export interface Schema$Interaction { + /** + * The time when the user acted on the item. If multiple actions of the + * same type exist for a single user, only the most recent action is + * recorded. + */ + interactionTime?: string; + /** + * The user that acted on the item. + */ + principal?: Schema$Principal; + type?: string; + } + /** + * Represents a single object that is an item in the search index, such as a + * file, folder, or a database record. + */ + export interface Schema$Item { + /** + * Access control list for this item. + */ + acl?: Schema$ItemAcl; + /** + * Item content to be indexed and made text searchable. + */ + content?: Schema$ItemContent; + /** + * Type for this item. + */ + itemType?: string; + /** + * Metadata information. + */ + metadata?: Schema$ItemMetadata; + /** + * Name of the Item. Format: datasources/{source_id}/items/{item_id} <br + * />This is a required field. The maximum length is 1536 characters. + */ + name?: string; + /** + * Additional state connector can store for this item. The maximum length is + * 10000 bytes. + */ + payload?: string; + /** + * Queue this item belongs to. The maximum length is 100 characters. + */ + queue?: string; + /** + * Status of the item. Output only field. + */ + status?: Schema$ItemStatus; + /** + * The structured data for the item that should conform to a registered + * object definition in the schema for the data source. + */ + structuredData?: Schema$ItemStructuredData; + /** + * Required. The indexing system stores the version from the datasource as a + * byte string and compares the Item version in the index to the version of + * the queued Item using lexical ordering. <br /><br /> Cloud + * Search Indexing won't index or delete any queued item with a version + * value that is less than or equal to the version of the currently indexed + * item. The maximum length for this field is 1024 bytes. + */ + version?: string; + } + /** + * Access control list information for the item. For more information see + * https://developers.google.com/cloud-search/docs/guides/index-your-data#acls + */ + export interface Schema$ItemAcl { + /** + * Sets the type of access rules to apply when an item inherits its ACL from + * a parent. This should always be set in tandem with the inheritAclFrom + * field. Also, when the inheritAclFrom field is set, this field should be + * set to a valid AclInheritanceType. + */ + aclInheritanceType?: string; + /** + * List of principals who are explicitly denied access to the item in search + * results. While principals are denied access by default, use denied + * readers to handle exceptions and override the list allowed readers. The + * maximum number of elements is 100. + */ + deniedReaders?: Schema$Principal[]; + /** + * Name of the item to inherit the Access Permission List (ACL) from. Note: + * ACL inheritance *only* provides access permissions to child items and + * does not define structural relationships, nor does it provide convenient + * ways to delete large groups of items. Deleting an ACL parent from the + * index only alters the access permissions of child items that reference + * the parent in the inheritAclFrom field. The item is still in the index, + * but may not visible in search results. By contrast, deletion of a + * container item also deletes all items that reference the container via + * the containerName field. The maximum length for this field is 1536 + * characters. + */ + inheritAclFrom?: string; + /** + * Optional. List of owners for the item. This field has no bearing on + * document access permissions. It does, however, offer a slight ranking + * boosts items where the querying user is an owner. The maximum number of + * elements is 5. + */ + owners?: Schema$Principal[]; + /** + * List of principals who are allowed to see the item in search results. + * Optional if inheriting permissions from another item or if the item is + * not intended to be visible, such as virtual containers. The maximum + * number of elements is 1000. + */ + readers?: Schema$Principal[]; + } + /** + * Content of an item to be indexed and surfaced by Cloud Search. + */ + export interface Schema$ItemContent { + /** + * Upload reference ID of a previously uploaded content via write method. + */ + contentDataRef?: Schema$UploadItemRef; + contentFormat?: string; + /** + * Hashing info calculated and provided by the API client for content. Can + * be used with the items.push method to calculate modified state. The + * maximum length is 2048 characters. + */ + hash?: string; + /** + * Content that is supplied inlined within the update method. The maximum + * length is 102400 bytes (100 KiB). + */ + inlineContent?: string; + } + export interface Schema$ItemCountByStatus { + /** + * Number of items matching the status code. + */ + count?: string; + /** + * Status of the items. + */ + statusCode?: string; + } + /** + * Available metadata fields for the item. + */ + export interface Schema$ItemMetadata { + /** + * The name of the container for this item. Deletion of the container item + * leads to automatic deletion of this item. Note: ACLs are not inherited + * from a container item. To provide ACL inheritance for an item, use the + * inheritAclFrom field. The maximum length is 1536 characters. + */ + containerName?: string; + /** + * The BCP-47 language code for the item, such as "en-US" or + * "sr-Latn". For more information, see + * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The + * maximum length is 32 characters. + */ + contentLanguage?: string; + /** + * The time when the item was created in the source repository. + */ + createTime?: string; + /** + * Hashing value provided by the API caller. This can be used with the + * items.push method to calculate modified state. The maximum length is 2048 + * characters. + */ + hash?: string; + /** + * A list of interactions for the item. Interactions are used to improve + * Search quality, but are not exposed to end users. The maximum number of + * elements is 1000. + */ + interactions?: Schema$Interaction[]; + /** + * Additional keywords or phrases that should match the item. Used + * internally for user generated content. The maximum number of elements is + * 100. The maximum length is 8192 characters. + */ + keywords?: string[]; + /** + * The original mime-type of ItemContent.content in the source repository. + * The maximum length is 256 characters. + */ + mimeType?: string; + /** + * The type of the item. This should correspond to the name of an object + * definition in the schema registered for the data source. For example, if + * the schema for the data source contains an object definition with name + * 'document', then item indexing requests for objects of that type + * should set objectType to 'document'. The maximum length is 256 + * characters. + */ + objectType?: string; + /** + * Additional search quality metadata of the item + */ + searchQualityMetadata?: Schema$SearchQualityMetadata; + /** + * Link to the source repository serving the data. &#83;earch results + * apply this link to the title. The maximum length is 2048 characters. + */ + sourceRepositoryUrl?: string; + /** + * The title of the item. If given, this will be the displayed title of the + * Search result. The maximum length is 2048 characters. + */ + title?: string; + /** + * The time when the item was last modified in the source repository. + */ + updateTime?: string; + } + /** + * This contains item's status and any errors. + */ + export interface Schema$ItemStatus { + /** + * Status code. + */ + code?: string; + /** + * Error details in case the item is in ERROR state. + */ + processingErrors?: Schema$ProcessingError[]; + /** + * Repository error reported by connector. + */ + repositoryErrors?: Schema$RepositoryError[]; + } + /** + * Available structured data fields for the item. + */ + export interface Schema$ItemStructuredData { + /** + * Hashing value provided by the API caller. This can be used with the + * items.push method to calculate modified state. The maximum length is 2048 + * characters. + */ + hash?: string; + /** + * The structured data object that should conform to a registered object + * definition in the schema for the data source. + */ + object?: Schema$StructuredDataObject; + } + export interface Schema$ListDataSourceResponse { + /** + * Token to retrieve the next page of results, or empty if there are no more + * results in the list. + */ + nextPageToken?: string; + sources?: Schema$DataSource[]; + } + export interface Schema$ListItemNamesForUnmappedIdentityResponse { + itemNames?: string[]; + /** + * Token to retrieve the next page of results, or empty if there are no more + * results in the list. + */ + nextPageToken?: string; + } + export interface Schema$ListItemsResponse { + items?: Schema$Item[]; + /** + * Token to retrieve the next page of results, or empty if there are no more + * results in the list. + */ + nextPageToken?: string; + } + /** + * List sources response. + */ + export interface Schema$ListQuerySourcesResponse { + nextPageToken?: string; + sources?: Schema$QuerySource[]; + } + export interface Schema$ListSearchApplicationsResponse { + /** + * Token to retrieve the next page of results, or empty if there are no more + * results in the list. + */ + nextPageToken?: string; + searchApplications?: Schema$SearchApplication[]; + } + export interface Schema$ListUnmappedIdentitiesResponse { + /** + * Token to retrieve the next page of results, or empty if there are no more + * results in the list. + */ + nextPageToken?: string; + unmappedIdentities?: Schema$UnmappedIdentity[]; + } + /** + * Matched range of a snippet [start, end). + */ + export interface Schema$MatchRange { + /** + * End of the match in the snippet. + */ + end?: number; + /** + * Starting position of the match in the snippet. + */ + start?: number; + } + /** + * Media resource. + */ + export interface Schema$Media { + /** + * Name of the media resource. + */ + resourceName?: string; + } + /** + * Metadata of a matched search result. + */ + export interface Schema$Metadata { + /** + * The creation time for this document or object in the search result. + */ + createTime?: string; + /** + * Options that specify how to display a structured data search result. + */ + displayOptions?: Schema$ResultDisplayMetadata; + /** + * Indexed fields in structured data, returned as a generic named property. + */ + fields?: Schema$NamedProperty[]; + /** + * Mime type of the search result. + */ + mimeType?: string; + /** + * Object type of the search result. + */ + objectType?: string; + /** + * Owner (usually creator) of the document or object of the search result. + */ + owner?: Schema$Person; + /** + * The named source for the result, such as Gmail. + */ + source?: Schema$Source; + /** + * The last modified date for the object in the search result. + */ + updateTime?: string; + } + /** + * A metaline is a list of properties that are displayed along with the search + * result to provide context. + */ + export interface Schema$Metaline { + /** + * The list of displayed properties for the metaline. + */ + properties?: Schema$DisplayedProperty[]; + } + /** + * A person's name. + */ + export interface Schema$Name { + /** + * The read-only display name formatted according to the locale specified by + * the viewer's account or the <code>Accept-Language</code> + * HTTP header. + */ + displayName?: string; + } + /** + * A typed name-value pair for structured data. The type of the value should + * be the same as the registered type for the `name` property in the object + * definition of `objectType`. + */ + export interface Schema$NamedProperty { + booleanValue?: boolean; + dateValues?: Schema$DateValues; + doubleValues?: Schema$DoubleValues; + enumValues?: Schema$EnumValues; + htmlValues?: Schema$HtmlValues; + integerValues?: Schema$IntegerValues; + /** + * The name of the property. This name should correspond to the name of the + * property that was registered for object definition in the schema. The + * maximum allowable length for this property is 256 characters. + */ + name?: string; + objectValues?: Schema$ObjectValues; + textValues?: Schema$TextValues; + timestampValues?: Schema$TimestampValues; + } + /** + * The definition for an object within a data source. + */ + export interface Schema$ObjectDefinition { + /** + * Name for the object, which then defines its type. Item indexing requests + * should set the objectType field equal to this value. For example, if + * *name* is *Document*, then indexing requests for items of type Document + * should set objectType equal to *Document*. Each object definition must be + * uniquely named within a schema. The name must start with a letter and can + * only contain letters (A-Z, a-z) or numbers (0-9). The maximum length is + * 256 characters. + */ + name?: string; + /** + * The optional object-specific options. + */ + options?: Schema$ObjectOptions; + /** + * The property definitions for the object. The maximum number of elements + * is 1000. + */ + propertyDefinitions?: Schema$PropertyDefinition[]; + } + /** + * The display options for an object. + */ + export interface Schema$ObjectDisplayOptions { + /** + * Defines the properties that will be displayed in the metalines of the + * search results. The property values will be displayed in the order given + * here. If a property holds multiple values, all of the values will be + * diplayed before the next properties. For this reason, it is a good + * practice to specify singular properties before repeated properties in + * this list. All of the properties must set is_returnable to true. The + * maximum number of elements is 3. + */ + metalines?: Schema$Metaline[]; + /** + * The user friendly label to display in the search result to inidicate the + * type of the item. This is OPTIONAL; if not given, an object label will + * not be displayed on the context line of the search results. The maximum + * length is 32 characters. + */ + objectDisplayLabel?: string; + } + /** + * The options for an object. + */ + export interface Schema$ObjectOptions { + /** + * Options that determine how the object is displayed in the Cloud Search + * results page. + */ + displayOptions?: Schema$ObjectDisplayOptions; + /** + * The freshness options for an object. + */ + freshnessOptions?: Schema$FreshnessOptions; + } + /** + * Options for object properties. + */ + export interface Schema$ObjectPropertyOptions { + /** + * The properties of the sub-object. These properties represent a nested + * object. For example, if this property represents a postal address, the + * subobjectProperties might be named *street*, *city*, and *state*. The + * maximum number of elements is 1000. + */ + subobjectProperties?: Schema$PropertyDefinition[]; + } + /** + * List of object values. + */ + export interface Schema$ObjectValues { + /** + * The maximum number of elements is 100. + */ + values?: Schema$StructuredDataObject[]; + } + /** + * This resource represents a long-running operation that is the result of a + * network API call. + */ + export interface Schema$Operation { + /** + * If the value is `false`, it means the operation is still in progress. If + * `true`, the operation is completed, and either `error` or `response` is + * available. + */ + done?: boolean; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$Status; + /** + * Service-specific metadata associated with the operation. It typically + * contains progress information and common metadata such as create time. + * Some services might not provide such metadata. Any method that returns a + * long-running operation should document the metadata type, if any. + */ + metadata?: any; + /** + * The server-assigned name, which is only unique within the same service + * that originally returns it. If you use the default HTTP mapping, the + * `name` should have the format of `operations/some/unique/name`. + */ + name?: string; + /** + * The normal response of the operation in case of success. If the original + * method returns no data on success, such as `Delete`, the response is + * `google.protobuf.Empty`. If the original method is standard + * `Get`/`Create`/`Update`, the response should be the resource. For other + * methods, the response should have the type `XxxResponse`, where `Xxx` is + * the original method name. For example, if the original method name is + * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + */ + response?: any; + } + /** + * A people suggestion. + */ + export interface Schema$PeopleSuggestion { + /** + * Suggested person. All fields of the person object might not be populated. + */ + person?: Schema$Person; + } + /** + * Object to represent a person. + */ + export interface Schema$Person { + /** + * The person's email addresses + */ + emailAddresses?: Schema$EmailAddress[]; + /** + * The resource name of the person to provide information about. See <a + * href="https://developers.google.com/people/api/rest/v1/people/get"> + * People.get</a> from Google People API. + */ + name?: string; + /** + * Obfuscated ID of a person. + */ + obfuscatedId?: string; + /** + * The person's name + */ + personNames?: Schema$Name[]; + /** + * A person's read-only photo. A picture shown next to the person's + * name to help others recognize the person in search results. + */ + photos?: Schema$Photo[]; + } + /** + * A person's photo. + */ + export interface Schema$Photo { + /** + * The URL of the photo. + */ + url?: string; + } + export interface Schema$PollItemsRequest { + /** + * Name of connector making this call. <br />Format: + * datasources/{source_id}/connectors/{ID} + */ + connectorName?: string; + /** + * Common debug options. + */ + debugOptions?: Schema$DebugOptions; + /** + * Maximum number of items to return. <br />The maximum and the + * default value is 1000 + */ + limit?: number; + /** + * Queue name to fetch items from. If unspecified, PollItems will fetch + * from 'default' queue. The maximum length is 100 characters. + */ + queue?: string; + /** + * Limit the items polled to the ones with these statuses. + */ + statusCodes?: string[]; + } + export interface Schema$PollItemsResponse { + /** + * Set of items from the queue available for connector to process. <br + * />These items have the following subset of fields populated: <br + * /> <br />version <br />metadata.hash <br + * />structured_data.hash <br />content.hash <br />payload + * <br />status <br />queue + */ + items?: Schema$Item[]; + } + /** + * Reference to a user, group, or domain. + */ + export interface Schema$Principal { + /** + * This principal is a group identified using an external identity. The name + * field must specify the group resource name with this format: + * identitysources/{source_id}/groups/{ID} + */ + groupResourceName?: string; + /** + * This principal is a GSuite user, group or domain. + */ + gsuitePrincipal?: Schema$GSuitePrincipal; + /** + * This principal is a user identified using an external identity. The name + * field must specify the user resource name with this format: + * identitysources/{source_id}/users/{ID} + */ + userResourceName?: string; + } + export interface Schema$ProcessingError { + /** + * Error code indicating the nature of the error. + */ + code?: string; + /** + * Description of the error. + */ + errorMessage?: string; + /** + * In case the item fields are invalid, this field contains the details + * about the validation errors. + */ + fieldViolations?: Schema$FieldViolation[]; + } + /** + * The definition of a property within an object. + */ + export interface Schema$PropertyDefinition { + booleanPropertyOptions?: Schema$BooleanPropertyOptions; + datePropertyOptions?: Schema$DatePropertyOptions; + /** + * Options that determine how the property is displayed in the Cloud Search + * results page if it is specified to be displayed in the object's + * display options . + */ + displayOptions?: Schema$PropertyDisplayOptions; + doublePropertyOptions?: Schema$DoublePropertyOptions; + enumPropertyOptions?: Schema$EnumPropertyOptions; + htmlPropertyOptions?: Schema$HtmlPropertyOptions; + integerPropertyOptions?: Schema$IntegerPropertyOptions; + /** + * Indicates that the property can be used for generating facets. Cannot be + * true for properties whose type is object. IsReturnable must be true to + * set this option. Only supported for Boolean, Enum, and Text properties. + */ + isFacetable?: boolean; + /** + * Indicates that multiple values are allowed for the property. For example, + * a document only has one description but can have multiple comments. + * Cannot be true for properties whose type is a boolean. If set to false, + * properties that contain more than one value will cause the indexing + * request for that item to be rejected. + */ + isRepeatable?: boolean; + /** + * Indicates that the property identifies data that should be returned in + * search results via the Query API. If set to *true*, indicates that Query + * API users can use matching property fields in results. However, storing + * fields requires more space allocation and uses more bandwidth for search + * queries, which impacts performance over large datasets. Set to *true* + * here only if the field is needed for search results. Cannot be true for + * properties whose type is an object. + */ + isReturnable?: boolean; + /** + * Indicates that the property can be used for sorting. Cannot be true for + * properties that are repeatable. Cannot be true for properties whose type + * is object or user identifier. IsReturnable must be true to set this + * option. Only supported for Boolean, Date, Double, Integer, and Timestamp + * properties. + */ + isSortable?: boolean; + /** + * The name of the property. Item indexing requests sent to the Indexing API + * should set the property name equal to this value. For example, if name is + * *subject_line*, then indexing requests for document items with subject + * fields should set the name for that field equal to *subject_line*. Use + * the name as the identifier for the object property. Once registered as a + * property for an object, you cannot re-use this name for another property + * within that object. The name must start with a letter and can only + * contain letters (A-Z, a-z) or numbers (0-9). The maximum length is 256 + * characters. + */ + name?: string; + objectPropertyOptions?: Schema$ObjectPropertyOptions; + textPropertyOptions?: Schema$TextPropertyOptions; + timestampPropertyOptions?: Schema$TimestampPropertyOptions; + } + /** + * The display options for a property. + */ + export interface Schema$PropertyDisplayOptions { + /** + * The user friendly label for the property that will be used if the + * property is specified to be displayed in ObjectDisplayOptions. If given, + * the display label will be shown in front of the property values when the + * property is part of the object display options. For example, if the + * property value is '1', the value by itself may not be useful + * context for the user. If the display name given was 'priority', + * then the user will see 'priority : 1' in the search results which + * provides clear conext to search users. This is OPTIONAL; if not given, + * only the property values will be displayed. The maximum length is 32 + * characters. + */ + displayLabel?: string; + } + /** + * Represents an item to be pushed to the indexing queue. + */ + export interface Schema$PushItem { + /** + * Content hash of the item according to the repository. If specified, this + * is used to determine how to modify this item's status. Setting this + * field and the type field results in argument error. The maximum length is + * 2048 characters. + */ + contentHash?: string; + /** + * Metadata hash of the item according to the repository. If specified, this + * is used to determine how to modify this item's status. Setting this + * field and the type field results in argument error. The maximum length is + * 2048 characters. + */ + metadataHash?: string; + /** + * Provides additional document state information for the connector, such as + * an alternate repository ID and other metadata. The maximum length is 8192 + * bytes. + */ + payload?: string; + /** + * Queue to which this item belongs to. The + * <code>default</code> queue is chosen if this field is not + * specified. The maximum length is 512 characters. + */ + queue?: string; + /** + * Populate this field to store Connector or repository error details. This + * information is displayed in the Admin Console. This field may only be + * populated when the Type is REPOSITORY_ERROR. + */ + repositoryError?: Schema$RepositoryError; + /** + * Structured data hash of the item according to the repository. If + * specified, this is used to determine how to modify this item's + * status. Setting this field and the type field results in argument error. + * The maximum length is 2048 characters. + */ + structuredDataHash?: string; + /** + * The type of the push operation that defines the push behavior. + */ + type?: string; + } + export interface Schema$PushItemRequest { + /** + * Name of connector making this call. <br />Format: + * datasources/{source_id}/connectors/{ID} + */ + connectorName?: string; + /** + * Common debug options. + */ + debugOptions?: Schema$DebugOptions; + /** + * Item to push onto the queue. + */ + item?: Schema$PushItem; + } + export interface Schema$QueryInterpretation { + interpretationType?: string; + /** + * The interpretation of the query used in search. For example, query + * "email from john" will be interpreted as "from:john + * source:mail" + */ + interpretedQuery?: string; + } + /** + * Options to interpret user query. + */ + export interface Schema$QueryInterpretationOptions { + /** + * Flag to disable natural language (NL) interpretation of queries. Default + * is false, Set to true to disable natural language interpretation. NL + * interpretation only applies to predefined datasources. + */ + disableNlInterpretation?: boolean; + } + /** + * Information relevant only to a query entry. + */ + export interface Schema$QueryItem { + /** + * True if the text was generated by means other than a previous user + * search. + */ + isSynthetic?: boolean; + } + /** + * The definition of a operator that can be used in a Search/Suggest request. + */ + export interface Schema$QueryOperator { + /** + * Display name of the operator + */ + displayName?: string; + /** + * Potential list of values for the opeatror field. This field is only + * filled when we can safely enumerate all the possible values of this + * operator. + */ + enumValues?: string[]; + /** + * Indicates the operator name that can be used to isolate the property + * using the greater-than operator. + */ + greaterThanOperatorName?: string; + /** + * Can this operator be used to get facets. + */ + isFacetable?: boolean; + /** + * Indicates if multiple values can be set for this property. + */ + isRepeatable?: boolean; + /** + * Will the property associated with this facet be returned as part of + * search results. + */ + isReturnable?: boolean; + /** + * Can this operator be used to sort results. + */ + isSortable?: boolean; + /** + * Can get suggestions for this field. + */ + isSuggestable?: boolean; + /** + * Indicates the operator name that can be used to isolate the property + * using the less-than operator. + */ + lessThanOperatorName?: string; + /** + * The name of the operator. + */ + operatorName?: string; + /** + * Type of the operator. + */ + type?: string; + } + /** + * List of sources that the user can search using the query API. + */ + export interface Schema$QuerySource { + /** + * Display name of the data source. + */ + displayName?: string; + /** + * List of all operators applicable for this source. + */ + operators?: Schema$QueryOperator[]; + /** + * A short name or alias for the source. This value can be used with the + * 'source' operator. + */ + shortName?: string; + /** + * Name of the source + */ + source?: Schema$Source; + } + /** + * A completed query suggestion. + */ + export interface Schema$QuerySuggestion {} + /** + * Errors when the connector is communicating to the source repository. + */ + export interface Schema$RepositoryError { + /** + * Message that describes the error. The maximum allowable length of the + * message is 8192 characters. + */ + errorMessage?: string; + /** + * Error codes. Matches the definition of HTTP status codes. + */ + httpStatusCode?: number; + /** + * Type of error. + */ + type?: string; + } + /** + * Shared request options for all RPC methods. + */ + export interface Schema$RequestOptions { + /** + * Debug options of the request + */ + debugOptions?: Schema$DebugOptions; + /** + * The BCP-47 language code, such as "en-US" or + * "sr-Latn". For more information, see + * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For + * translations. + */ + languageCode?: string; + /** + * Id of the application created using SearchApplicationsService. + */ + searchApplicationId?: string; + /** + * Current user's time zone id, such as "America/Los_Angeles" + * or "Australia/Sydney". These IDs are defined by [Unicode Common + * Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and + * currently available in the file + * [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml) + */ + timeZone?: string; + } + export interface Schema$ResetSearchApplicationRequest { + /** + * Common debug options. + */ + debugOptions?: Schema$DebugOptions; + } + /** + * Debugging information about the response. + */ + export interface Schema$ResponseDebugInfo { + /** + * General debug info formatted for display. + */ + formattedDebugInfo?: string; + } + /** + * Information relevant only to a restrict entry. NextId: 7 + */ + export interface Schema$RestrictItem { + driveFollowUpRestrict?: Schema$DriveFollowUpRestrict; + driveLocationRestrict?: Schema$DriveLocationRestrict; + driveMimeTypeRestrict?: Schema$DriveMimeTypeRestrict; + driveTimeSpanRestrict?: Schema$DriveTimeSpanRestrict; + /** + * The search restrict (e.g. "after:2017-09-11 + * before:2017-09-12"). + */ + searchOperator?: string; + } + /** + * Result count information + */ + export interface Schema$ResultCounts { + /** + * Result count information for each source with results. + */ + sourceResultCounts?: Schema$SourceResultCount[]; + } + /** + * Debugging information about the result. + */ + export interface Schema$ResultDebugInfo { + /** + * General debug info formatted for display. + */ + formattedDebugInfo?: string; + } + /** + * Display Fields for Search Results + */ + export interface Schema$ResultDisplayField { + /** + * The display label for the property. + */ + label?: string; + /** + * The operator name of the property. + */ + operatorName?: string; + /** + * The name value pair for the property. + */ + property?: Schema$NamedProperty; + } + /** + * The collection of fields that make up a displayed line + */ + export interface Schema$ResultDisplayLine { + fields?: Schema$ResultDisplayField[]; + } + export interface Schema$ResultDisplayMetadata { + /** + * The metalines content to be displayed with the result. + */ + metalines?: Schema$ResultDisplayLine[]; + /** + * The display label for the object. + */ + objectTypeLabel?: string; + } + export interface Schema$RetrievalImportance { + /** + * Indicates the ranking importance given to property when it is matched + * during retrieval. Once set, the token importance of a property cannot be + * changed. + */ + importance?: string; + } + /** + * The schema definition for a data source. + */ + export interface Schema$Schema { + /** + * The list of top-level objects for the data source. The maximum number of + * elements is 10. + */ + objectDefinitions?: Schema$ObjectDefinition[]; + /** + * IDs of the Long Running Operations (LROs) currently running for this + * schema. After modifying the schema, wait for opeations to complete before + * indexing additional content. + */ + operationIds?: string[]; + } + /** + * Scoring configurations for a source while processing a Search or Suggest + * request. + */ + export interface Schema$ScoringConfig { + /** + * Whether to use freshness as a ranking signal. By default, freshness is + * used as a ranking signal. + */ + disableFreshness?: boolean; + /** + * Whether to personalize the results. By default, personal signals will be + * used to boost results. + */ + disablePersonalization?: boolean; + } + /** + * SearchApplication + */ + export interface Schema$SearchApplication { + /** + * Retrictions applied to the configurations. The maximum number of elements + * is 10. + */ + dataSourceRestrictions?: Schema$DataSourceRestriction[]; + /** + * The default fields for returning facet results. The sources specified + * here also have been included in data_source_restrictions above. + */ + defaultFacetOptions?: Schema$FacetOptions[]; + /** + * The default options for sorting the search results + */ + defaultSortOptions?: Schema$SortOptions; + /** + * Display name of the Search Application. The maximum length is 300 + * characters. + */ + displayName?: string; + /** + * Name of the Search Application. <br />Format: + * searchapplications/{application_id}. + */ + name?: string; + /** + * IDs of the Long Running Operations (LROs) currently running for this + * schema. Output only field. + */ + operationIds?: string[]; + /** + * Configuration for ranking results. + */ + scoringConfig?: Schema$ScoringConfig; + /** + * Configuration for a sources specified in data_source_restrictions. + */ + sourceConfig?: Schema$SourceConfig[]; + } + /** + * Additional search quality metadata of the item. + */ + export interface Schema$SearchQualityMetadata { + /** + * An indication of the quality of the item, used to influence search + * quality. Value should be between 0.0 (lowest quality) and 1.0 (highest + * quality). + */ + quality?: number; + } + /** + * The search API request. + */ + export interface Schema$SearchRequest { + /** + * The sources to use for querying. If not specified, all data sources from + * the current search application are used. + */ + dataSourceRestrictions?: Schema$DataSourceRestriction[]; + facetOptions?: Schema$FacetOptions[]; + /** + * Maximum number of search results to return in one page. Valid values are + * between 1 and 100, inclusive. Default value is 10. + */ + pageSize?: number; + /** + * The raw query string. See supported search operators in the [Cloud search + * Cheat + * Sheet](https://gsuite.google.com/learning-center/products/cloudsearch/cheat-sheet/) + */ + query?: string; + /** + * Options to interpret the user query. + */ + queryInterpretationOptions?: Schema$QueryInterpretationOptions; + /** + * Request options, such as the search application and user timezone. + */ + requestOptions?: Schema$RequestOptions; + /** + * The options for sorting the search results + */ + sortOptions?: Schema$SortOptions; + /** + * Starting index of the results. + */ + start?: number; + } + /** + * The search API response. + */ + export interface Schema$SearchResponse { + /** + * Debugging information about the response. + */ + debugInfo?: Schema$ResponseDebugInfo; + /** + * Error information about the response. + */ + errorInfo?: Schema$ErrorInfo; + /** + * Repeated facet results. + */ + facetResults?: Schema$FacetResult[]; + /** + * Whether there are more search results matching the query. + */ + hasMoreResults?: boolean; + /** + * Query interpretation result for user query. Empty if query interpretation + * is disabled. + */ + queryInterpretation?: Schema$QueryInterpretation; + /** + * The estimated result count for this query. + */ + resultCountEstimate?: string; + /** + * The exact result count for this query. + */ + resultCountExact?: string; + /** + * Expanded result count information. + */ + resultCounts?: Schema$ResultCounts; + /** + * Results from a search query. + */ + results?: Schema$SearchResult[]; + /** + * Suggested spelling for the query. + */ + spellResults?: Schema$SpellResult[]; + /** + * Structured results for the user query. These results are not counted + * against the page_size. + */ + structuredResults?: Schema$StructuredResult[]; + } + /** + * Results containing indexed information for a document. + */ + export interface Schema$SearchResult { + /** + * If source is clustered, provide list of clustered results. There will + * only be one level of clustered results. If current source is not enabled + * for clustering, this field will be empty. + */ + clusteredResults?: Schema$SearchResult[]; + /** + * Debugging information about this search result. + */ + debugInfo?: Schema$ResultDebugInfo; + /** + * Metadata of the search result. + */ + metadata?: Schema$Metadata; + /** + * The concatenation of all snippets (summaries) available for this result. + */ + snippet?: Schema$Snippet; + /** + * Title of the search result. + */ + title?: string; + /** + * The URL of the result. + */ + url?: string; + } + /** + * Snippet of the search result, which summarizes the content of the resulting + * page. + */ + export interface Schema$Snippet { + /** + * The matched ranges in the snippet. + */ + matchRanges?: Schema$MatchRange[]; + /** + * The snippet of the document. The snippet of the document. May contain + * escaped HTML character that should be unescaped prior to rendering. + */ + snippet?: string; + } + export interface Schema$SortOptions { + /** + * Name of the operator corresponding to the field to sort on. The + * corresponding property must be marked as sortable. + */ + operatorName?: string; + /** + * Ascending is the default sort order + */ + sortOrder?: string; + } + /** + * Defines sources for the suggest/search APIs. + */ + export interface Schema$Source { + /** + * Source name for content indexed by the Indexing API. + */ + name?: string; + /** + * Predefined content source for Google Apps. + */ + predefinedSource?: string; + } + /** + * Configurations for a source while processing a Search or Suggest request. + */ + export interface Schema$SourceConfig { + /** + * The crowding configuration for the source. + */ + crowdingConfig?: Schema$SourceCrowdingConfig; + /** + * The scoring configuration for the source. + */ + scoringConfig?: Schema$SourceScoringConfig; + /** + * The source for which this configuration is to be used. + */ + source?: Schema$Source; + } + /** + * Set search results crowding limits. Crowding is a situation in which + * multiple results from the same source or host "crowd out" other + * results, diminishing the quality of search for users. To foster better + * search quality and source diversity in search results, you can set a + * condition to reduce repetitive results by source. + */ + export interface Schema$SourceCrowdingConfig { + /** + * Use a field to control results crowding. For example, if you want to + * control overly similar results from Gmail topics, use `thread_id`. For + * similar pages from Google Sites, you can use `webspace_id`. When matching + * query results contain the same field value in `GenericMetadata`, crowding + * limits are set on those records. + */ + field?: string; + /** + * Maximum number of results allowed from a source. No limits will be set on + * results if this value is less than or equal to 0. + */ + numResults?: number; + /** + * Maximum number of suggestions allowed from a source. No limits will be + * set on results if this value is less than or equal to 0. + */ + numSuggestions?: number; + /** + * Control results by content source. This option limits the total number of + * results from a given source and ignores field-based crowding control. + */ + source?: boolean; + } + /** + * Per source result count information. + */ + export interface Schema$SourceResultCount { + /** + * Whether there are more search results for this source. + */ + hasMoreResults?: boolean; + /** + * The estimated result count for this source. + */ + resultCountEstimate?: string; + /** + * The exact result count for this source. + */ + resultCountExact?: string; + /** + * The source the result count information is associated with. + */ + source?: Schema$Source; + } + /** + * Set the scoring configuration. This allows modifying the ranking of results + * for a source. + */ + export interface Schema$SourceScoringConfig { + /** + * Importance of the source. + */ + sourceImportance?: string; + } + export interface Schema$SpellResult { + /** + * The suggested spelling of the query. + */ + suggestedQuery?: string; + } + /** + * Start upload file request. + */ + export interface Schema$StartUploadItemRequest { + /** + * Name of connector making this call. <br />Format: + * datasources/{source_id}/connectors/{ID} + */ + connectorName?: string; + /** + * Common debug options. + */ + debugOptions?: Schema$DebugOptions; + } + /** + * The `Status` type defines a logical error model that is suitable for + * different programming environments, including REST APIs and RPC APIs. It is + * used by [gRPC](https://github.com/grpc). The error model is designed to be: + * - Simple to use and understand for most users - Flexible enough to meet + * unexpected needs # Overview The `Status` message contains three pieces of + * data: error code, error message, and error details. The error code should + * be an enum value of google.rpc.Code, but it may accept additional error + * codes if needed. The error message should be a developer-facing English + * message that helps developers *understand* and *resolve* the error. If a + * localized user-facing error message is needed, put the localized message in + * the error details or localize it in the client. The optional error details + * may contain arbitrary information about the error. There is a predefined + * set of error detail types in the package `google.rpc` that can be used for + * common error conditions. # Language mapping The `Status` message is the + * logical representation of the error model, but it is not necessarily the + * actual wire format. When the `Status` message is exposed in different + * client libraries and different wire protocols, it can be mapped + * differently. For example, it will likely be mapped to some exceptions in + * Java, but more likely mapped to some error codes in C. # Other uses The + * error model and the `Status` message can be used in a variety of + * environments, either with or without APIs, to provide a consistent + * developer experience across different environments. Example uses of this + * error model include: - Partial errors. If a service needs to return + * partial errors to the client, it may embed the `Status` in the normal + * response to indicate the partial errors. - Workflow errors. A typical + * workflow has multiple steps. Each step may have a `Status` message for + * error reporting. - Batch operations. If a client uses batch request and + * batch response, the `Status` message should be used directly inside + * batch response, one for each error sub-response. - Asynchronous + * operations. If an API call embeds asynchronous operation results in its + * response, the status of those operations should be represented directly + * using the `Status` message. - Logging. If some API errors are stored in + * logs, the message `Status` could be used directly after any stripping + * needed for security/privacy reasons. + */ + export interface Schema$Status { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number; + /** + * A list of messages that carry the error details. There is a common set + * of message types for APIs to use. + */ + details?: any[]; + /** + * A developer-facing error message, which should be in English. Any + * user-facing error message should be localized and sent in the + * google.rpc.Status.details field, or localized by the client. + */ + message?: string; + } + /** + * A structured data object consisting of named properties. + */ + export interface Schema$StructuredDataObject { + /** + * The properties for the object. The maximum number of elements is 1000. + */ + properties?: Schema$NamedProperty[]; + } + /** + * Structured results that are returned as part of search request. + */ + export interface Schema$StructuredResult { + person?: Schema$Person; + } + /** + * Request of suggest API. + */ + export interface Schema$SuggestRequest { + /** + * The sources to use for suggestions. If not specified, all data sources + * from the current search application are used. + */ + dataSourceRestrictions?: Schema$DataSourceRestriction[]; + /** + * Partial query for the completion suggestion. + */ + query?: string; + /** + * Request options, such as the search application and user timezone. + */ + requestOptions?: Schema$RequestOptions; + } + /** + * Response of the suggest API. + */ + export interface Schema$SuggestResponse { + /** + * List of suggestion results. + */ + suggestResults?: Schema$SuggestResult[]; + } + /** + * One suggestion result. + */ + export interface Schema$SuggestResult { + peopleSuggestion?: Schema$PeopleSuggestion; + querySuggestion?: Schema$QuerySuggestion; + /** + * The source of the suggestion. + */ + source?: Schema$Source; + /** + * The suggested query that will be used for search, when the user clicks on + * the suggestion + */ + suggestedQuery?: string; + } + /** + * Used to provide a search operator for text properties. This is optional. + * Search operators let users restrict the query to specific fields relevant + * to the type of item being searched. + */ + export interface Schema$TextOperatorOptions { + /** + * If true, the text value will be tokenized as one atomic value in operator + * searches and facet matches. For example, if the operator name is + * "genre" and the value is "science-fiction" the query + * restrictions "genre:science" and "genre:fiction" will + * not match the item; "genre:science-fiction" will. Value + * matching is case-sensitive and does not remove special characters. If + * false, the text will be tokenized. For example, if the value is + * "science-fiction" the queries "genre:science" and + * "genre:fiction" will match the item. + */ + exactMatchWithOperator?: boolean; + /** + * Indicates the operator name required in the query in order to isolate the + * text property. For example, if operatorName is *subject* and the + * property's name is *subjectLine*, then queries like + * *subject:&lt;value&gt;* will show results only where the value of + * the property named *subjectLine* matches *&lt;value&gt;*. By + * contrast, a search that uses the same *&lt;value&gt;* without an + * operator will return all items where *&lt;value&gt;* matches the + * value of any text properties or text within the content field for the + * item. The operator name can only contain lowercase letters (a-z). The + * maximum length is 32 characters. + */ + operatorName?: string; + } + /** + * Options for text properties. + */ + export interface Schema$TextPropertyOptions { + /** + * If set, describes how the property should be used as a search operator. + */ + operatorOptions?: Schema$TextOperatorOptions; + /** + * Indicates the search quality importance of the tokens within the field + * when used for retrieval. + */ + retrievalImportance?: Schema$RetrievalImportance; + } + /** + * List of text values. + */ + export interface Schema$TextValues { + /** + * The maximum allowable length for text values is 2048 characters. The + * maximum number of string elements is 100. + */ + values?: string[]; + } + /** + * Used to provide a search operator for timestamp properties. This is + * optional. Search operators let users restrict the query to specific fields + * relevant to the type of item being searched. + */ + export interface Schema$TimestampOperatorOptions { + /** + * Indicates the operator name required in the query in order to isolate the + * timestamp property using the greater-than operator. For example, if + * greaterThanOperatorName is *closedafter* and the property's name is + * *closeDate*, then queries like *closedafter:&lt;value&gt;* will + * show results only where the value of the property named *closeDate* is + * later than *&lt;value&gt;*. The operator name can only contain + * lowercase letters (a-z). The maximum length is 32 characters. + */ + greaterThanOperatorName?: string; + /** + * Indicates the operator name required in the query in order to isolate the + * timestamp property using the less-than operator. For example, if + * lessThanOperatorName is *closedbefore* and the property's name is + * *closeDate*, then queries like *closedbefore:&lt;value&gt;* will + * show results only where the value of the property named *closeDate* is + * earlier than *&lt;value&gt;*. The operator name can only contain + * lowercase letters (a-z). The maximum length is 32 characters. + */ + lessThanOperatorName?: string; + /** + * Indicates the operator name required in the query in order to isolate the + * timestamp property. For example, if operatorName is *closedon* and the + * property's name is *closeDate*, then queries like + * *closedon:&lt;value&gt;* will show results only where the value + * of the property named *closeDate* matches *&lt;value&gt;*. By + * contrast, a search that uses the same *&lt;value&gt;* without an + * operator will return all items where *&lt;value&gt;* matches the + * value of any String properties or text within the content field for the + * item. The operator name can only contain lowercase letters (a-z). The + * maximum length is 32 characters. + */ + operatorName?: string; + } + /** + * Options for timestamp properties. + */ + export interface Schema$TimestampPropertyOptions { + /** + * If set, describes how the timestamp should be used as a search operator. + */ + operatorOptions?: Schema$TimestampOperatorOptions; + } + /** + * List of timestamp values. + */ + export interface Schema$TimestampValues { + /** + * The maximum number of elements is 100. + */ + values?: string[]; + } + export interface Schema$UnmappedIdentity { + /** + * The resource name for an external user. + */ + externalIdentity?: Schema$Principal; + /** + * The resolution status for the external identity. + */ + resolutionStatusCode?: string; + } + export interface Schema$UnreserveItemsRequest { + /** + * Name of connector making this call. <br />Format: + * datasources/{source_id}/connectors/{ID} + */ + connectorName?: string; + /** + * Common debug options. + */ + debugOptions?: Schema$DebugOptions; + /** + * Name of a queue to unreserve items from. + */ + queue?: string; + } + export interface Schema$UpdateDataSourceRequest { + /** + * Common debug options. + */ + debugOptions?: Schema$DebugOptions; + source?: Schema$DataSource; + } + export interface Schema$UpdateSchemaRequest { + /** + * Common debug options. + */ + debugOptions?: Schema$DebugOptions; + /** + * The new schema for the source. + */ + schema?: Schema$Schema; + /** + * If true, the request will be validated without side effects. + */ + validateOnly?: boolean; + } + /** + * Represents an upload session reference. This reference is created via + * upload method. Updating of item content may refer to this uploaded content + * via contentDataRef. + */ + export interface Schema$UploadItemRef { + /** + * Name of the content reference. The maximum length is 2048 characters. + */ + name?: string; + } + /** + * Definition of a single value with generic type. + */ + export interface Schema$Value { + booleanValue?: boolean; + dateValue?: Schema$Date; + doubleValue?: number; + integerValue?: string; + stringValue?: string; + timestampValue?: string; + } + export interface Schema$ValueFilter { + /** + * The `operator_name` applied to the query, such as *price_greater_than*. + * The filter can work against both types of filters defined in the schema + * for your data source: <br/><br/> 1. `operator_name`, where + * the query filters results by the property that matches the value. + * <br/> 2. `greater_than_operator_name` or `less_than_operator_name` + * in your schema. The query filters the results for the property values + * that are greater than or less than the supplied value in the query. + */ + operatorName?: string; + /** + * The value to be compared with. + */ + value?: Schema$Value; + } + + + export class Resource$Debug { + root: Cloudsearch; + datasources: Resource$Debug$Datasources; + identitysources: Resource$Debug$Identitysources; + constructor(root: Cloudsearch) { + this.root = root; + this.getRoot.bind(this); + this.datasources = new Resource$Debug$Datasources(root); + this.identitysources = new Resource$Debug$Identitysources(root); + } + + getRoot() { + return this.root; + } + } + + + export class Resource$Debug$Datasources { + root: Cloudsearch; + items: Resource$Debug$Datasources$Items; + constructor(root: Cloudsearch) { + this.root = root; + this.getRoot.bind(this); + this.items = new Resource$Debug$Datasources$Items(root); + } + + getRoot() { + return this.root; + } + } + + + export class Resource$Debug$Datasources$Items { + root: Cloudsearch; + unmappedids: Resource$Debug$Datasources$Items$Unmappedids; + constructor(root: Cloudsearch) { + this.root = root; + this.getRoot.bind(this); + this.unmappedids = new Resource$Debug$Datasources$Items$Unmappedids(root); + } + + getRoot() { + return this.root; + } + } + + + export class Resource$Debug$Datasources$Items$Unmappedids { + root: Cloudsearch; + constructor(root: Cloudsearch) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * cloudsearch.debug.datasources.items.unmappedids.list + * @desc List all unmapped identities for a specific item. + * @alias cloudsearch.debug.datasources.items.unmappedids.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize Maximum number of items to fetch in a request. Defaults to 100. + * @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any. + * @param {string} params.parent The name of the item, in the following format: datasources/{source_id}/items/{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 + */ + list( + params?: Params$Resource$Debug$Datasources$Items$Unmappedids$List, + options?: MethodOptions): + AxiosPromise; + list( + params: Params$Resource$Debug$Datasources$Items$Unmappedids$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + list( + params: Params$Resource$Debug$Datasources$Items$Unmappedids$List, + callback: BodyResponseCallback): + void; + list(callback: BodyResponseCallback): + void; + list( + paramsOrCallback?: + Params$Resource$Debug$Datasources$Items$Unmappedids$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Debug$Datasources$Items$Unmappedids$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Debug$Datasources$Items$Unmappedids$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/debug/{+parent}/unmappedids') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + } + + export interface Params$Resource$Debug$Datasources$Items$Unmappedids$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Maximum number of items to fetch in a request. Defaults to 100. + */ + pageSize?: number; + /** + * The next_page_token value returned from a previous List request, if any. + */ + pageToken?: string; + /** + * The name of the item, in the following format: + * datasources/{source_id}/items/{ID} + */ + parent?: string; + } + + + + export class Resource$Debug$Identitysources { + root: Cloudsearch; + items: Resource$Debug$Identitysources$Items; + unmappedids: Resource$Debug$Identitysources$Unmappedids; + constructor(root: Cloudsearch) { + this.root = root; + this.getRoot.bind(this); + this.items = new Resource$Debug$Identitysources$Items(root); + this.unmappedids = new Resource$Debug$Identitysources$Unmappedids(root); + } + + getRoot() { + return this.root; + } + } + + + export class Resource$Debug$Identitysources$Items { + root: Cloudsearch; + constructor(root: Cloudsearch) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * cloudsearch.debug.identitysources.items.listForunmappedidentity + * @desc Lists names of items associated with an unmapped identity. + * @alias cloudsearch.debug.identitysources.items.listForunmappedidentity + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.groupResourceName + * @param {integer=} params.pageSize Maximum number of items to fetch in a request. Defaults to 100. + * @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any. + * @param {string} params.parent The name of the identity source, in the following format: identitysources/{source_id}} + * @param {string=} params.userResourceName + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + listForunmappedidentity( + params?: + Params$Resource$Debug$Identitysources$Items$Listforunmappedidentity, + options?: MethodOptions): + AxiosPromise; + listForunmappedidentity( + params: + Params$Resource$Debug$Identitysources$Items$Listforunmappedidentity, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback< + Schema$ListItemNamesForUnmappedIdentityResponse>): void; + listForunmappedidentity( + params: + Params$Resource$Debug$Identitysources$Items$Listforunmappedidentity, + callback: BodyResponseCallback< + Schema$ListItemNamesForUnmappedIdentityResponse>): void; + listForunmappedidentity(callback: BodyResponseCallback< + Schema$ListItemNamesForUnmappedIdentityResponse>): + void; + listForunmappedidentity( + paramsOrCallback?: + Params$Resource$Debug$Identitysources$Items$Listforunmappedidentity| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$ListItemNamesForUnmappedIdentityResponse>): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Debug$Identitysources$Items$Listforunmappedidentity; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Debug$Identitysources$Items$Listforunmappedidentity; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/debug/{+parent}/items:forunmappedidentity') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest< + Schema$ListItemNamesForUnmappedIdentityResponse>(parameters); + } + } + } + + export interface Params$Resource$Debug$Identitysources$Items$Listforunmappedidentity + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * + */ + groupResourceName?: string; + /** + * Maximum number of items to fetch in a request. Defaults to 100. + */ + pageSize?: number; + /** + * The next_page_token value returned from a previous List request, if any. + */ + pageToken?: string; + /** + * The name of the identity source, in the following format: + * identitysources/{source_id}} + */ + parent?: string; + /** + * + */ + userResourceName?: string; + } + + + export class Resource$Debug$Identitysources$Unmappedids { + root: Cloudsearch; + constructor(root: Cloudsearch) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * cloudsearch.debug.identitysources.unmappedids.list + * @desc Lists unmapped user identities for an identity source. + * @alias cloudsearch.debug.identitysources.unmappedids.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize Maximum number of items to fetch in a request. Defaults to 100. + * @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any. + * @param {string} params.parent The name of the identity source, in the following format: identitysources/{source_id} + * @param {string=} params.resolutionStatusCode Limit users selection to this status. + * @param {object} [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$Debug$Identitysources$Unmappedids$List, + options?: MethodOptions): + AxiosPromise; + list( + params: Params$Resource$Debug$Identitysources$Unmappedids$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + list( + params: Params$Resource$Debug$Identitysources$Unmappedids$List, + callback: BodyResponseCallback): + void; + list(callback: BodyResponseCallback): + void; + list( + paramsOrCallback?: + Params$Resource$Debug$Identitysources$Unmappedids$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Debug$Identitysources$Unmappedids$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Debug$Identitysources$Unmappedids$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/debug/{+parent}/unmappedids') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + } + + export interface Params$Resource$Debug$Identitysources$Unmappedids$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Maximum number of items to fetch in a request. Defaults to 100. + */ + pageSize?: number; + /** + * The next_page_token value returned from a previous List request, if any. + */ + pageToken?: string; + /** + * The name of the identity source, in the following format: + * identitysources/{source_id} + */ + parent?: string; + /** + * Limit users selection to this status. + */ + resolutionStatusCode?: string; + } + + + + export class Resource$Indexing { + root: Cloudsearch; + datasources: Resource$Indexing$Datasources; + constructor(root: Cloudsearch) { + this.root = root; + this.getRoot.bind(this); + this.datasources = new Resource$Indexing$Datasources(root); + } + + getRoot() { + return this.root; + } + } + + + export class Resource$Indexing$Datasources { + root: Cloudsearch; + items: Resource$Indexing$Datasources$Items; + constructor(root: Cloudsearch) { + this.root = root; + this.getRoot.bind(this); + this.items = new Resource$Indexing$Datasources$Items(root); + } + + getRoot() { + return this.root; + } + + + /** + * cloudsearch.indexing.datasources.deleteSchema + * @desc Deletes the schema of a data source. + * @alias cloudsearch.indexing.datasources.deleteSchema + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. + * @param {string} params.name Name of the data source to delete Schema. Format: datasources/{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 + */ + deleteSchema( + params?: Params$Resource$Indexing$Datasources$Deleteschema, + options?: MethodOptions): AxiosPromise; + deleteSchema( + params: Params$Resource$Indexing$Datasources$Deleteschema, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + deleteSchema( + params: Params$Resource$Indexing$Datasources$Deleteschema, + callback: BodyResponseCallback): void; + deleteSchema(callback: BodyResponseCallback): void; + deleteSchema( + paramsOrCallback?: Params$Resource$Indexing$Datasources$Deleteschema| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Indexing$Datasources$Deleteschema; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Indexing$Datasources$Deleteschema; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/indexing/{+name}/schema') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * cloudsearch.indexing.datasources.getSchema + * @desc Gets the schema of a data source. + * @alias cloudsearch.indexing.datasources.getSchema + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. + * @param {string} params.name Name of the data source to get Schema. Format: datasources/{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 + */ + getSchema( + params?: Params$Resource$Indexing$Datasources$Getschema, + options?: MethodOptions): AxiosPromise; + getSchema( + params: Params$Resource$Indexing$Datasources$Getschema, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + getSchema( + params: Params$Resource$Indexing$Datasources$Getschema, + callback: BodyResponseCallback): void; + getSchema(callback: BodyResponseCallback): void; + getSchema( + paramsOrCallback?: Params$Resource$Indexing$Datasources$Getschema| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Indexing$Datasources$Getschema; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Indexing$Datasources$Getschema; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/indexing/{+name}/schema') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * cloudsearch.indexing.datasources.updateSchema + * @desc Updates the schema of a data source. + * @alias cloudsearch.indexing.datasources.updateSchema + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the data source to update Schema. Format: datasources/{source_id} + * @param {().UpdateSchemaRequest} 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 + */ + updateSchema( + params?: Params$Resource$Indexing$Datasources$Updateschema, + options?: MethodOptions): AxiosPromise; + updateSchema( + params: Params$Resource$Indexing$Datasources$Updateschema, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + updateSchema( + params: Params$Resource$Indexing$Datasources$Updateschema, + callback: BodyResponseCallback): void; + updateSchema(callback: BodyResponseCallback): void; + updateSchema( + paramsOrCallback?: Params$Resource$Indexing$Datasources$Updateschema| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Indexing$Datasources$Updateschema; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Indexing$Datasources$Updateschema; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/indexing/{+name}/schema') + .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$Indexing$Datasources$Deleteschema extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * If set, the request will enable debugging features of Cloud Search. Only + * turn on this field, if asked by Google to help with debugging. + */ + 'debugOptions.enableDebugging'?: boolean; + /** + * Name of the data source to delete Schema. Format: + * datasources/{source_id} + */ + name?: string; + } + export interface Params$Resource$Indexing$Datasources$Getschema extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * If set, the request will enable debugging features of Cloud Search. Only + * turn on this field, if asked by Google to help with debugging. + */ + 'debugOptions.enableDebugging'?: boolean; + /** + * Name of the data source to get Schema. Format: datasources/{source_id} + */ + name?: string; + } + export interface Params$Resource$Indexing$Datasources$Updateschema extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the data source to update Schema. Format: + * datasources/{source_id} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UpdateSchemaRequest; + } + + export class Resource$Indexing$Datasources$Items { + root: Cloudsearch; + constructor(root: Cloudsearch) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * cloudsearch.indexing.datasources.items.delete + * @desc Deletes Item resource for the specified resource name. + * @alias cloudsearch.indexing.datasources.items.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.connectorName Name of connector making this call.
Format: datasources/{source_id}/connectors/{ID} + * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. + * @param {string=} params.mode Required. The RequestMode for this request. + * @param {string} params.name Required. Name of the item to delete. Format: datasources/{source_id}/items/{item_id} + * @param {string=} params.version Required. The incremented version of the item to delete from the index. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering.

Cloud Search Indexing won't delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. + * @param {object} [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$Indexing$Datasources$Items$Delete, + options?: MethodOptions): AxiosPromise; + delete( + params: Params$Resource$Indexing$Datasources$Items$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Indexing$Datasources$Items$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Indexing$Datasources$Items$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Indexing$Datasources$Items$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Indexing$Datasources$Items$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/indexing/{+name}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * cloudsearch.indexing.datasources.items.deleteQueueItems + * @desc Deletes all items in a queue. This method is useful for deleting + * stale items. + * @alias cloudsearch.indexing.datasources.items.deleteQueueItems + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the Data Source to delete items in a queue. Format: datasources/{source_id} + * @param {().DeleteQueueItemsRequest} 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 + */ + deleteQueueItems( + params?: Params$Resource$Indexing$Datasources$Items$Deletequeueitems, + options?: MethodOptions): AxiosPromise; + deleteQueueItems( + params: Params$Resource$Indexing$Datasources$Items$Deletequeueitems, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + deleteQueueItems( + params: Params$Resource$Indexing$Datasources$Items$Deletequeueitems, + callback: BodyResponseCallback): void; + deleteQueueItems(callback: BodyResponseCallback): void; + deleteQueueItems( + paramsOrCallback?: + Params$Resource$Indexing$Datasources$Items$Deletequeueitems| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Indexing$Datasources$Items$Deletequeueitems; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Indexing$Datasources$Items$Deletequeueitems; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/indexing/{+name}/items:deleteQueueItems') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * cloudsearch.indexing.datasources.items.get + * @desc Gets Item resource by item name. + * @alias cloudsearch.indexing.datasources.items.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.connectorName Name of connector making this call.
Format: datasources/{source_id}/connectors/{ID} + * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. + * @param {string} params.name Name of the item to get info. Format: datasources/{source_id}/items/{item_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 + */ + get(params?: Params$Resource$Indexing$Datasources$Items$Get, + options?: MethodOptions): AxiosPromise; + get(params: Params$Resource$Indexing$Datasources$Items$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Indexing$Datasources$Items$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Indexing$Datasources$Items$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Indexing$Datasources$Items$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Indexing$Datasources$Items$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/indexing/{+name}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * cloudsearch.indexing.datasources.items.index + * @desc Updates Item ACL, metadata, and content. It will insert the Item if + * it does not exist. This method does not support partial updates. Fields + * with no provided values are cleared out in the Cloud Search index. + * @alias cloudsearch.indexing.datasources.items.index + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the Item. Format: datasources/{source_id}/items/{item_id}
This is a required field. The maximum length is 1536 characters. + * @param {().IndexItemRequest} 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 + */ + index( + params?: Params$Resource$Indexing$Datasources$Items$Index, + options?: MethodOptions): AxiosPromise; + index( + params: Params$Resource$Indexing$Datasources$Items$Index, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + index( + params: Params$Resource$Indexing$Datasources$Items$Index, + callback: BodyResponseCallback): void; + index(callback: BodyResponseCallback): void; + index( + paramsOrCallback?: Params$Resource$Indexing$Datasources$Items$Index| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Indexing$Datasources$Items$Index; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Indexing$Datasources$Items$Index; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/indexing/{+name}:index') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * cloudsearch.indexing.datasources.items.list + * @desc Lists all or a subset of Item resources. + * @alias cloudsearch.indexing.datasources.items.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.brief When set to true, the indexing system only populates the following fields: name, version, metadata.hash, structured_data.hash, content.hash.
If this value is false, then all the fields are populated in Item. + * @param {string=} params.connectorName Name of connector making this call.
Format: datasources/{source_id}/connectors/{ID} + * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. + * @param {string} params.name Name of the Data Source to list Items. Format: datasources/{source_id} + * @param {integer=} params.pageSize Maximum number of items to fetch in a request. The max value is 1000 when brief is true. The max value is 10 if brief is false.
The default value is 10 + * @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any. + * @param {object} [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$Indexing$Datasources$Items$List, + options?: MethodOptions): AxiosPromise; + list( + params: Params$Resource$Indexing$Datasources$Items$List, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Indexing$Datasources$Items$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Indexing$Datasources$Items$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Indexing$Datasources$Items$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Indexing$Datasources$Items$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/indexing/{+name}/items') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * cloudsearch.indexing.datasources.items.poll + * @desc Polls for unreserved items from the indexing queue and marks a set + * as reserved, starting with items that have the oldest timestamp from the + * highest priority ItemStatus. The priority order is as follows:
+ * ERROR
MODIFIED
NEW_ITEM
ACCEPTED
Reserving + * items ensures that polling from other threads cannot create overlapping + * sets. After handling the reserved items, the client should put items + * back into the unreserved state, either by calling index, or by calling + * push with the type REQUEUE. Items automatically become available + * (unreserved) after 4 hours even if no update or push method is called. + * @alias cloudsearch.indexing.datasources.items.poll + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the Data Source to poll items. Format: datasources/{source_id} + * @param {().PollItemsRequest} 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 + */ + poll( + params?: Params$Resource$Indexing$Datasources$Items$Poll, + options?: MethodOptions): AxiosPromise; + poll( + params: Params$Resource$Indexing$Datasources$Items$Poll, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + poll( + params: Params$Resource$Indexing$Datasources$Items$Poll, + callback: BodyResponseCallback): void; + poll(callback: BodyResponseCallback): void; + poll( + paramsOrCallback?: Params$Resource$Indexing$Datasources$Items$Poll| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Indexing$Datasources$Items$Poll; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Indexing$Datasources$Items$Poll; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/indexing/{+name}/items:poll') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * cloudsearch.indexing.datasources.items.push + * @desc Pushes an item onto a queue for later polling and updating. + * @alias cloudsearch.indexing.datasources.items.push + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the item to push into the indexing queue.
Format: datasources/{source_id}/items/{ID}
This is a required field. The maximum length is 1536 characters. + * @param {().PushItemRequest} 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 + */ + push( + params?: Params$Resource$Indexing$Datasources$Items$Push, + options?: MethodOptions): AxiosPromise; + push( + params: Params$Resource$Indexing$Datasources$Items$Push, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + push( + params: Params$Resource$Indexing$Datasources$Items$Push, + callback: BodyResponseCallback): void; + push(callback: BodyResponseCallback): void; + push( + paramsOrCallback?: Params$Resource$Indexing$Datasources$Items$Push| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Indexing$Datasources$Items$Push; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Indexing$Datasources$Items$Push; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/indexing/{+name}:push') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * cloudsearch.indexing.datasources.items.unreserve + * @desc Unreserves all items from a queue, making them all eligible to be + * polled. This method is useful for resetting the indexing queue after a + * connector has been restarted. + * @alias cloudsearch.indexing.datasources.items.unreserve + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the Data Source to unreserve all items. Format: datasources/{source_id} + * @param {().UnreserveItemsRequest} 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 + */ + unreserve( + params?: Params$Resource$Indexing$Datasources$Items$Unreserve, + options?: MethodOptions): AxiosPromise; + unreserve( + params: Params$Resource$Indexing$Datasources$Items$Unreserve, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + unreserve( + params: Params$Resource$Indexing$Datasources$Items$Unreserve, + callback: BodyResponseCallback): void; + unreserve(callback: BodyResponseCallback): void; + unreserve( + paramsOrCallback?: Params$Resource$Indexing$Datasources$Items$Unreserve| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Indexing$Datasources$Items$Unreserve; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Indexing$Datasources$Items$Unreserve; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/indexing/{+name}/items:unreserve') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * cloudsearch.indexing.datasources.items.upload + * @desc Creates an upload session for uploading item content. For items + * smaller than 100 KiB, it's easier to embed the content inline within + * update. + * @alias cloudsearch.indexing.datasources.items.upload + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the Data Source to start a resumable upload. Format: datasources/{source_id} + * @param {().StartUploadItemRequest} 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 + */ + upload( + params?: Params$Resource$Indexing$Datasources$Items$Upload, + options?: MethodOptions): AxiosPromise; + upload( + params: Params$Resource$Indexing$Datasources$Items$Upload, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + upload( + params: Params$Resource$Indexing$Datasources$Items$Upload, + callback: BodyResponseCallback): void; + upload(callback: BodyResponseCallback): void; + upload( + paramsOrCallback?: Params$Resource$Indexing$Datasources$Items$Upload| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Indexing$Datasources$Items$Upload; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Indexing$Datasources$Items$Upload; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/indexing/{+name}:upload') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Indexing$Datasources$Items$Delete extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of connector making this call.
Format: + * datasources/{source_id}/connectors/{ID} + */ + connectorName?: string; + /** + * If set, the request will enable debugging features of Cloud Search. Only + * turn on this field, if asked by Google to help with debugging. + */ + 'debugOptions.enableDebugging'?: boolean; + /** + * Required. The RequestMode for this request. + */ + mode?: string; + /** + * Required. Name of the item to delete. Format: + * datasources/{source_id}/items/{item_id} + */ + name?: string; + /** + * Required. The incremented version of the item to delete from the index. + * The indexing system stores the version from the datasource as a byte + * string and compares the Item version in the index to the version of the + * queued Item using lexical ordering.

Cloud Search Indexing + * won't delete any queued item with a version value that is less than or + * equal to the version of the currently indexed item. The maximum length + * for this field is 1024 bytes. + */ + version?: string; + } + export interface Params$Resource$Indexing$Datasources$Items$Deletequeueitems + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the Data Source to delete items in a queue. Format: + * datasources/{source_id} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DeleteQueueItemsRequest; + } + export interface Params$Resource$Indexing$Datasources$Items$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of connector making this call.
Format: + * datasources/{source_id}/connectors/{ID} + */ + connectorName?: string; + /** + * If set, the request will enable debugging features of Cloud Search. Only + * turn on this field, if asked by Google to help with debugging. + */ + 'debugOptions.enableDebugging'?: boolean; + /** + * Name of the item to get info. Format: + * datasources/{source_id}/items/{item_id} + */ + name?: string; + } + export interface Params$Resource$Indexing$Datasources$Items$Index extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the Item. Format: datasources/{source_id}/items/{item_id}
This is a required field. The maximum length is 1536 characters. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$IndexItemRequest; + } + export interface Params$Resource$Indexing$Datasources$Items$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * When set to true, the indexing system only populates the following + * fields: name, version, metadata.hash, structured_data.hash, content.hash. + *
If this value is false, then all the fields are populated in Item. + */ + brief?: boolean; + /** + * Name of connector making this call.
Format: + * datasources/{source_id}/connectors/{ID} + */ + connectorName?: string; + /** + * If set, the request will enable debugging features of Cloud Search. Only + * turn on this field, if asked by Google to help with debugging. + */ + 'debugOptions.enableDebugging'?: boolean; + /** + * Name of the Data Source to list Items. Format: datasources/{source_id} + */ + name?: string; + /** + * Maximum number of items to fetch in a request. The max value is 1000 when + * brief is true. The max value is 10 if brief is false.
The default + * value is 10 + */ + pageSize?: number; + /** + * The next_page_token value returned from a previous List request, if any. + */ + pageToken?: string; + } + export interface Params$Resource$Indexing$Datasources$Items$Poll extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the Data Source to poll items. Format: datasources/{source_id} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PollItemsRequest; + } + export interface Params$Resource$Indexing$Datasources$Items$Push extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the item to push into the indexing queue.
Format: + * datasources/{source_id}/items/{ID}
This is a required field. The + * maximum length is 1536 characters. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PushItemRequest; + } + export interface Params$Resource$Indexing$Datasources$Items$Unreserve extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the Data Source to unreserve all items. Format: + * datasources/{source_id} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UnreserveItemsRequest; + } + export interface Params$Resource$Indexing$Datasources$Items$Upload extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the Data Source to start a resumable upload. Format: + * datasources/{source_id} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$StartUploadItemRequest; + } + + + + export class Resource$Media { + root: Cloudsearch; + constructor(root: Cloudsearch) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * cloudsearch.media.upload + * @desc Uploads media for indexing. The upload endpoint supports direct + * and resumable upload protocols and is intended for large items that can + * not be inlined during index requests. To index large content: 1. Call + * upload to begin a session and get the item reference. 1. Upload the + * content using the item reference's resource name. 1. Call index with the + * item reference as the content. For additional information, see + * [Create a content connector using the REST + * API](https://developers.google.com/cloud-search/docs/guides/content-connector#rest). + * @alias cloudsearch.media.upload + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resourceName Name of the media that is being downloaded. See ReadRequest.resource_name. + * @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 {callback} callback The callback that handles the response. + * @return {object} Request object + */ + upload(params?: Params$Resource$Media$Upload, options?: MethodOptions): + AxiosPromise; + upload( + params: Params$Resource$Media$Upload, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + upload( + params: Params$Resource$Media$Upload, + callback: BodyResponseCallback): void; + upload(callback: BodyResponseCallback): void; + upload( + paramsOrCallback?: Params$Resource$Media$Upload| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Media$Upload; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Media$Upload; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/media/{+resourceName}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + mediaUrl: (rootUrl + '/upload/v1/media/{+resourceName}') + .replace(/([^:]\/)\/+/g, '$1'), + requiredParams: ['resourceName'], + pathParams: ['resourceName'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Media$Upload extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the media that is being downloaded. See + * ReadRequest.resource_name. + */ + resourceName?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Media; + + /** + * Media metadata + */ + media?: { + /** + * Media mime-type + */ + mediaType?: string; + + /** + * Media body contents + */ + body?: any; + }; + } + + + export class Resource$Operations { + root: Cloudsearch; + constructor(root: Cloudsearch) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * cloudsearch.operations.get + * @desc Gets the latest state of a long-running operation. Clients can use + * this method to poll the operation result at intervals as recommended by + * the API service. + * @alias cloudsearch.operations.get + * @memberOf! () + * + * @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 {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Operations$Get, + options?: MethodOptions): AxiosPromise; + get(params: Params$Resource$Operations$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Operations$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Operations$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Operations$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the operation resource. + */ + name?: string; + } + + + export class Resource$Query { + root: Cloudsearch; + sources: Resource$Query$Sources; + constructor(root: Cloudsearch) { + this.root = root; + this.getRoot.bind(this); + this.sources = new Resource$Query$Sources(root); + } + + getRoot() { + return this.root; + } + + + /** + * cloudsearch.query.search + * @desc The Cloud Search Query API provides the search method, which + * returns the most relevant results from a user query. The results can + * come from G Suite Apps, such as Gmail or Google Drive, or they can come + * from data that you have indexed from a third party. + * @alias cloudsearch.query.search + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().SearchRequest} 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 + */ + search(params?: Params$Resource$Query$Search, options?: MethodOptions): + AxiosPromise; + search( + params: Params$Resource$Query$Search, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + search( + params: Params$Resource$Query$Search, + callback: BodyResponseCallback): void; + search(callback: BodyResponseCallback): void; + search( + paramsOrCallback?: Params$Resource$Query$Search| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Query$Search; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Query$Search; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/query/search').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: [], + pathParams: [], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * cloudsearch.query.suggest + * @desc Provides suggestions for autocompleting the query. + * @alias cloudsearch.query.suggest + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().SuggestRequest} 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 + */ + suggest(params?: Params$Resource$Query$Suggest, options?: MethodOptions): + AxiosPromise; + suggest( + params: Params$Resource$Query$Suggest, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + suggest( + params: Params$Resource$Query$Suggest, + callback: BodyResponseCallback): void; + suggest(callback: BodyResponseCallback): void; + suggest( + paramsOrCallback?: Params$Resource$Query$Suggest| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Query$Suggest; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Query$Suggest; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + '/v1/query/suggest').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: [], + pathParams: [], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Query$Search extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + + /** + * Request body metadata + */ + requestBody?: Schema$SearchRequest; + } + export interface Params$Resource$Query$Suggest extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + + /** + * Request body metadata + */ + requestBody?: Schema$SuggestRequest; + } + + export class Resource$Query$Sources { + root: Cloudsearch; + constructor(root: Cloudsearch) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * cloudsearch.query.sources.list + * @desc Returns list of sources that user can use for Search and Suggest + * APIs. + * @alias cloudsearch.query.sources.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.pageToken Number of sources to return in the response. + * @param {boolean=} params.requestOptions.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. + * @param {string=} params.requestOptions.languageCode The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. + * @param {string=} params.requestOptions.searchApplicationId Id of the application created using SearchApplicationsService. + * @param {string=} params.requestOptions.timeZone Current user's time zone id, such as "America/Los_Angeles" or "Australia/Sydney". These IDs are defined by [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and currently available in the file [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml) + * @param {object} [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$Query$Sources$List, options?: MethodOptions): + AxiosPromise; + list( + params: Params$Resource$Query$Sources$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Query$Sources$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Query$Sources$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Query$Sources$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Query$Sources$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + '/v1/query/sources').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: [], + pathParams: [], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Query$Sources$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Number of sources to return in the response. + */ + pageToken?: string; + /** + * If set, the request will enable debugging features of Cloud Search. Only + * turn on this field, if asked by Google to help with debugging. + */ + 'requestOptions.debugOptions.enableDebugging'?: boolean; + /** + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more + * information, see + * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For + * translations. + */ + 'requestOptions.languageCode'?: string; + /** + * Id of the application created using SearchApplicationsService. + */ + 'requestOptions.searchApplicationId'?: string; + /** + * Current user's time zone id, such as "America/Los_Angeles" or + * "Australia/Sydney". These IDs are defined by [Unicode Common Locale Data + * Repository (CLDR)](http://cldr.unicode.org/) project, and currently + * available in the file + * [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml) + */ + 'requestOptions.timeZone'?: string; + } + + + + export class Resource$Settings { + root: Cloudsearch; + datasources: Resource$Settings$Datasources; + searchapplications: Resource$Settings$Searchapplications; + constructor(root: Cloudsearch) { + this.root = root; + this.getRoot.bind(this); + this.datasources = new Resource$Settings$Datasources(root); + this.searchapplications = new Resource$Settings$Searchapplications(root); + } + + getRoot() { + return this.root; + } + } + + + export class Resource$Settings$Datasources { + root: Cloudsearch; + constructor(root: Cloudsearch) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * cloudsearch.settings.datasources.create + * @desc Creates data source. + * @alias cloudsearch.settings.datasources.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().DataSource} 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$Settings$Datasources$Create, + options?: MethodOptions): AxiosPromise; + create( + params: Params$Resource$Settings$Datasources$Create, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + create( + params: Params$Resource$Settings$Datasources$Create, + callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: Params$Resource$Settings$Datasources$Create| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Settings$Datasources$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Settings$Datasources$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/settings/datasources') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: [], + pathParams: [], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * cloudsearch.settings.datasources.delete + * @desc Deletes a data source. + * @alias cloudsearch.settings.datasources.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. + * @param {string} params.name Name of the data source. Format: datasources/{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 + */ + delete( + params?: Params$Resource$Settings$Datasources$Delete, + options?: MethodOptions): AxiosPromise; + delete( + params: Params$Resource$Settings$Datasources$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Settings$Datasources$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Settings$Datasources$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Settings$Datasources$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Settings$Datasources$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/settings/{+name}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * cloudsearch.settings.datasources.get + * @desc Gets a data source. + * @alias cloudsearch.settings.datasources.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. + * @param {string} params.name Name of the data source resource. Format: datasources/{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 + */ + get(params?: Params$Resource$Settings$Datasources$Get, + options?: MethodOptions): AxiosPromise; + get(params: Params$Resource$Settings$Datasources$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Settings$Datasources$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Settings$Datasources$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Settings$Datasources$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Settings$Datasources$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/settings/{+name}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * cloudsearch.settings.datasources.list + * @desc Lists data sources. + * @alias cloudsearch.settings.datasources.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. + * @param {integer=} params.pageSize Maximum number of data sources to fetch in a request. The max value is 100.
The default value is 10 + * @param {string=} params.pageToken Starting index of the 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 + */ + list( + params?: Params$Resource$Settings$Datasources$List, + options?: MethodOptions): AxiosPromise; + list( + params: Params$Resource$Settings$Datasources$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Settings$Datasources$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Settings$Datasources$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Settings$Datasources$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Settings$Datasources$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/settings/datasources') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: [], + pathParams: [], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * cloudsearch.settings.datasources.update + * @desc Updates a data source. + * @alias cloudsearch.settings.datasources.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the data source resource. Format: datasources/{source_id}.
The name is ignored when creating a data source. + * @param {().UpdateDataSourceRequest} 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$Settings$Datasources$Update, + options?: MethodOptions): AxiosPromise; + update( + params: Params$Resource$Settings$Datasources$Update, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Settings$Datasources$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: Params$Resource$Settings$Datasources$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Settings$Datasources$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Settings$Datasources$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/settings/{+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$Settings$Datasources$Create extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + + /** + * Request body metadata + */ + requestBody?: Schema$DataSource; + } + export interface Params$Resource$Settings$Datasources$Delete extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * If set, the request will enable debugging features of Cloud Search. Only + * turn on this field, if asked by Google to help with debugging. + */ + 'debugOptions.enableDebugging'?: boolean; + /** + * Name of the data source. Format: datasources/{source_id}. + */ + name?: string; + } + export interface Params$Resource$Settings$Datasources$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * If set, the request will enable debugging features of Cloud Search. Only + * turn on this field, if asked by Google to help with debugging. + */ + 'debugOptions.enableDebugging'?: boolean; + /** + * Name of the data source resource. Format: datasources/{source_id}. + */ + name?: string; + } + export interface Params$Resource$Settings$Datasources$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * If set, the request will enable debugging features of Cloud Search. Only + * turn on this field, if asked by Google to help with debugging. + */ + 'debugOptions.enableDebugging'?: boolean; + /** + * Maximum number of data sources to fetch in a request. The max value is + * 100.
The default value is 10 + */ + pageSize?: number; + /** + * Starting index of the results. + */ + pageToken?: string; + } + export interface Params$Resource$Settings$Datasources$Update extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the data source resource. Format: datasources/{source_id}.
The name is ignored when creating a data source. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UpdateDataSourceRequest; + } + + + export class Resource$Settings$Searchapplications { + root: Cloudsearch; + constructor(root: Cloudsearch) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * cloudsearch.settings.searchapplications.create + * @desc Creates a search application. + * @alias cloudsearch.settings.searchapplications.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().SearchApplication} 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$Settings$Searchapplications$Create, + options?: MethodOptions): AxiosPromise; + create( + params: Params$Resource$Settings$Searchapplications$Create, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + create( + params: Params$Resource$Settings$Searchapplications$Create, + callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: Params$Resource$Settings$Searchapplications$Create| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Settings$Searchapplications$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Settings$Searchapplications$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/settings/searchapplications') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: [], + pathParams: [], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * cloudsearch.settings.searchapplications.delete + * @desc Deletes a search application. + * @alias cloudsearch.settings.searchapplications.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. + * @param {string} params.name The name of the search application to be deleted.
Format: applications/{application_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 + */ + delete( + params?: Params$Resource$Settings$Searchapplications$Delete, + options?: MethodOptions): AxiosPromise; + delete( + params: Params$Resource$Settings$Searchapplications$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Settings$Searchapplications$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Settings$Searchapplications$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Settings$Searchapplications$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Settings$Searchapplications$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/settings/{+name}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * cloudsearch.settings.searchapplications.get + * @desc Gets the specified search application. + * @alias cloudsearch.settings.searchapplications.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. + * @param {string} params.name Name of the search application.
Format: applications/{application_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 + */ + get(params?: Params$Resource$Settings$Searchapplications$Get, + options?: MethodOptions): AxiosPromise; + get(params: Params$Resource$Settings$Searchapplications$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Settings$Searchapplications$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Settings$Searchapplications$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Settings$Searchapplications$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Settings$Searchapplications$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/settings/{+name}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * cloudsearch.settings.searchapplications.list + * @desc Lists all search applications. + * @alias cloudsearch.settings.searchapplications.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. + * @param {integer=} params.pageSize The maximum number of items to return. + * @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any.
The default value is 10 + * @param {object} [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$Settings$Searchapplications$List, + options?: MethodOptions): + AxiosPromise; + list( + params: Params$Resource$Settings$Searchapplications$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + list( + params: Params$Resource$Settings$Searchapplications$List, + callback: BodyResponseCallback): + void; + list(callback: BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Settings$Searchapplications$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Settings$Searchapplications$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Settings$Searchapplications$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/settings/searchapplications') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: [], + pathParams: [], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + + + /** + * cloudsearch.settings.searchapplications.reset + * @desc Resets a search application to default settings. This will return + * an empty response. + * @alias cloudsearch.settings.searchapplications.reset + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the search application to be reset.
Format: applications/{application_id}. + * @param {().ResetSearchApplicationRequest} 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 + */ + reset( + params?: Params$Resource$Settings$Searchapplications$Reset, + options?: MethodOptions): AxiosPromise; + reset( + params: Params$Resource$Settings$Searchapplications$Reset, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + reset( + params: Params$Resource$Settings$Searchapplications$Reset, + callback: BodyResponseCallback): void; + reset(callback: BodyResponseCallback): void; + reset( + paramsOrCallback?: Params$Resource$Settings$Searchapplications$Reset| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Settings$Searchapplications$Reset; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Settings$Searchapplications$Reset; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/settings/{+name}:reset') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * cloudsearch.settings.searchapplications.update + * @desc Updates a search application. + * @alias cloudsearch.settings.searchapplications.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the Search Application.
Format: searchapplications/{application_id}. + * @param {().SearchApplication} 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$Settings$Searchapplications$Update, + options?: MethodOptions): AxiosPromise; + update( + params: Params$Resource$Settings$Searchapplications$Update, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Settings$Searchapplications$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: Params$Resource$Settings$Searchapplications$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Settings$Searchapplications$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Settings$Searchapplications$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/settings/{+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$Settings$Searchapplications$Create extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + + /** + * Request body metadata + */ + requestBody?: Schema$SearchApplication; + } + export interface Params$Resource$Settings$Searchapplications$Delete extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * If set, the request will enable debugging features of Cloud Search. Only + * turn on this field, if asked by Google to help with debugging. + */ + 'debugOptions.enableDebugging'?: boolean; + /** + * The name of the search application to be deleted.
Format: + * applications/{application_id}. + */ + name?: string; + } + export interface Params$Resource$Settings$Searchapplications$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * If set, the request will enable debugging features of Cloud Search. Only + * turn on this field, if asked by Google to help with debugging. + */ + 'debugOptions.enableDebugging'?: boolean; + /** + * Name of the search application.
Format: + * applications/{application_id}. + */ + name?: string; + } + export interface Params$Resource$Settings$Searchapplications$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * If set, the request will enable debugging features of Cloud Search. Only + * turn on this field, if asked by Google to help with debugging. + */ + 'debugOptions.enableDebugging'?: boolean; + /** + * The maximum number of items to return. + */ + pageSize?: number; + /** + * The next_page_token value returned from a previous List request, if any. + *
The default value is 10 + */ + pageToken?: string; + } + export interface Params$Resource$Settings$Searchapplications$Reset extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the search application to be reset.
Format: + * applications/{application_id}. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ResetSearchApplicationRequest; + } + export interface Params$Resource$Settings$Searchapplications$Update extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the Search Application.
Format: + * searchapplications/{application_id}. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SearchApplication; + } + + + + export class Resource$Stats { + root: Cloudsearch; + index: Resource$Stats$Index; + constructor(root: Cloudsearch) { + this.root = root; + this.getRoot.bind(this); + this.index = new Resource$Stats$Index(root); + } + + getRoot() { + return this.root; + } + + + /** + * cloudsearch.stats.getIndex + * @desc Gets indexed item statistics aggreggated across all data sources. + * @alias cloudsearch.stats.getIndex + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.fromDate.day Day of month. Must be from 1 to 31 and valid for the year and month. + * @param {integer=} params.fromDate.month Month of date. Must be from 1 to 12. + * @param {integer=} params.fromDate.year Year of date. Must be from 1 to 9999. + * @param {integer=} params.toDate.day Day of month. Must be from 1 to 31 and valid for the year and month. + * @param {integer=} params.toDate.month Month of date. Must be from 1 to 12. + * @param {integer=} params.toDate.year Year of date. Must be from 1 to 9999. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIndex(params?: Params$Resource$Stats$Getindex, options?: MethodOptions): + AxiosPromise; + getIndex( + params: Params$Resource$Stats$Getindex, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + getIndex( + params: Params$Resource$Stats$Getindex, + callback: BodyResponseCallback): + void; + getIndex(callback: + BodyResponseCallback): + void; + getIndex( + paramsOrCallback?: Params$Resource$Stats$Getindex| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Stats$Getindex; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Stats$Getindex; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/stats/index').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: [], + pathParams: [], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + } + + export interface Params$Resource$Stats$Getindex extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Day of month. Must be from 1 to 31 and valid for the year and month. + */ + 'fromDate.day'?: number; + /** + * Month of date. Must be from 1 to 12. + */ + 'fromDate.month'?: number; + /** + * Year of date. Must be from 1 to 9999. + */ + 'fromDate.year'?: number; + /** + * Day of month. Must be from 1 to 31 and valid for the year and month. + */ + 'toDate.day'?: number; + /** + * Month of date. Must be from 1 to 12. + */ + 'toDate.month'?: number; + /** + * Year of date. Must be from 1 to 9999. + */ + 'toDate.year'?: number; + } + + export class Resource$Stats$Index { + root: Cloudsearch; + datasources: Resource$Stats$Index$Datasources; + constructor(root: Cloudsearch) { + this.root = root; + this.getRoot.bind(this); + this.datasources = new Resource$Stats$Index$Datasources(root); + } + + getRoot() { + return this.root; + } + } + + + export class Resource$Stats$Index$Datasources { + root: Cloudsearch; + constructor(root: Cloudsearch) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * cloudsearch.stats.index.datasources.get + * @desc Gets indexed item statistics for a single data source. + * @alias cloudsearch.stats.index.datasources.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.fromDate.day Day of month. Must be from 1 to 31 and valid for the year and month. + * @param {integer=} params.fromDate.month Month of date. Must be from 1 to 12. + * @param {integer=} params.fromDate.year Year of date. Must be from 1 to 9999. + * @param {string} params.name The resource id of the data source to retrieve statistics for, in the following format: "datasources/{source_id}" + * @param {integer=} params.toDate.day Day of month. Must be from 1 to 31 and valid for the year and month. + * @param {integer=} params.toDate.month Month of date. Must be from 1 to 12. + * @param {integer=} params.toDate.year Year of date. Must be from 1 to 9999. + * @param {object} [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$Stats$Index$Datasources$Get, + options?: MethodOptions): + AxiosPromise; + get(params: Params$Resource$Stats$Index$Datasources$Get, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + get(params: Params$Resource$Stats$Index$Datasources$Get, + callback: BodyResponseCallback): + void; + get(callback: BodyResponseCallback): + void; + get(paramsOrCallback?: Params$Resource$Stats$Index$Datasources$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: + BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Stats$Index$Datasources$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Stats$Index$Datasources$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/stats/index/{+name}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + } + + export interface Params$Resource$Stats$Index$Datasources$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Day of month. Must be from 1 to 31 and valid for the year and month. + */ + 'fromDate.day'?: number; + /** + * Month of date. Must be from 1 to 12. + */ + 'fromDate.month'?: number; + /** + * Year of date. Must be from 1 to 9999. + */ + 'fromDate.year'?: number; + /** + * The resource id of the data source to retrieve statistics for, in the + * following format: "datasources/{source_id}" + */ + name?: string; + /** + * Day of month. Must be from 1 to 31 and valid for the year and month. + */ + 'toDate.day'?: number; + /** + * Month of date. Must be from 1 to 12. + */ + 'toDate.month'?: number; + /** + * Year of date. Must be from 1 to 9999. + */ + 'toDate.year'?: number; + } +} diff --git a/src/apis/cloudshell/v1.ts b/src/apis/cloudshell/v1.ts index 9f2e3bef8b..e752916c37 100644 --- a/src/apis/cloudshell/v1.ts +++ b/src/apis/cloudshell/v1.ts @@ -29,6 +29,57 @@ export namespace cloudshell_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Shell API * @@ -572,7 +623,8 @@ export namespace cloudshell_v1 { } } - export interface Params$Resource$Operations$Cancel { + export interface Params$Resource$Operations$Cancel extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -588,7 +640,8 @@ export namespace cloudshell_v1 { */ requestBody?: Schema$CancelOperationRequest; } - export interface Params$Resource$Operations$Delete { + export interface Params$Resource$Operations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -599,7 +652,7 @@ export namespace cloudshell_v1 { */ name?: string; } - export interface Params$Resource$Operations$Get { + export interface Params$Resource$Operations$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -610,7 +663,7 @@ export namespace cloudshell_v1 { */ name?: string; } - export interface Params$Resource$Operations$List { + export interface Params$Resource$Operations$List extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/cloudshell/v1alpha1.ts b/src/apis/cloudshell/v1alpha1.ts index a883e2caed..af33603075 100644 --- a/src/apis/cloudshell/v1alpha1.ts +++ b/src/apis/cloudshell/v1alpha1.ts @@ -29,6 +29,57 @@ export namespace cloudshell_v1alpha1 { version: 'v1alpha1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Shell API * @@ -597,7 +648,8 @@ export namespace cloudshell_v1alpha1 { } } - export interface Params$Resource$Users$Environments$Authorize { + export interface Params$Resource$Users$Environments$Authorize extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -615,7 +667,8 @@ export namespace cloudshell_v1alpha1 { */ requestBody?: Schema$AuthorizeEnvironmentRequest; } - export interface Params$Resource$Users$Environments$Get { + export interface Params$Resource$Users$Environments$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -628,7 +681,8 @@ export namespace cloudshell_v1alpha1 { */ name?: string; } - export interface Params$Resource$Users$Environments$Patch { + export interface Params$Resource$Users$Environments$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -650,7 +704,8 @@ export namespace cloudshell_v1alpha1 { */ requestBody?: Schema$Environment; } - export interface Params$Resource$Users$Environments$Start { + export interface Params$Resource$Users$Environments$Start extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -820,7 +875,8 @@ export namespace cloudshell_v1alpha1 { } } - export interface Params$Resource$Users$Environments$Publickeys$Create { + export interface Params$Resource$Users$Environments$Publickeys$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -836,7 +892,8 @@ export namespace cloudshell_v1alpha1 { */ requestBody?: Schema$CreatePublicKeyRequest; } - export interface Params$Resource$Users$Environments$Publickeys$Delete { + export interface Params$Resource$Users$Environments$Publickeys$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/cloudtasks/v2beta2.ts b/src/apis/cloudtasks/v2beta2.ts index 1e8a572b93..47d794999d 100644 --- a/src/apis/cloudtasks/v2beta2.ts +++ b/src/apis/cloudtasks/v2beta2.ts @@ -29,6 +29,57 @@ export namespace cloudtasks_v2beta2 { version: 'v2beta2'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Tasks API * @@ -88,17 +139,28 @@ export namespace cloudtasks_v2beta2 { * Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) * and how routing is affected by [dispatch * files](https://cloud.google.com/appengine/docs/python/config/dispatchref). - * The AppEngineRouting used to construct the URL that the task is delivered - * to can be set at the queue-level or task-level: * If set, - * app_engine_routing_override is used for all tasks in the queue, no - * matter what the setting is for the task-level app_engine_routing. The - * `url` that the task will be sent to is: * `url =` host `+` relative_url - * The task attempt has succeeded if the app's request handler returns an - * HTTP response code in the range [`200` - `299`]. `503` is considered an App - * Engine system error instead of an application error. Requests returning - * error `503` will be retried regardless of retry configuration and not - * counted against retry counts. Any other response code or a failure to - * receive a response before the deadline is a failed attempt. + * Traffic is encrypted during transport and never leaves Google datacenters. + * Because this traffic is carried over a communication mechanism internal to + * Google, you cannot explicitly set the protocol (for example, HTTP or + * HTTPS). The request to the handler, however, will appear to have used the + * HTTP protocol. The AppEngineRouting used to construct the URL that the + * task is delivered to can be set at the queue-level or task-level: * If + * set, app_engine_routing_override is used for all tasks in the queue, + * no matter what the setting is for the task-level app_engine_routing. + * The `url` that the task will be sent to is: * `url =` host `+` + * relative_url Tasks can be dispatched to secure app handlers, unsecure app + * handlers, and URIs restricted with [`login: + * admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). + * Because tasks are not run as any user, they cannot be dispatched to URIs + * restricted with [`login: + * required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) + * Task dispatches also do not follow redirects. The task attempt has + * succeeded if the app's request handler returns an HTTP response code in + * the range [`200` - `299`]. `503` is considered an App Engine system error + * instead of an application error. Requests returning error `503` will be + * retried regardless of retry configuration and not counted against retry + * counts. Any other response code or a failure to receive a response before + * the deadline is a failed attempt. */ export interface Schema$AppEngineHttpRequest { /** @@ -181,8 +243,9 @@ export namespace cloudtasks_v2beta2 { appEngineRoutingOverride?: Schema$AppEngineRouting; } /** - * App Engine Routing. For more information about services, versions, and - * instances see [An Overview of App + * App Engine Routing. Defines routing characteristics specific to App Engine + * - service, version, and instance. For more information about services, + * versions, and instances see [An Overview of App * Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), * [Microservices Architecture on Google App * Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), @@ -1316,7 +1379,8 @@ export namespace cloudtasks_v2beta2 { } } - export interface Params$Resource$Projects$Locations$Get { + export interface Params$Resource$Projects$Locations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1327,7 +1391,8 @@ export namespace cloudtasks_v2beta2 { */ name?: string; } - export interface Params$Resource$Projects$Locations$List { + export interface Params$Resource$Projects$Locations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2811,7 +2876,8 @@ export namespace cloudtasks_v2beta2 { } } - export interface Params$Resource$Projects$Locations$Queues$Create { + export interface Params$Resource$Projects$Locations$Queues$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2830,7 +2896,8 @@ export namespace cloudtasks_v2beta2 { */ requestBody?: Schema$Queue; } - export interface Params$Resource$Projects$Locations$Queues$Delete { + export interface Params$Resource$Projects$Locations$Queues$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2842,7 +2909,8 @@ export namespace cloudtasks_v2beta2 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Queues$Get { + export interface Params$Resource$Projects$Locations$Queues$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2854,7 +2922,8 @@ export namespace cloudtasks_v2beta2 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Queues$Getiampolicy { + export interface Params$Resource$Projects$Locations$Queues$Getiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2871,7 +2940,8 @@ export namespace cloudtasks_v2beta2 { */ requestBody?: Schema$GetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Queues$List { + export interface Params$Resource$Projects$Locations$Queues$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2908,7 +2978,8 @@ export namespace cloudtasks_v2beta2 { */ parent?: string; } - export interface Params$Resource$Projects$Locations$Queues$Patch { + export interface Params$Resource$Projects$Locations$Queues$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2940,7 +3011,8 @@ export namespace cloudtasks_v2beta2 { */ requestBody?: Schema$Queue; } - export interface Params$Resource$Projects$Locations$Queues$Pause { + export interface Params$Resource$Projects$Locations$Queues$Pause extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2957,7 +3029,8 @@ export namespace cloudtasks_v2beta2 { */ requestBody?: Schema$PauseQueueRequest; } - export interface Params$Resource$Projects$Locations$Queues$Purge { + export interface Params$Resource$Projects$Locations$Queues$Purge extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2974,7 +3047,8 @@ export namespace cloudtasks_v2beta2 { */ requestBody?: Schema$PurgeQueueRequest; } - export interface Params$Resource$Projects$Locations$Queues$Resume { + export interface Params$Resource$Projects$Locations$Queues$Resume extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2991,7 +3065,8 @@ export namespace cloudtasks_v2beta2 { */ requestBody?: Schema$ResumeQueueRequest; } - export interface Params$Resource$Projects$Locations$Queues$Setiampolicy { + export interface Params$Resource$Projects$Locations$Queues$Setiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3008,7 +3083,8 @@ export namespace cloudtasks_v2beta2 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Queues$Testiampermissions { + export interface Params$Resource$Projects$Locations$Queues$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4155,7 +4231,8 @@ export namespace cloudtasks_v2beta2 { } } - export interface Params$Resource$Projects$Locations$Queues$Tasks$Acknowledge { + export interface Params$Resource$Projects$Locations$Queues$Tasks$Acknowledge + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4172,7 +4249,8 @@ export namespace cloudtasks_v2beta2 { */ requestBody?: Schema$AcknowledgeTaskRequest; } - export interface Params$Resource$Projects$Locations$Queues$Tasks$Cancellease { + export interface Params$Resource$Projects$Locations$Queues$Tasks$Cancellease + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4189,7 +4267,8 @@ export namespace cloudtasks_v2beta2 { */ requestBody?: Schema$CancelLeaseRequest; } - export interface Params$Resource$Projects$Locations$Queues$Tasks$Create { + export interface Params$Resource$Projects$Locations$Queues$Tasks$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4207,7 +4286,8 @@ export namespace cloudtasks_v2beta2 { */ requestBody?: Schema$CreateTaskRequest; } - export interface Params$Resource$Projects$Locations$Queues$Tasks$Delete { + export interface Params$Resource$Projects$Locations$Queues$Tasks$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4219,7 +4299,8 @@ export namespace cloudtasks_v2beta2 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Queues$Tasks$Get { + export interface Params$Resource$Projects$Locations$Queues$Tasks$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4241,7 +4322,8 @@ export namespace cloudtasks_v2beta2 { */ responseView?: string; } - export interface Params$Resource$Projects$Locations$Queues$Tasks$Lease { + export interface Params$Resource$Projects$Locations$Queues$Tasks$Lease extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4258,7 +4340,8 @@ export namespace cloudtasks_v2beta2 { */ requestBody?: Schema$LeaseTasksRequest; } - export interface Params$Resource$Projects$Locations$Queues$Tasks$List { + export interface Params$Resource$Projects$Locations$Queues$Tasks$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4296,7 +4379,8 @@ export namespace cloudtasks_v2beta2 { */ responseView?: string; } - export interface Params$Resource$Projects$Locations$Queues$Tasks$Renewlease { + export interface Params$Resource$Projects$Locations$Queues$Tasks$Renewlease + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4313,7 +4397,8 @@ export namespace cloudtasks_v2beta2 { */ requestBody?: Schema$RenewLeaseRequest; } - export interface Params$Resource$Projects$Locations$Queues$Tasks$Run { + export interface Params$Resource$Projects$Locations$Queues$Tasks$Run extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/cloudtasks/v2beta3.ts b/src/apis/cloudtasks/v2beta3.ts index b0cea87c4d..9f10d4929e 100644 --- a/src/apis/cloudtasks/v2beta3.ts +++ b/src/apis/cloudtasks/v2beta3.ts @@ -29,6 +29,57 @@ export namespace cloudtasks_v2beta3 { version: 'v2beta3'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Tasks API * @@ -95,17 +146,28 @@ export namespace cloudtasks_v2beta3 { * Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) * and how routing is affected by [dispatch * files](https://cloud.google.com/appengine/docs/python/config/dispatchref). - * The AppEngineRouting used to construct the URL that the task is delivered - * to can be set at the queue-level or task-level: * If set, - * app_engine_routing_override is used for all tasks in the queue, no - * matter what the setting is for the task-level app_engine_routing. The - * `url` that the task will be sent to is: * `url =` host `+` relative_uri - * The task attempt has succeeded if the app's request handler returns an - * HTTP response code in the range [`200` - `299`]. `503` is considered an App - * Engine system error instead of an application error. Requests returning - * error `503` will be retried regardless of retry configuration and not - * counted against retry counts. Any other response code or a failure to - * receive a response before the deadline is a failed attempt. + * Traffic is encrypted during transport and never leaves Google datacenters. + * Because this traffic is carried over a communication mechanism internal to + * Google, you cannot explicitly set the protocol (for example, HTTP or + * HTTPS). The request to the handler, however, will appear to have used the + * HTTP protocol. The AppEngineRouting used to construct the URL that the + * task is delivered to can be set at the queue-level or task-level: * If + * set, app_engine_routing_override is used for all tasks in the queue, + * no matter what the setting is for the task-level app_engine_routing. + * The `url` that the task will be sent to is: * `url =` host `+` + * relative_uri Tasks can be dispatched to secure app handlers, unsecure app + * handlers, and URIs restricted with [`login: + * admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). + * Because tasks are not run as any user, they cannot be dispatched to URIs + * restricted with [`login: + * required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) + * Task dispatches also do not follow redirects. The task attempt has + * succeeded if the app's request handler returns an HTTP response code in + * the range [`200` - `299`]. `503` is considered an App Engine system error + * instead of an application error. Requests returning error `503` will be + * retried regardless of retry configuration and not counted against retry + * counts. Any other response code or a failure to receive a response before + * the deadline is a failed attempt. */ export interface Schema$AppEngineHttpRequest { /** @@ -169,16 +231,9 @@ export namespace cloudtasks_v2beta3 { relativeUri?: string; } /** - * App Engine Routing. Specifies the target URI. Since this target type - * dispatches tasks to secure app handlers, unsecure app handlers, and URIs - * restricted with [`login: - * admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref) - * the protocol (for example, HTTP or HTTPS) cannot be explictly specified. - * Task dispatches do not follow redirects and cannot target URI paths - * restricted with [`login: - * required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) - * because tasks are not run as any user. For more information about - * services, versions, and instances see [An Overview of App + * App Engine Routing. Defines routing characteristics specific to App Engine + * - service, version, and instance. For more information about services, + * versions, and instances see [An Overview of App * Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), * [Microservices Architecture on Google App * Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), @@ -502,7 +557,7 @@ export namespace cloudtasks_v2beta3 { export interface Schema$Queue { /** * App Engine HTTP queue. An App Engine queue is a queue that has an - * AppEngineHttpQeueue type. + * AppEngineHttpQueue type. */ appEngineHttpQueue?: Schema$AppEngineHttpQueue; /** @@ -1004,7 +1059,8 @@ export namespace cloudtasks_v2beta3 { } } - export interface Params$Resource$Projects$Locations$Get { + export interface Params$Resource$Projects$Locations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1015,7 +1071,8 @@ export namespace cloudtasks_v2beta3 { */ name?: string; } - export interface Params$Resource$Projects$Locations$List { + export interface Params$Resource$Projects$Locations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1844,7 +1901,8 @@ export namespace cloudtasks_v2beta3 { } } - export interface Params$Resource$Projects$Locations$Queues$Create { + export interface Params$Resource$Projects$Locations$Queues$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1863,7 +1921,8 @@ export namespace cloudtasks_v2beta3 { */ requestBody?: Schema$Queue; } - export interface Params$Resource$Projects$Locations$Queues$Delete { + export interface Params$Resource$Projects$Locations$Queues$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1875,7 +1934,8 @@ export namespace cloudtasks_v2beta3 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Queues$Get { + export interface Params$Resource$Projects$Locations$Queues$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1887,7 +1947,8 @@ export namespace cloudtasks_v2beta3 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Queues$Getiampolicy { + export interface Params$Resource$Projects$Locations$Queues$Getiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1904,7 +1965,8 @@ export namespace cloudtasks_v2beta3 { */ requestBody?: Schema$GetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Queues$List { + export interface Params$Resource$Projects$Locations$Queues$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1941,7 +2003,8 @@ export namespace cloudtasks_v2beta3 { */ parent?: string; } - export interface Params$Resource$Projects$Locations$Queues$Patch { + export interface Params$Resource$Projects$Locations$Queues$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1973,7 +2036,8 @@ export namespace cloudtasks_v2beta3 { */ requestBody?: Schema$Queue; } - export interface Params$Resource$Projects$Locations$Queues$Pause { + export interface Params$Resource$Projects$Locations$Queues$Pause extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1990,7 +2054,8 @@ export namespace cloudtasks_v2beta3 { */ requestBody?: Schema$PauseQueueRequest; } - export interface Params$Resource$Projects$Locations$Queues$Purge { + export interface Params$Resource$Projects$Locations$Queues$Purge extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2007,7 +2072,8 @@ export namespace cloudtasks_v2beta3 { */ requestBody?: Schema$PurgeQueueRequest; } - export interface Params$Resource$Projects$Locations$Queues$Resume { + export interface Params$Resource$Projects$Locations$Queues$Resume extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2024,7 +2090,8 @@ export namespace cloudtasks_v2beta3 { */ requestBody?: Schema$ResumeQueueRequest; } - export interface Params$Resource$Projects$Locations$Queues$Setiampolicy { + export interface Params$Resource$Projects$Locations$Queues$Setiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2041,7 +2108,8 @@ export namespace cloudtasks_v2beta3 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Queues$Testiampermissions { + export interface Params$Resource$Projects$Locations$Queues$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2419,7 +2487,8 @@ export namespace cloudtasks_v2beta3 { } } - export interface Params$Resource$Projects$Locations$Queues$Tasks$Create { + export interface Params$Resource$Projects$Locations$Queues$Tasks$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2437,7 +2506,8 @@ export namespace cloudtasks_v2beta3 { */ requestBody?: Schema$CreateTaskRequest; } - export interface Params$Resource$Projects$Locations$Queues$Tasks$Delete { + export interface Params$Resource$Projects$Locations$Queues$Tasks$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2449,7 +2519,8 @@ export namespace cloudtasks_v2beta3 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Queues$Tasks$Get { + export interface Params$Resource$Projects$Locations$Queues$Tasks$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2471,7 +2542,8 @@ export namespace cloudtasks_v2beta3 { */ responseView?: string; } - export interface Params$Resource$Projects$Locations$Queues$Tasks$List { + export interface Params$Resource$Projects$Locations$Queues$Tasks$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2509,7 +2581,8 @@ export namespace cloudtasks_v2beta3 { */ responseView?: string; } - export interface Params$Resource$Projects$Locations$Queues$Tasks$Run { + export interface Params$Resource$Projects$Locations$Queues$Tasks$Run extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/cloudtrace/v1.ts b/src/apis/cloudtrace/v1.ts index eedb87ccad..d710af39c5 100644 --- a/src/apis/cloudtrace/v1.ts +++ b/src/apis/cloudtrace/v1.ts @@ -29,6 +29,57 @@ export namespace cloudtrace_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Stackdriver Trace API * @@ -323,7 +374,8 @@ export namespace cloudtrace_v1 { } } - export interface Params$Resource$Projects$Patchtraces { + export interface Params$Resource$Projects$Patchtraces extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -612,7 +664,8 @@ export namespace cloudtrace_v1 { } } - export interface Params$Resource$Projects$Traces$Get { + export interface Params$Resource$Projects$Traces$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -627,7 +680,8 @@ export namespace cloudtrace_v1 { */ traceId?: string; } - export interface Params$Resource$Projects$Traces$List { + export interface Params$Resource$Projects$Traces$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/cloudtrace/v2.ts b/src/apis/cloudtrace/v2.ts index 10565a3c7d..3a282c66f8 100644 --- a/src/apis/cloudtrace/v2.ts +++ b/src/apis/cloudtrace/v2.ts @@ -29,6 +29,57 @@ export namespace cloudtrace_v2 { version: 'v2'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Stackdriver Trace API * @@ -579,7 +630,8 @@ export namespace cloudtrace_v2 { } } - export interface Params$Resource$Projects$Traces$Batchwrite { + export interface Params$Resource$Projects$Traces$Batchwrite extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -675,7 +727,8 @@ export namespace cloudtrace_v2 { } } - export interface Params$Resource$Projects$Traces$Spans$Createspan { + export interface Params$Resource$Projects$Traces$Spans$Createspan extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/composer/v1.ts b/src/apis/composer/v1.ts index 57ee2be447..c2abb5106e 100644 --- a/src/apis/composer/v1.ts +++ b/src/apis/composer/v1.ts @@ -29,6 +29,57 @@ export namespace composer_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Composer API * @@ -822,7 +873,8 @@ export namespace composer_v1 { } } - export interface Params$Resource$Projects$Locations$Environments$Create { + export interface Params$Resource$Projects$Locations$Environments$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -839,7 +891,8 @@ export namespace composer_v1 { */ requestBody?: Schema$Environment; } - export interface Params$Resource$Projects$Locations$Environments$Delete { + export interface Params$Resource$Projects$Locations$Environments$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -851,7 +904,8 @@ export namespace composer_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Environments$Get { + export interface Params$Resource$Projects$Locations$Environments$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -863,7 +917,8 @@ export namespace composer_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Environments$List { + export interface Params$Resource$Projects$Locations$Environments$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -883,7 +938,8 @@ export namespace composer_v1 { */ parent?: string; } - export interface Params$Resource$Projects$Locations$Environments$Patch { + export interface Params$Resource$Projects$Locations$Environments$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1202,7 +1258,8 @@ export namespace composer_v1 { } } - export interface Params$Resource$Projects$Locations$Operations$Delete { + export interface Params$Resource$Projects$Locations$Operations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1213,7 +1270,8 @@ export namespace composer_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$Get { + export interface Params$Resource$Projects$Locations$Operations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1224,7 +1282,8 @@ export namespace composer_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$List { + export interface Params$Resource$Projects$Locations$Operations$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/composer/v1beta1.ts b/src/apis/composer/v1beta1.ts index 042beddc74..aeb6f1e964 100644 --- a/src/apis/composer/v1beta1.ts +++ b/src/apis/composer/v1beta1.ts @@ -29,6 +29,57 @@ export namespace composer_v1beta1 { version: 'v1beta1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Composer API * @@ -371,7 +422,7 @@ export namespace composer_v1beta1 { * Immutable. The version of the software running in the environment. This * encapsulates both the version of Cloud Composer functionality and the * version of Apache Airflow. It must match the regular expression - * `composer-([0-9]+\.[0-9]+(\.[0-9]+)?|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`. + * `composer-([0-9]+\.[0-9]+\.[0-9]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`. * When used as input, the server will also check if the provided version is * supported and deny the creation request for an unsupported version. The * Cloud Composer portion of the version is a [semantic @@ -383,12 +434,11 @@ export namespace composer_v1beta1 { * version that follows <em>airflow-</em> is an official Apache * Airflow repository [release * name](https://github.com/apache/incubator-airflow/releases). Supported - * values for input are: * `composer-latest-airflow-latest` * - * `composer-latest-airflow-1.10.0` * `composer-latest-airflow-1.9.0` * - * `composer-latest-airflow-1.10` * `composer-latest-airflow-1.9` * - * `composer-1.1.1-airflow-latest` * `composer-1.1.1-airflow-1.10.0` * - * `composer-1.1.1-airflow-1.9.0` * `composer-1.1.1-airflow-1.10` * - * `composer-1.1.1-airflow-1.9` See also [Release + * values for input are: * `composer-latest-airflow-1.10.0` * + * `composer-latest-airflow-1.9.0` * `composer-latest-airflow-1.10` * + * `composer-latest-airflow-1.9` * `composer-1.3.0-airflow-1.10.0` * + * `composer-1.3.0-airflow-1.9.0` * `composer-1.3.0-airflow-1.10` * + * `composer-1.3.0-airflow-1.9` See also [Release * Notes](/composer/docs/release-notes). */ imageVersion?: string; @@ -845,7 +895,8 @@ export namespace composer_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Environments$Create { + export interface Params$Resource$Projects$Locations$Environments$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -862,7 +913,8 @@ export namespace composer_v1beta1 { */ requestBody?: Schema$Environment; } - export interface Params$Resource$Projects$Locations$Environments$Delete { + export interface Params$Resource$Projects$Locations$Environments$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -874,7 +926,8 @@ export namespace composer_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Environments$Get { + export interface Params$Resource$Projects$Locations$Environments$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -886,7 +939,8 @@ export namespace composer_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Environments$List { + export interface Params$Resource$Projects$Locations$Environments$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -906,7 +960,8 @@ export namespace composer_v1beta1 { */ parent?: string; } - export interface Params$Resource$Projects$Locations$Environments$Patch { + export interface Params$Resource$Projects$Locations$Environments$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1225,7 +1280,8 @@ export namespace composer_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Operations$Delete { + export interface Params$Resource$Projects$Locations$Operations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1236,7 +1292,8 @@ export namespace composer_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$Get { + export interface Params$Resource$Projects$Locations$Operations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1247,7 +1304,8 @@ export namespace composer_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$List { + export interface Params$Resource$Projects$Locations$Operations$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/compute/alpha.ts b/src/apis/compute/alpha.ts index 19c85f85b3..14a805f0c3 100644 --- a/src/apis/compute/alpha.ts +++ b/src/apis/compute/alpha.ts @@ -29,6 +29,40 @@ export namespace compute_alpha { version: 'alpha'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Compute Engine API * @@ -62,6 +96,7 @@ export namespace compute_alpha { globalAddresses: Resource$Globaladdresses; globalForwardingRules: Resource$Globalforwardingrules; globalOperations: Resource$Globaloperations; + globalOrganizationOperations: Resource$Globalorganizationoperations; healthChecks: Resource$Healthchecks; httpHealthChecks: Resource$Httphealthchecks; httpsHealthChecks: Resource$Httpshealthchecks; @@ -136,6 +171,8 @@ export namespace compute_alpha { this.globalAddresses = new Resource$Globaladdresses(this); this.globalForwardingRules = new Resource$Globalforwardingrules(this); this.globalOperations = new Resource$Globaloperations(this); + this.globalOrganizationOperations = + new Resource$Globalorganizationoperations(this); this.healthChecks = new Resource$Healthchecks(this); this.httpHealthChecks = new Resource$Httphealthchecks(this); this.httpsHealthChecks = new Resource$Httpshealthchecks(this); @@ -1460,14 +1497,21 @@ export namespace compute_alpha { */ failover?: boolean; /** - * The fully-qualified URL of a Instance Group resource. This instance group - * defines the list of instances that serve traffic. Member virtual machine - * instances from each instance group must live in the same zone as the - * instance group itself. No two backends in a backend service are allowed - * to use same Instance Group resource. Note that you must specify an - * Instance Group resource using the fully-qualified URL, rather than a + * The fully-qualified URL of an Instance Group or Network Endpoint Group + * resource. In case of instance group this defines the list of instances + * that serve traffic. Member virtual machine instances from each instance + * group must live in the same zone as the instance group itself. No two + * backends in a backend service are allowed to use same Instance Group + * resource. For Network Endpoint Groups this defines list of endpoints. + * All endpoints of Network Endpoint Group must be hosted on instances + * located in the same zone as the Network Endpoint Group. Backend service + * can not contain mix of Instance Group and Network Endpoint Group + * backends. Note that you must specify an Instance Group or Network + * Endpoint Group resource using the fully-qualified URL, rather than a * partial URL. When the BackendService has load balancing scheme INTERNAL, * the instance group must be within the same region as the BackendService. + * Network Endpoint Groups are not supported for INTERNAL load balancing + * scheme. */ group?: string; /** @@ -1890,6 +1934,14 @@ export namespace compute_alpha { failoverRatio?: number; } export interface Schema$BackendServiceGroupHealth { + /** + * Metadata defined as annotations on the network endpoint group. + */ + annotations?: any; + /** + * Health state of the backend instances or endpoints in requested instance + * or network endpoint group, determined based on configured health checks. + */ healthStatus?: Schema$HealthStatus[]; /** * [Output Only] Type of resource. Always compute#backendServiceGroupHealth @@ -2827,6 +2879,59 @@ export namespace compute_alpha { */ zone?: string; } + export interface Schema$ExchangedPeeringRoute { + /** + * The destination range of the route. + */ + destRange?: string; + /** + * If the peering route is imported if there is no confliction. + */ + imported?: boolean; + /** + * The region of peering route next hop, only applies to dynamic routes. + */ + nextHopRegion?: string; + /** + * The priority of the peering route. + */ + priority?: number; + /** + * The type of the peering route. + */ + type?: string; + } + export interface Schema$ExchangedPeeringRoutesList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string; + /** + * A list of ExchangedPeeringRoute resources. + */ + items?: Schema$ExchangedPeeringRoute[]; + /** + * [Output Only] Type of resource. Always compute#exchangedPeeringRoutesList + * for exchanged peering routes lists. + */ + kind?: string; + /** + * [Output Only] This token allows you to get the next page of results for + * list requests. If the number of results is larger than maxResults, use + * the nextPageToken as a value for the query parameter pageToken in the + * next list request. Subsequent list requests will have their own + * nextPageToken to continue paging through the results. + */ + nextPageToken?: string; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string; + /** + * [Output Only] Informational warning message. + */ + warning?: any; + } /** * Represents an expression text. Example: title: "User account * presence" description: "Determines whether the request has a user @@ -3628,6 +3733,10 @@ export namespace compute_alpha { warning?: any; } export interface Schema$HealthStatus { + /** + * Metadata defined as annotations for network endpoint. + */ + annotations?: any; /** * Health state of the instance. */ @@ -3734,51 +3843,6 @@ export namespace compute_alpha { */ response?: string; } - export interface Schema$HTTPHealthCheck { - /** - * The value of the host header in the HTTP health check request. If left - * empty (default value), the IP on behalf of which this health check is - * performed will be used. - */ - host?: string; - /** - * The TCP port number for the health check request. The default value - * is 80. Valid values are 1 through 65535. - */ - port?: number; - /** - * Port name as defined in InstanceGroup#NamedPort#name. If both port and - * port_name are defined, port takes precedence. - */ - portName?: string; - /** - * Specifies how port is selected for health checking, can be one of - * following values: USE_FIXED_PORT: The port number in port is used for - * health checking. USE_NAMED_PORT: The portName is used for health - * checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified - * for each network endpoint is used for health checking. For other - * backends, the port or named port specified in the Backend Service is used - * for health checking. If not specified, HTTP health check follows - * behavior specified in port and portName fields. - */ - portSpecification?: string; - /** - * Specifies the type of proxy header to append before sending data to the - * backend, either NONE or PROXY_V1. The default is NONE. - */ - proxyHeader?: string; - /** - * The request path of the HTTP health check request. The default value is - * /. - */ - requestPath?: string; - /** - * The string to match anywhere in the first 1024 bytes of the response - * body. If left empty (the default value), the status code determines - * health. The response data can only be ASCII. - */ - response?: string; - } /** * An HttpHealthCheck resource. This resource defines a template for how * individual instances should be checked for health, via HTTP. @@ -3855,6 +3919,51 @@ export namespace compute_alpha { */ unhealthyThreshold?: number; } + export interface Schema$HTTPHealthCheck { + /** + * The value of the host header in the HTTP health check request. If left + * empty (default value), the IP on behalf of which this health check is + * performed will be used. + */ + host?: string; + /** + * The TCP port number for the health check request. The default value + * is 80. Valid values are 1 through 65535. + */ + port?: number; + /** + * Port name as defined in InstanceGroup#NamedPort#name. If both port and + * port_name are defined, port takes precedence. + */ + portName?: string; + /** + * Specifies how port is selected for health checking, can be one of + * following values: USE_FIXED_PORT: The port number in port is used for + * health checking. USE_NAMED_PORT: The portName is used for health + * checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified + * for each network endpoint is used for health checking. For other + * backends, the port or named port specified in the Backend Service is used + * for health checking. If not specified, HTTP health check follows + * behavior specified in port and portName fields. + */ + portSpecification?: string; + /** + * Specifies the type of proxy header to append before sending data to the + * backend, either NONE or PROXY_V1. The default is NONE. + */ + proxyHeader?: string; + /** + * The request path of the HTTP health check request. The default value is + * /. + */ + requestPath?: string; + /** + * The string to match anywhere in the first 1024 bytes of the response + * body. If left empty (the default value), the status code determines + * health. The response data can only be ASCII. + */ + response?: string; + } /** * Contains a list of HttpHealthCheck resources. */ @@ -3888,6 +3997,51 @@ export namespace compute_alpha { */ warning?: any; } + export interface Schema$HTTPSHealthCheck { + /** + * The value of the host header in the HTTPS health check request. If left + * empty (default value), the IP on behalf of which this health check is + * performed will be used. + */ + host?: string; + /** + * The TCP port number for the health check request. The default value is + * 443. Valid values are 1 through 65535. + */ + port?: number; + /** + * Port name as defined in InstanceGroup#NamedPort#name. If both port and + * port_name are defined, port takes precedence. + */ + portName?: string; + /** + * Specifies how port is selected for health checking, can be one of + * following values: USE_FIXED_PORT: The port number in port is used for + * health checking. USE_NAMED_PORT: The portName is used for health + * checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified + * for each network endpoint is used for health checking. For other + * backends, the port or named port specified in the Backend Service is used + * for health checking. If not specified, HTTPS health check follows + * behavior specified in port and portName fields. + */ + portSpecification?: string; + /** + * Specifies the type of proxy header to append before sending data to the + * backend, either NONE or PROXY_V1. The default is NONE. + */ + proxyHeader?: string; + /** + * The request path of the HTTPS health check request. The default value is + * /. + */ + requestPath?: string; + /** + * The string to match anywhere in the first 1024 bytes of the response + * body. If left empty (the default value), the status code determines + * health. The response data can only be ASCII. + */ + response?: string; + } /** * An HttpsHealthCheck resource. This resource defines a template for how * individual instances should be checked for health, via HTTPS. @@ -3963,51 +4117,6 @@ export namespace compute_alpha { */ unhealthyThreshold?: number; } - export interface Schema$HTTPSHealthCheck { - /** - * The value of the host header in the HTTPS health check request. If left - * empty (default value), the IP on behalf of which this health check is - * performed will be used. - */ - host?: string; - /** - * The TCP port number for the health check request. The default value is - * 443. Valid values are 1 through 65535. - */ - port?: number; - /** - * Port name as defined in InstanceGroup#NamedPort#name. If both port and - * port_name are defined, port takes precedence. - */ - portName?: string; - /** - * Specifies how port is selected for health checking, can be one of - * following values: USE_FIXED_PORT: The port number in port is used for - * health checking. USE_NAMED_PORT: The portName is used for health - * checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified - * for each network endpoint is used for health checking. For other - * backends, the port or named port specified in the Backend Service is used - * for health checking. If not specified, HTTPS health check follows - * behavior specified in port and portName fields. - */ - portSpecification?: string; - /** - * Specifies the type of proxy header to append before sending data to the - * backend, either NONE or PROXY_V1. The default is NONE. - */ - proxyHeader?: string; - /** - * The request path of the HTTPS health check request. The default value is - * /. - */ - requestPath?: string; - /** - * The string to match anywhere in the first 1024 bytes of the response - * body. If left empty (the default value), the status code determines - * health. The response data can only be ASCII. - */ - response?: string; - } /** * Contains a list of HttpsHealthCheck resources. */ @@ -5010,7 +5119,7 @@ export namespace compute_alpha { * instances initiated by this resize request only once. If there is an * error during creation, the managed instance group does not retry create * this instance, and we will decrease the targetSize of the request - * instead. If the flag is false, the group attemps to recreate each + * instead. If the flag is false, the group attempts to recreate each * instance continuously until it succeeds. This flag matters only in the * first attempt of creation of an instance. After an instance is * successfully created while this flag is enabled, the instance behaves the @@ -5783,10 +5892,6 @@ export namespace compute_alpha { * PARTNER_PROVIDER. */ adminEnabled?: boolean; - /** - * [Deprecated] Replaced by edge_availability_domain. - */ - availabilityZone?: string; /** * Provisioned bandwidth capacity for the interconnectAttachment. Can be set * by the partner to update the customer's provisioned bandwidth. Output @@ -6665,7 +6770,11 @@ export namespace compute_alpha { export interface Schema$LogConfigDataAccessOptions { /** * Whether Gin logging should happen in a fail-closed manner at the caller. - * This is relevant only in the LocalIAM implementation, for now. + * This is relevant only in the LocalIAM implementation, for now. NOTE: + * Logging to Gin in a fail-closed manner is currently unsupported while + * work is being done to satisfy the requirements of go/345. Currently, + * setting LOG_FAIL_CLOSED mode will have no effect, but still exists + * because there is active work being done to support it (b/115874152). */ logMode?: string; } @@ -6942,6 +7051,10 @@ export namespace compute_alpha { * instance has not yet been created. */ instance?: string; + /** + * [Output Only] Health state of the instance per health-check. + */ + instanceHealth?: Schema$ManagedInstanceInstanceHealth[]; /** * [Output Only] The status of the instance. This field is empty when the * instance does not exist. @@ -6970,6 +7083,17 @@ export namespace compute_alpha { */ version?: Schema$ManagedInstanceVersion; } + export interface Schema$ManagedInstanceInstanceHealth { + /** + * [Output Only] The URL for the health check that verifies whether the + * instance is healthy. + */ + healthCheck?: string; + /** + * [Output Only] The current instance health state. + */ + healthState?: string; + } export interface Schema$ManagedInstanceLastAttempt { /** * [Output Only] Encountered errors during the last attempt to create or @@ -7147,6 +7271,10 @@ export namespace compute_alpha { * The network endpoint. */ export interface Schema$NetworkEndpoint { + /** + * Metadata defined as annotations on the network endpoint. + */ + annotations?: any; /** * The name for a specific VM instance that the IP address belongs to. This * is required for network endpoints of type GCE_VM_IP_PORT. The instance @@ -7173,6 +7301,10 @@ export namespace compute_alpha { * Represents a collection of network endpoints. */ export interface Schema$NetworkEndpointGroup { + /** + * Metadata defined as annotations on the network endpoint group. + */ + annotations?: any; /** * [Output Only] Creation timestamp in RFC3339 text format. */ @@ -7516,6 +7648,14 @@ export namespace compute_alpha { * network. */ autoCreateRoutes?: boolean; + /** + * Whether full mesh connectivity is created and managed automatically. When + * it is set to true, Google Compute Engine will automatically create and + * manage the routes between two networks when the peering state is ACTIVE. + * Otherwise, user needs to create routes manually to route packets to peer + * network. + */ + exchangeSubnetRoutes?: boolean; /** * Whether to export the custom routes to peer network. */ @@ -7581,6 +7721,10 @@ export namespace compute_alpha { * Name of the peering, which should conform to RFC1035. */ name?: string; + /** + * Network peering parameters. + */ + networkPeering?: Schema$NetworkPeering; /** * URL of the peer network. It can be either full URL or partial URL. The * peer network may belong to a different project. If the partial URL does @@ -7822,7 +7966,7 @@ export namespace compute_alpha { * with RFC1035. Specifically, the name must be 1-63 characters long and * match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the * first character must be a lowercase letter, and all following characters - * must be a dash, lowercase letter, or digit, except the last charaicter, + * must be a dash, lowercase letter, or digit, except the last character, * which cannot be a dash. */ name?: string; @@ -8296,12 +8440,19 @@ export namespace compute_alpha { export interface Schema$PathMatcher { /** * The full or partial URL to the BackendService resource. This will be used - * if none of the pathRules defined by this PathMatcher is matched by the - * URL's path portion. For example, the following are all valid URLs to - * a BackendService resource: - + * if none of the pathRules or routeRules defined by this PathMatcher are + * matched. For example, the following are all valid URLs to a + * BackendService resource: - * https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService * - compute/v1/projects/project/global/backendServices/backendService - - * global/backendServices/backendService + * global/backendServices/backendService Use defaultService instead of + * defaultRouteAction when simple routing to a backend service is desired + * and other advanced capabilities like traffic splitting and URL rewrites + * are not required. Only one of defaultService, defaultRouteAction or + * defaultUrlRedirect must be set. Authorization requires one or more of the + * following Google IAM permissions on the specified resource + * default_service: - compute.backendBuckets.use - + * compute.backendServices.use */ defaultService?: string; /** @@ -8314,7 +8465,13 @@ export namespace compute_alpha { */ name?: string; /** - * The list of path rules. + * The list of path rules. Use this list instead of routeRules when routing + * based on simple path matching is all that's required. The order by + * which path rules are specified does not matter. Matches are always done + * on the longest-path-first basis. For example: a pathRule with a path + * /a/b/c/* will match before /a/b/* irrespective of the order in which + * those paths appear in this list. Only one of pathRules or routeRules must + * be set. */ pathRules?: Schema$PathRule[]; } @@ -8331,7 +8488,11 @@ export namespace compute_alpha { */ paths?: string[]; /** - * The URL of the BackendService resource if this rule is matched. + * The URL of the backend service resource if this rule is matched. Use + * service instead of routeAction when simple routing to a backend service + * is desired and other advanced capabilities like traffic splitting and + * rewrites are not required. Only one of service, routeAction or + * urlRedirect should must be set. */ service?: string; } @@ -9035,6 +9196,11 @@ export namespace compute_alpha { * more of these). */ export interface Schema$ResourceCommitment { + /** + * Name of the accelerator type resource. Applicable only when the type is + * ACCELERATOR. + */ + acceleratorType?: string; /** * The amount of the resource purchased (in a type-dependent unit, such as * bytes). For vCPUs, this can just be an integer. For memory, this must be @@ -9050,8 +9216,8 @@ export namespace compute_alpha { } export interface Schema$ResourceGroupReference { /** - * A URI referencing one of the instance groups listed in the backend - * service. + * A URI referencing one of the instance groups or network endpoint groups + * listed in the backend service. */ group?: string; } @@ -9143,7 +9309,7 @@ export namespace compute_alpha { /** * A backup schedule policy specifies when and how frequently snapshots are to * be created for the target disk. Also specifies how many and how long these - * automatically created snapshot should be retained. + * scheduled snapshots should be retained. */ export interface Schema$ResourcePolicyBackupSchedulePolicy { /** @@ -9157,20 +9323,30 @@ export namespace compute_alpha { */ schedule?: Schema$ResourcePolicyBackupSchedulePolicySchedule; /** - * Properties with which snapshots are created such as lables, encryption + * Properties with which snapshots are created such as labels, encryption * keys. */ snapshotProperties?: Schema$ResourcePolicyBackupSchedulePolicySnapshotProperties; } /** - * Policy for retention of automatically created snapshots. + * Policy for retention of scheduled snapshots. */ export interface Schema$ResourcePolicyBackupSchedulePolicyRetentionPolicy { /** * Maximum age of the snapshot that is allowed to be kept. */ maxRetentionDays?: number; + /** + * Specifies the behavior to apply to existing, scheduled snapshots + * snapshots if the policy is changed. + */ + onPolicySwitch?: string; + /** + * Specifies the behavior to apply to scheduled snapshots when the source + * disk is deleted. + */ + onSourceDiskDelete?: string; } /** * A schedule for disks where the schedueled operations are performed. @@ -9181,7 +9357,7 @@ export namespace compute_alpha { weeklySchedule?: Schema$ResourcePolicyWeeklyCycle; } /** - * Specified snapshot properties for automatic snapshots created by this + * Specified snapshot properties for scheduled snapshots created by this * policy. */ export interface Schema$ResourcePolicyBackupSchedulePolicySnapshotProperties { @@ -9190,7 +9366,7 @@ export namespace compute_alpha { */ guestFlush?: boolean; /** - * Labels to apply to automatic snapshots. These can be later modified by + * Labels to apply to scheduled snapshots. These can be later modified by * the setLabels method. Label values may be empty. */ labels?: any; @@ -9215,7 +9391,7 @@ export namespace compute_alpha { duration?: string; /** * Time within the window to start the operations. It must be in format - * "HH:MM?, where HH : [00-23] and MM : [00-59] GMT. + * "HH:MM?, where HH : [00-23] and MM : [00-00] GMT. */ startTime?: string; } @@ -9234,7 +9410,7 @@ export namespace compute_alpha { hoursInCycle?: number; /** * Time within the window to start the operations. It must be in format - * "HH:MM?, where HH : [00-23] and MM : [00-59] GMT. + * "HH:MM?, where HH : [00-23] and MM : [00-00] GMT. */ startTime?: string; } @@ -9306,7 +9482,7 @@ export namespace compute_alpha { duration?: string; /** * Time within the window to start the operations. It must be in format - * "HH:MM?, where HH : [00-23] and MM : [00-59] GMT. + * "HH:MM?, where HH : [00-23] and MM : [00-00] GMT. */ startTime?: string; } @@ -9743,6 +9919,10 @@ export namespace compute_alpha { * Timeout (in seconds) for ICMP connections. Defaults to 30s if not set. */ icmpIdleTimeoutSec?: number; + /** + * Configure logging on this NAT. + */ + logConfig?: Schema$RouterNatLogConfig; /** * Minimum number of ports allocated to a VM from this NAT config. If not * set, a default number of ports is allocated to a VM. This gets rounded up @@ -9794,6 +9974,20 @@ export namespace compute_alpha { */ udpIdleTimeoutSec?: number; } + /** + * Configuration of logging on a NAT. + */ + export interface Schema$RouterNatLogConfig { + /** + * Indicates whether or not to export logs. This is false by default. + */ + enabled?: boolean; + /** + * Specifies the desired filtering of logs on this NAT. If unspecified, logs + * are exported for all connections handled by this NAT. + */ + filter?: string; + } /** * Defines the IP ranges that want to use NAT for a subnetwork. */ @@ -10110,6 +10304,11 @@ export namespace compute_alpha { * Compute Engine. */ automaticRestart?: boolean; + /** + * The minimum number of virtual CPUs this instance will consume when + * running on a sole-tenant node. + */ + minNodeCpus?: number; /** * A set of node affinity and anti-affinity. */ @@ -10158,6 +10357,10 @@ export namespace compute_alpha { * v1.securityPolicies ==) (== resource_for beta.securityPolicies ==) */ export interface Schema$SecurityPolicy { + /** + * A list of assocations that belong to this policy. + */ + associations?: Schema$SecurityPolicyAssociation[]; /** * [Output Only] Creation timestamp in RFC3339 text format. */ @@ -10222,6 +10425,22 @@ export namespace compute_alpha { * [Output Only] Server-defined URL for the resource. */ selfLink?: string; + /** + * The type indicates the intended use of the security policy. CLOUD_ARMOR + * policies apply to backend services. FIREWALL policies apply to + * organizations. + */ + type?: string; + } + export interface Schema$SecurityPolicyAssociation { + /** + * The resource that the security policy is attached to. + */ + attachmentId?: string; + /** + * The name for an association. + */ + name?: string; } export interface Schema$SecurityPolicyList { /** @@ -10269,6 +10488,19 @@ export namespace compute_alpha { * create the resource. */ description?: string; + /** + * The direction in which this rule applies. This field may only be + * specified when versioned_expr is set to FIREWALL. + */ + direction?: string; + /** + * Denotes whether to enable logging for a particular rule. If logging is + * enabled, logs will be exported to the configured export destination in + * Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you + * cannot enable logging on "goto_next" rules. This field may + * only be specified when the versioned_expr is set to FIREWALL. + */ + enableLogging?: boolean; /** * [Output only] Type of the resource. Always compute#securityPolicyRule for * security policy rules @@ -10289,6 +10521,13 @@ export namespace compute_alpha { * the increasing order of priority. */ priority?: number; + /** + * A list of network resource URLs to which this rule applies. This field + * allows you to control which network?s VMs get this rule. If this field is + * left blank, all VMs within the organization will receive the rule. This + * field may only be specified when versioned_expr is set to FIREWALL. + */ + targetResources?: string[]; } /** * Represents a match condition that incoming traffic is evaluated against. @@ -10307,10 +10546,6 @@ export namespace compute_alpha { * request header. */ expr?: Schema$Expr; - /** - * CIDR IP address range. - */ - srcIpRanges?: string[]; /** * Preconfigured versioned expression. If this field is specified, config * must also be specified. Available preconfigured expressions along with @@ -10320,11 +10555,39 @@ export namespace compute_alpha { versionedExpr?: string; } export interface Schema$SecurityPolicyRuleMatcherConfig { + /** + * CIDR IP address range. This field may only be specified when + * versioned_expr is set to FIREWALL. + */ + destIpRanges?: string[]; + /** + * Pairs of IP protocols and ports that the rule should match. This field + * may only be specified when versioned_expr is set to FIREWALL. + */ + destPorts?: Schema$SecurityPolicyRuleMatcherConfigDestinationPort[]; /** * CIDR IP address range. */ srcIpRanges?: string[]; } + export interface Schema$SecurityPolicyRuleMatcherConfigDestinationPort { + /** + * The IP protocol to which this rule applies. The protocol type is required + * when creating a firewall rule. This value can either be one of the + * following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, + * sctp), or the IP protocol number. + */ + ipProtocol?: string; + /** + * An optional list of ports to which this rule applies. This field is only + * applicable for UDP or TCP protocol. Each entry must be either an integer + * or a range. If not specified, this rule applies to connections through + * any port. Example inputs include: ["22"], + * ["80","443"], and ["12345-12349"]. This + * field may only be specified when versioned_expr is set to FIREWALL. + */ + ports?: string[]; + } /** * An instance's serial console output. */ @@ -10444,7 +10707,7 @@ export namespace compute_alpha { */ export interface Schema$Snapshot { /** - * [Output Only] Set to true if snapshots are autoamtically by applying + * [Output Only] Set to true if snapshots are automatically by applying * resource policy on the target disk. */ autoCreated?: boolean; @@ -11553,8 +11816,9 @@ export namespace compute_alpha { selfLink?: string; /** * URLs to SslCertificate resources that are used to authenticate - * connections between users and the load balancer. Currently, exactly one - * SSL certificate must be specified. + * connections between users and the load balancer. At least one SSL + * certificate must be specified. Currently, you may specify up to 15 SSL + * certificates. */ sslCertificates?: string[]; /** @@ -11858,7 +12122,7 @@ export namespace compute_alpha { */ selfLink?: string; /** - * Sesssion affinity option, must be one of the following values: NONE: + * Session affinity option, must be one of the following values: NONE: * Connections from the same client IP may go to any instance in the pool. * CLIENT_IP: Connections from the same client IP will go to the same * instance in the pool while that instance remains healthy. @@ -12057,8 +12321,8 @@ export namespace compute_alpha { service?: string; /** * URLs to SslCertificate resources that are used to authenticate - * connections to Backends. Currently exactly one SSL certificate must be - * specified. + * connections to Backends. At least one SSL certificate must be specified. + * Currently, you may specify up to 15 SSL certificates. */ sslCertificates?: string[]; /** @@ -12449,7 +12713,11 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * The URL of the BackendService resource if none of the hostRules match. + * The URL of the backendService resource if none of the hostRules match. + * Use defaultService instead of defaultRouteAction when simple routing to a + * backendService is desired and other advanced capabilities like traffic + * splitting and rewrites are not required. Only one of defaultService, + * defaultRouteAction or defaultUrlRedirect should must be set. */ defaultService?: string; /** @@ -13573,7 +13841,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Acceleratortypes$Aggregatedlist { + export interface Params$Resource$Acceleratortypes$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13627,7 +13896,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Acceleratortypes$Get { + export interface Params$Resource$Acceleratortypes$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13646,7 +13916,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Acceleratortypes$List { + export interface Params$Resource$Acceleratortypes$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14154,7 +14425,7 @@ export namespace compute_alpha { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -14219,7 +14490,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Addresses$Aggregatedlist { + export interface Params$Resource$Addresses$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14273,7 +14545,7 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Addresses$Delete { + export interface Params$Resource$Addresses$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -14305,7 +14577,7 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Addresses$Get { + export interface Params$Resource$Addresses$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -14324,7 +14596,7 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Addresses$Insert { + export interface Params$Resource$Addresses$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -14357,7 +14629,7 @@ export namespace compute_alpha { */ requestBody?: Schema$Address; } - export interface Params$Resource$Addresses$List { + export interface Params$Resource$Addresses$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -14415,7 +14687,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Addresses$Setlabels { + export interface Params$Resource$Addresses$Setlabels extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14452,7 +14725,8 @@ export namespace compute_alpha { */ requestBody?: Schema$RegionSetLabelsRequest; } - export interface Params$Resource$Addresses$Testiampermissions { + export interface Params$Resource$Addresses$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14467,7 +14741,7 @@ export namespace compute_alpha { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -14564,6 +14838,78 @@ export namespace compute_alpha { } + /** + * compute.allocations.delete + * @desc Deletes the specified allocation. + * @alias compute.allocations.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.allocation Name of the allocation to delete. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone Name of the zone for 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 + */ + delete( + params?: Params$Resource$Allocations$Delete, + options?: MethodOptions): AxiosPromise; + delete( + params: Params$Resource$Allocations$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Allocations$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Allocations$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Allocations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Allocations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/allocations/{allocation}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['project', 'zone', 'allocation'], + pathParams: ['allocation', 'project', 'zone'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.allocations.get * @desc Retrieves all information of the specified allocation. @@ -14639,7 +14985,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {string} params.zone The name of the zone for this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -14855,7 +15201,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {string} params.zone The name of the zone for this request. * @param {().ZoneSetPolicyRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14926,7 +15272,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {string} params.zone The name of the zone for this request. * @param {().TestPermissionsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -15065,7 +15411,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Allocations$Aggregatedlist { + export interface Params$Resource$Allocations$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15119,7 +15466,40 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Allocations$Get { + export interface Params$Resource$Allocations$Delete extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the allocation to delete. + */ + allocation?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Allocations$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -15138,7 +15518,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Allocations$Getiampolicy { + export interface Params$Resource$Allocations$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15149,7 +15530,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; /** @@ -15157,7 +15538,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Allocations$Insert { + export interface Params$Resource$Allocations$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15190,7 +15572,7 @@ export namespace compute_alpha { */ requestBody?: Schema$Allocation; } - export interface Params$Resource$Allocations$List { + export interface Params$Resource$Allocations$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -15248,7 +15630,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Allocations$Setiampolicy { + export interface Params$Resource$Allocations$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15259,7 +15642,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; /** @@ -15272,7 +15655,8 @@ export namespace compute_alpha { */ requestBody?: Schema$ZoneSetPolicyRequest; } - export interface Params$Resource$Allocations$Testiampermissions { + export interface Params$Resource$Allocations$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15283,7 +15667,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; /** @@ -15296,7 +15680,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Allocations$Updateresourceshape { + export interface Params$Resource$Allocations$Updateresourceshape extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15788,7 +16173,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {string} params.zone The name of the zone for this request. * @param {().TestPermissionsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -15928,7 +16313,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Autoscalers$Aggregatedlist { + export interface Params$Resource$Autoscalers$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15982,7 +16368,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Autoscalers$Delete { + export interface Params$Resource$Autoscalers$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -16014,7 +16401,7 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Autoscalers$Get { + export interface Params$Resource$Autoscalers$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -16033,7 +16420,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Autoscalers$Insert { + export interface Params$Resource$Autoscalers$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -16066,7 +16454,7 @@ export namespace compute_alpha { */ requestBody?: Schema$Autoscaler; } - export interface Params$Resource$Autoscalers$List { + export interface Params$Resource$Autoscalers$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -16124,7 +16512,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Autoscalers$Patch { + export interface Params$Resource$Autoscalers$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -16161,7 +16550,8 @@ export namespace compute_alpha { */ requestBody?: Schema$Autoscaler; } - export interface Params$Resource$Autoscalers$Testiampermissions { + export interface Params$Resource$Autoscalers$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -16172,7 +16562,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; /** @@ -16185,7 +16575,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Autoscalers$Update { + export interface Params$Resource$Autoscalers$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -16529,7 +16920,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for 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 @@ -16816,7 +17207,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().GlobalSetPolicyRequest} 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. @@ -16886,7 +17277,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -17024,7 +17415,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Backendbuckets$Addsignedurlkey { + export interface Params$Resource$Backendbuckets$Addsignedurlkey extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17058,7 +17450,8 @@ export namespace compute_alpha { */ requestBody?: Schema$SignedUrlKey; } - export interface Params$Resource$Backendbuckets$Delete { + export interface Params$Resource$Backendbuckets$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17086,7 +17479,8 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Backendbuckets$Deletesignedurlkey { + export interface Params$Resource$Backendbuckets$Deletesignedurlkey extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17119,7 +17513,8 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Backendbuckets$Get { + export interface Params$Resource$Backendbuckets$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17134,7 +17529,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Backendbuckets$Getiampolicy { + export interface Params$Resource$Backendbuckets$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17145,11 +17541,12 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; } - export interface Params$Resource$Backendbuckets$Insert { + export interface Params$Resource$Backendbuckets$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17178,7 +17575,8 @@ export namespace compute_alpha { */ requestBody?: Schema$BackendBucket; } - export interface Params$Resource$Backendbuckets$List { + export interface Params$Resource$Backendbuckets$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17232,7 +17630,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Backendbuckets$Patch { + export interface Params$Resource$Backendbuckets$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17265,7 +17664,8 @@ export namespace compute_alpha { */ requestBody?: Schema$BackendBucket; } - export interface Params$Resource$Backendbuckets$Setiampolicy { + export interface Params$Resource$Backendbuckets$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17276,7 +17676,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -17285,7 +17685,8 @@ export namespace compute_alpha { */ requestBody?: Schema$GlobalSetPolicyRequest; } - export interface Params$Resource$Backendbuckets$Testiampermissions { + export interface Params$Resource$Backendbuckets$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17296,7 +17697,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -17305,7 +17706,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Backendbuckets$Update { + export interface Params$Resource$Backendbuckets$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18095,7 +18497,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -18235,7 +18637,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Backendservices$Addsignedurlkey { + export interface Params$Resource$Backendservices$Addsignedurlkey extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18269,7 +18672,8 @@ export namespace compute_alpha { */ requestBody?: Schema$SignedUrlKey; } - export interface Params$Resource$Backendservices$Aggregatedlist { + export interface Params$Resource$Backendservices$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18323,7 +18727,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Backendservices$Delete { + export interface Params$Resource$Backendservices$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18351,7 +18756,8 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Backendservices$Deletesignedurlkey { + export interface Params$Resource$Backendservices$Deletesignedurlkey extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18384,7 +18790,8 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Backendservices$Get { + export interface Params$Resource$Backendservices$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18399,7 +18806,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Backendservices$Gethealth { + export interface Params$Resource$Backendservices$Gethealth extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18420,7 +18828,8 @@ export namespace compute_alpha { */ requestBody?: Schema$ResourceGroupReference; } - export interface Params$Resource$Backendservices$Insert { + export interface Params$Resource$Backendservices$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18449,7 +18858,8 @@ export namespace compute_alpha { */ requestBody?: Schema$BackendService; } - export interface Params$Resource$Backendservices$List { + export interface Params$Resource$Backendservices$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18503,7 +18913,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Backendservices$Patch { + export interface Params$Resource$Backendservices$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18536,7 +18947,8 @@ export namespace compute_alpha { */ requestBody?: Schema$BackendService; } - export interface Params$Resource$Backendservices$Setsecuritypolicy { + export interface Params$Resource$Backendservices$Setsecuritypolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18570,7 +18982,8 @@ export namespace compute_alpha { */ requestBody?: Schema$SecurityPolicyReference; } - export interface Params$Resource$Backendservices$Testiampermissions { + export interface Params$Resource$Backendservices$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18581,7 +18994,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -18590,7 +19003,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Backendservices$Update { + export interface Params$Resource$Backendservices$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19007,7 +19421,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {string} params.zone The name of the zone for this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -19369,7 +19783,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {string} params.zone The name of the zone for this request. * @param {().ZoneSetPolicyRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -19513,7 +19927,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {string} params.zone The name of the zone for this request. * @param {().TestPermissionsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -19579,7 +19993,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Disks$Addresourcepolicies { + export interface Params$Resource$Disks$Addresourcepolicies extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19616,7 +20031,8 @@ export namespace compute_alpha { */ requestBody?: Schema$DisksAddResourcePoliciesRequest; } - export interface Params$Resource$Disks$Aggregatedlist { + export interface Params$Resource$Disks$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19670,7 +20086,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Disks$Createsnapshot { + export interface Params$Resource$Disks$Createsnapshot extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19711,7 +20128,7 @@ export namespace compute_alpha { */ requestBody?: Schema$Snapshot; } - export interface Params$Resource$Disks$Delete { + export interface Params$Resource$Disks$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -19743,7 +20160,7 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Disks$Get { + export interface Params$Resource$Disks$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -19762,7 +20179,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Disks$Getiampolicy { + export interface Params$Resource$Disks$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19773,7 +20191,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; /** @@ -19781,7 +20199,7 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Disks$Insert { + export interface Params$Resource$Disks$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -19818,7 +20236,7 @@ export namespace compute_alpha { */ requestBody?: Schema$Disk; } - export interface Params$Resource$Disks$List { + export interface Params$Resource$Disks$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -19876,7 +20294,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Disks$Removeresourcepolicies { + export interface Params$Resource$Disks$Removeresourcepolicies extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19913,7 +20332,7 @@ export namespace compute_alpha { */ requestBody?: Schema$DisksRemoveResourcePoliciesRequest; } - export interface Params$Resource$Disks$Resize { + export interface Params$Resource$Disks$Resize extends StandardParameters { /** * Auth client or API Key for the request */ @@ -19950,7 +20369,8 @@ export namespace compute_alpha { */ requestBody?: Schema$DisksResizeRequest; } - export interface Params$Resource$Disks$Setiampolicy { + export interface Params$Resource$Disks$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19961,7 +20381,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; /** @@ -19974,7 +20394,7 @@ export namespace compute_alpha { */ requestBody?: Schema$ZoneSetPolicyRequest; } - export interface Params$Resource$Disks$Setlabels { + export interface Params$Resource$Disks$Setlabels extends StandardParameters { /** * Auth client or API Key for the request */ @@ -20011,7 +20431,8 @@ export namespace compute_alpha { */ requestBody?: Schema$ZoneSetLabelsRequest; } - export interface Params$Resource$Disks$Testiampermissions { + export interface Params$Resource$Disks$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -20022,7 +20443,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; /** @@ -20260,7 +20681,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Disktypes$Aggregatedlist { + export interface Params$Resource$Disktypes$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -20314,7 +20736,7 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Disktypes$Get { + export interface Params$Resource$Disktypes$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -20333,7 +20755,7 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Disktypes$List { + export interface Params$Resource$Disktypes$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -20758,7 +21180,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -20895,7 +21317,7 @@ export namespace compute_alpha { } } - export interface Params$Resource$Firewalls$Delete { + export interface Params$Resource$Firewalls$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -20923,7 +21345,7 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Firewalls$Get { + export interface Params$Resource$Firewalls$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -20938,7 +21360,7 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Firewalls$Insert { + export interface Params$Resource$Firewalls$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -20967,7 +21389,7 @@ export namespace compute_alpha { */ requestBody?: Schema$Firewall; } - export interface Params$Resource$Firewalls$List { + export interface Params$Resource$Firewalls$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -21021,7 +21443,7 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Firewalls$Patch { + export interface Params$Resource$Firewalls$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -21054,7 +21476,8 @@ export namespace compute_alpha { */ requestBody?: Schema$Firewall; } - export interface Params$Resource$Firewalls$Testiampermissions { + export interface Params$Resource$Firewalls$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -21065,7 +21488,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -21074,7 +21497,7 @@ export namespace compute_alpha { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Firewalls$Update { + export interface Params$Resource$Firewalls$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -21722,7 +22145,7 @@ export namespace compute_alpha { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -21787,7 +22210,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Forwardingrules$Aggregatedlist { + export interface Params$Resource$Forwardingrules$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -21841,7 +22265,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Forwardingrules$Delete { + export interface Params$Resource$Forwardingrules$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -21873,7 +22298,8 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Forwardingrules$Get { + export interface Params$Resource$Forwardingrules$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -21892,7 +22318,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Forwardingrules$Insert { + export interface Params$Resource$Forwardingrules$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -21925,7 +22352,8 @@ export namespace compute_alpha { */ requestBody?: Schema$ForwardingRule; } - export interface Params$Resource$Forwardingrules$List { + export interface Params$Resource$Forwardingrules$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -21983,7 +22411,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Forwardingrules$Patch { + export interface Params$Resource$Forwardingrules$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22020,7 +22449,8 @@ export namespace compute_alpha { */ requestBody?: Schema$ForwardingRule; } - export interface Params$Resource$Forwardingrules$Setlabels { + export interface Params$Resource$Forwardingrules$Setlabels extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22057,7 +22487,8 @@ export namespace compute_alpha { */ requestBody?: Schema$RegionSetLabelsRequest; } - export interface Params$Resource$Forwardingrules$Settarget { + export interface Params$Resource$Forwardingrules$Settarget extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22094,7 +22525,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TargetReference; } - export interface Params$Resource$Forwardingrules$Testiampermissions { + export interface Params$Resource$Forwardingrules$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22109,7 +22541,7 @@ export namespace compute_alpha { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -22492,7 +22924,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -22557,7 +22989,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Globaladdresses$Delete { + export interface Params$Resource$Globaladdresses$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22585,7 +23018,8 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Globaladdresses$Get { + export interface Params$Resource$Globaladdresses$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22600,7 +23034,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Globaladdresses$Insert { + export interface Params$Resource$Globaladdresses$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22629,7 +23064,8 @@ export namespace compute_alpha { */ requestBody?: Schema$Address; } - export interface Params$Resource$Globaladdresses$List { + export interface Params$Resource$Globaladdresses$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22683,7 +23119,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Globaladdresses$Setlabels { + export interface Params$Resource$Globaladdresses$Setlabels extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22703,7 +23140,8 @@ export namespace compute_alpha { */ requestBody?: Schema$GlobalSetLabelsRequest; } - export interface Params$Resource$Globaladdresses$Testiampermissions { + export interface Params$Resource$Globaladdresses$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22714,7 +23152,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -23247,7 +23685,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -23313,7 +23751,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Globalforwardingrules$Delete { + export interface Params$Resource$Globalforwardingrules$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23341,7 +23780,8 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Globalforwardingrules$Get { + export interface Params$Resource$Globalforwardingrules$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23356,7 +23796,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Globalforwardingrules$Insert { + export interface Params$Resource$Globalforwardingrules$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23385,7 +23826,8 @@ export namespace compute_alpha { */ requestBody?: Schema$ForwardingRule; } - export interface Params$Resource$Globalforwardingrules$List { + export interface Params$Resource$Globalforwardingrules$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23439,7 +23881,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Globalforwardingrules$Patch { + export interface Params$Resource$Globalforwardingrules$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23472,7 +23915,8 @@ export namespace compute_alpha { */ requestBody?: Schema$ForwardingRule; } - export interface Params$Resource$Globalforwardingrules$Setlabels { + export interface Params$Resource$Globalforwardingrules$Setlabels extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23492,7 +23936,8 @@ export namespace compute_alpha { */ requestBody?: Schema$GlobalSetLabelsRequest; } - export interface Params$Resource$Globalforwardingrules$Settarget { + export interface Params$Resource$Globalforwardingrules$Settarget extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23525,7 +23970,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TargetReference; } - export interface Params$Resource$Globalforwardingrules$Testiampermissions { + export interface Params$Resource$Globalforwardingrules$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -23536,7 +23982,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -23919,7 +24365,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Globaloperations$Aggregatedlist { + export interface Params$Resource$Globaloperations$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23973,7 +24420,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Globaloperations$Delete { + export interface Params$Resource$Globaloperations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23988,7 +24436,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Globaloperations$Get { + export interface Params$Resource$Globaloperations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -24003,7 +24452,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Globaloperations$List { + export interface Params$Resource$Globaloperations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -24057,7 +24507,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Globaloperations$Wait { + export interface Params$Resource$Globaloperations$Wait extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -24074,6 +24525,409 @@ export namespace compute_alpha { } + export class Resource$Globalorganizationoperations { + root: Compute; + constructor(root: Compute) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * compute.globalOrganizationOperations.delete + * @desc Deletes the specified Operations resource. + * @alias compute.globalOrganizationOperations.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.operation Name of the Operations resource to delete. + * @param {string=} params.parentId Parent ID for 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 + */ + delete( + params?: Params$Resource$Globalorganizationoperations$Delete, + options?: MethodOptions): AxiosPromise; + delete( + params: Params$Resource$Globalorganizationoperations$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Globalorganizationoperations$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Globalorganizationoperations$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Globalorganizationoperations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalorganizationoperations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/locations/global/operations/{operation}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['operation'], + pathParams: ['operation'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.globalOrganizationOperations.get + * @desc Retrieves the specified Operations resource. Gets a list of + * operations by making a list() request. + * @alias compute.globalOrganizationOperations.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.operation Name of the Operations resource to return. + * @param {string=} params.parentId Parent ID for 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 + */ + get(params?: Params$Resource$Globalorganizationoperations$Get, + options?: MethodOptions): AxiosPromise; + get(params: Params$Resource$Globalorganizationoperations$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Globalorganizationoperations$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Globalorganizationoperations$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Globalorganizationoperations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalorganizationoperations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/locations/global/operations/{operation}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['operation'], + pathParams: ['operation'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.globalOrganizationOperations.list + * @desc Retrieves a list of Operation resources contained within the + * specified organization. + * @alias compute.globalOrganizationOperations.list + * @memberOf! () + * + * @param {object=} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string=} params.parentId Parent ID for 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 + */ + list( + params?: Params$Resource$Globalorganizationoperations$List, + options?: MethodOptions): AxiosPromise; + list( + params: Params$Resource$Globalorganizationoperations$List, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Globalorganizationoperations$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Globalorganizationoperations$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Globalorganizationoperations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalorganizationoperations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/compute/alpha/projects/locations/global/operations') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: [], + pathParams: [], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.globalOrganizationOperations.wait + * @desc Waits for the specified Operations resource until it is done or + * timeout, and retrieves the specified Operations resource. 1. Immediately + * returns when the operation is already done. 2. Waits for no more than the + * default deadline (2 minutes, subject to change) and then returns the + * current state of the operation, which may be DONE or still in + * progress. 3. Is best-effort: a. The server can wait less than the default + * deadline or zero seconds, in overload situations. b. There is no + * guarantee that the operation is actually done when returns. 4. User + * should be prepared to retry if the operation is not DONE. + * @alias compute.globalOrganizationOperations.wait + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.operation Name of the Operations resource to return. + * @param {string=} params.parentId Parent ID for 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 + */ + wait( + params?: Params$Resource$Globalorganizationoperations$Wait, + options?: MethodOptions): AxiosPromise; + wait( + params: Params$Resource$Globalorganizationoperations$Wait, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + wait( + params: Params$Resource$Globalorganizationoperations$Wait, + callback: BodyResponseCallback): void; + wait(callback: BodyResponseCallback): void; + wait( + paramsOrCallback?: Params$Resource$Globalorganizationoperations$Wait| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Globalorganizationoperations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalorganizationoperations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/locations/global/operations/{operation}/wait') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['operation'], + pathParams: ['operation'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Globalorganizationoperations$Delete extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the Operations resource to delete. + */ + operation?: string; + /** + * Parent ID for this request. + */ + parentId?: string; + } + export interface Params$Resource$Globalorganizationoperations$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the Operations resource to return. + */ + operation?: string; + /** + * Parent ID for this request. + */ + parentId?: string; + } + export interface Params$Resource$Globalorganizationoperations$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Parent ID for this request. + */ + parentId?: string; + } + export interface Params$Resource$Globalorganizationoperations$Wait extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the Operations resource to return. + */ + operation?: string; + /** + * Parent ID for this request. + */ + parentId?: string; + } + + export class Resource$Healthchecks { root: Compute; constructor(root: Compute) { @@ -24527,7 +25381,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -24665,7 +25519,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Healthchecks$Aggregatedlist { + export interface Params$Resource$Healthchecks$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -24719,7 +25574,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Healthchecks$Delete { + export interface Params$Resource$Healthchecks$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -24747,7 +25603,7 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Healthchecks$Get { + export interface Params$Resource$Healthchecks$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -24762,7 +25618,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Healthchecks$Insert { + export interface Params$Resource$Healthchecks$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -24791,7 +25648,8 @@ export namespace compute_alpha { */ requestBody?: Schema$HealthCheck; } - export interface Params$Resource$Healthchecks$List { + export interface Params$Resource$Healthchecks$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -24845,7 +25703,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Healthchecks$Patch { + export interface Params$Resource$Healthchecks$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -24878,7 +25737,8 @@ export namespace compute_alpha { */ requestBody?: Schema$HealthCheck; } - export interface Params$Resource$Healthchecks$Testiampermissions { + export interface Params$Resource$Healthchecks$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -24889,7 +25749,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -24898,7 +25758,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Healthchecks$Update { + export interface Params$Resource$Healthchecks$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -25309,7 +26170,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -25447,7 +26308,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Httphealthchecks$Delete { + export interface Params$Resource$Httphealthchecks$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -25475,7 +26337,8 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Httphealthchecks$Get { + export interface Params$Resource$Httphealthchecks$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -25490,7 +26353,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Httphealthchecks$Insert { + export interface Params$Resource$Httphealthchecks$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -25519,7 +26383,8 @@ export namespace compute_alpha { */ requestBody?: Schema$HttpHealthCheck; } - export interface Params$Resource$Httphealthchecks$List { + export interface Params$Resource$Httphealthchecks$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -25573,7 +26438,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Httphealthchecks$Patch { + export interface Params$Resource$Httphealthchecks$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -25606,7 +26472,8 @@ export namespace compute_alpha { */ requestBody?: Schema$HttpHealthCheck; } - export interface Params$Resource$Httphealthchecks$Testiampermissions { + export interface Params$Resource$Httphealthchecks$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -25617,7 +26484,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -25626,7 +26493,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Httphealthchecks$Update { + export interface Params$Resource$Httphealthchecks$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26040,7 +26908,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -26178,7 +27046,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Httpshealthchecks$Delete { + export interface Params$Resource$Httpshealthchecks$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26206,7 +27075,8 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Httpshealthchecks$Get { + export interface Params$Resource$Httpshealthchecks$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26221,7 +27091,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Httpshealthchecks$Insert { + export interface Params$Resource$Httpshealthchecks$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26250,7 +27121,8 @@ export namespace compute_alpha { */ requestBody?: Schema$HttpsHealthCheck; } - export interface Params$Resource$Httpshealthchecks$List { + export interface Params$Resource$Httpshealthchecks$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26304,7 +27176,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Httpshealthchecks$Patch { + export interface Params$Resource$Httpshealthchecks$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26337,7 +27210,8 @@ export namespace compute_alpha { */ requestBody?: Schema$HttpsHealthCheck; } - export interface Params$Resource$Httpshealthchecks$Testiampermissions { + export interface Params$Resource$Httpshealthchecks$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26348,7 +27222,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -26357,7 +27231,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Httpshealthchecks$Update { + export interface Params$Resource$Httpshealthchecks$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26687,7 +27562,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for 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 @@ -26900,7 +27775,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().GlobalSetPolicyRequest} 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. @@ -27041,7 +27916,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -27106,7 +27981,7 @@ export namespace compute_alpha { } } - export interface Params$Resource$Images$Delete { + export interface Params$Resource$Images$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -27134,7 +28009,7 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Images$Deprecate { + export interface Params$Resource$Images$Deprecate extends StandardParameters { /** * Auth client or API Key for the request */ @@ -27167,7 +28042,7 @@ export namespace compute_alpha { */ requestBody?: Schema$DeprecationStatus; } - export interface Params$Resource$Images$Get { + export interface Params$Resource$Images$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -27182,7 +28057,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Images$Getfromfamily { + export interface Params$Resource$Images$Getfromfamily extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -27197,7 +28073,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Images$Getiampolicy { + export interface Params$Resource$Images$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -27208,11 +28085,11 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; } - export interface Params$Resource$Images$Insert { + export interface Params$Resource$Images$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -27245,7 +28122,7 @@ export namespace compute_alpha { */ requestBody?: Schema$Image; } - export interface Params$Resource$Images$List { + export interface Params$Resource$Images$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -27299,7 +28176,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Images$Setiampolicy { + export interface Params$Resource$Images$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -27310,7 +28188,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -27319,7 +28197,7 @@ export namespace compute_alpha { */ requestBody?: Schema$GlobalSetPolicyRequest; } - export interface Params$Resource$Images$Setlabels { + export interface Params$Resource$Images$Setlabels extends StandardParameters { /** * Auth client or API Key for the request */ @@ -27339,7 +28217,8 @@ export namespace compute_alpha { */ requestBody?: Schema$GlobalSetLabelsRequest; } - export interface Params$Resource$Images$Testiampermissions { + export interface Params$Resource$Images$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -27350,7 +28229,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -27375,19 +28254,19 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.abandonInstances - * @desc Schedules a group action to remove the specified instances from the - * managed instance group. Abandoning an instance does not delete the - * instance, but it does remove the instance from any target pools that are - * applied by the managed instance group. This method reduces the targetSize - * of the managed instance group by the number of instances that you - * abandon. This operation is marked as DONE when the action is scheduled - * even if the instances have not yet been removed from the group. You must - * separately verify the status of the abandoning action with the - * listmanagedinstances method. If the group is part of a backend service - * that has enabled connection draining, it can take up to 60 seconds after - * the connection draining duration has elapsed before the VM instance is - * removed or deleted. You can specify a maximum of 1000 instances with - * this method per request. + * @desc Flags the specified instances to be removed from the managed + * instance group. Abandoning an instance does not delete the instance, but + * it does remove the instance from any target pools that are applied by the + * managed instance group. This method reduces the targetSize of the managed + * instance group by the number of instances that you abandon. This + * operation is marked as DONE when the action is scheduled even if the + * instances have not yet been removed from the group. You must separately + * verify the status of the abandoning action with the listmanagedinstances + * method. If the group is part of a backend service that has enabled + * connection draining, it can take up to 60 seconds after the connection + * draining duration has elapsed before the VM instance is removed or + * deleted. You can specify a maximum of 1000 instances with this method + * per request. * @alias compute.instanceGroupManagers.abandonInstances * @memberOf! () * @@ -27697,11 +28576,11 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.deleteInstances - * @desc Schedules a group action to delete the specified instances in the - * managed instance group. The instances are also removed from any target - * pools of which they were a member. This method reduces the targetSize of - * the managed instance group by the number of instances that you delete. - * This operation is marked as DONE when the action is scheduled even if the + * @desc Flags the specified instances in the managed instance group for + * immediate deletion. The instances are also removed from any target pools + * of which they were a member. This method reduces the targetSize of the + * managed instance group by the number of instances that you delete. This + * operation is marked as DONE when the action is scheduled even if the * instances are still being deleted. You must separately verify the status * of the deleting action with the listmanagedinstances method. If the * group is part of a backend service that has enabled connection draining, @@ -27928,14 +28807,13 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.insert * @desc Creates a managed instance group using the information that you - * specify in the request. After the group is created, it schedules an - * action to create instances in the group using the specified instance - * template. This operation is marked as DONE when the group is created even - * if the instances in the group have not yet been created. You must - * separately verify the status of the individual instances with the - * listmanagedinstances method. A managed instance group can have up to - * 1000 VM instances per group. Please contact Cloud Support if you need an - * increase in this limit. + * specify in the request. After the group is created, instances in the + * group are created using the specified instance template. This operation + * is marked as DONE when the group is created even if the instances in the + * group have not yet been created. You must separately verify the status of + * the individual instances with the listmanagedinstances method. A managed + * instance group can have up to 1000 VM instances per group. Please contact + * Cloud Support if you need an increase in this limit. * @alias compute.instanceGroupManagers.insert * @memberOf! () * @@ -28345,16 +29223,16 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.recreateInstances - * @desc Schedules a group action to recreate the specified instances in the - * managed instance group. The instances are deleted and recreated using the + * @desc Flags the specified instances in the managed instance group to be + * immediately recreated. The instances are deleted and recreated using the * current instance template for the managed instance group. This operation - * is marked as DONE when the action is scheduled even if the instances have - * not yet been recreated. You must separately verify the status of the - * recreating action with the listmanagedinstances method. If the group is - * part of a backend service that has enabled connection draining, it can - * take up to 60 seconds after the connection draining duration has elapsed - * before the VM instance is removed or deleted. You can specify a maximum - * of 1000 instances with this method per request. + * is marked as DONE when the flag is set even if the instances have not yet + * been recreated. You must separately verify the status of the recreating + * action with the listmanagedinstances method. If the group is part of a + * backend service that has enabled connection draining, it can take up to + * 60 seconds after the connection draining duration has elapsed before the + * VM instance is removed or deleted. You can specify a maximum of 1000 + * instances with this method per request. * @alias compute.instanceGroupManagers.recreateInstances * @memberOf! () * @@ -28434,10 +29312,15 @@ export namespace compute_alpha { * marked DONE when the resize actions are scheduled even if the group has * not yet added or deleted any instances. You must separately verify the * status of the creating or deleting actions with the listmanagedinstances - * method. If the group is part of a backend service that has enabled - * connection draining, it can take up to 60 seconds after the connection - * draining duration has elapsed before the VM instance is removed or - * deleted. + * method. When resizing down, the instance group arbitrarily chooses the + * order in which VMs are deleted. The group takes into account some VM + * attributes when making the selection including: + The status of the VM + * instance. + The health of the VM instance. + The instance template + * version the VM is based on. + For regional managed instance groups, the + * location of the VM instance. This list is subject to change. If the + * group is part of a backend service that has enabled connection draining, + * it can take up to 60 seconds after the connection draining duration has + * elapsed before the VM instance is removed or deleted. * @alias compute.instanceGroupManagers.resize * @memberOf! () * @@ -28831,7 +29714,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {string} params.zone The name of the zone for this request. * @param {().TestPermissionsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -29053,7 +29936,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Instancegroupmanagers$Abandoninstances { + export interface Params$Resource$Instancegroupmanagers$Abandoninstances + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -29090,7 +29974,8 @@ export namespace compute_alpha { */ requestBody?: Schema$InstanceGroupManagersAbandonInstancesRequest; } - export interface Params$Resource$Instancegroupmanagers$Aggregatedlist { + export interface Params$Resource$Instancegroupmanagers$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -29144,7 +30029,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Instancegroupmanagers$Applyupdatestoinstances { + export interface Params$Resource$Instancegroupmanagers$Applyupdatestoinstances + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -29169,7 +30055,8 @@ export namespace compute_alpha { */ requestBody?: Schema$InstanceGroupManagersApplyUpdatesRequest; } - export interface Params$Resource$Instancegroupmanagers$Delete { + export interface Params$Resource$Instancegroupmanagers$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -29201,7 +30088,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Instancegroupmanagers$Deleteinstances { + export interface Params$Resource$Instancegroupmanagers$Deleteinstances extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -29238,7 +30126,8 @@ export namespace compute_alpha { */ requestBody?: Schema$InstanceGroupManagersDeleteInstancesRequest; } - export interface Params$Resource$Instancegroupmanagers$Deleteperinstanceconfigs { + export interface Params$Resource$Instancegroupmanagers$Deleteperinstanceconfigs + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -29263,7 +30152,8 @@ export namespace compute_alpha { */ requestBody?: Schema$InstanceGroupManagersDeletePerInstanceConfigsReq; } - export interface Params$Resource$Instancegroupmanagers$Get { + export interface Params$Resource$Instancegroupmanagers$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -29282,7 +30172,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Instancegroupmanagers$Insert { + export interface Params$Resource$Instancegroupmanagers$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -29315,7 +30206,8 @@ export namespace compute_alpha { */ requestBody?: Schema$InstanceGroupManager; } - export interface Params$Resource$Instancegroupmanagers$List { + export interface Params$Resource$Instancegroupmanagers$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -29373,7 +30265,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Instancegroupmanagers$Listmanagedinstances { + export interface Params$Resource$Instancegroupmanagers$Listmanagedinstances + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -29435,7 +30328,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Instancegroupmanagers$Listperinstanceconfigs { + export interface Params$Resource$Instancegroupmanagers$Listperinstanceconfigs + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -29498,7 +30392,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Instancegroupmanagers$Patch { + export interface Params$Resource$Instancegroupmanagers$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -29535,7 +30430,8 @@ export namespace compute_alpha { */ requestBody?: Schema$InstanceGroupManager; } - export interface Params$Resource$Instancegroupmanagers$Recreateinstances { + export interface Params$Resource$Instancegroupmanagers$Recreateinstances + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -29572,7 +30468,8 @@ export namespace compute_alpha { */ requestBody?: Schema$InstanceGroupManagersRecreateInstancesRequest; } - export interface Params$Resource$Instancegroupmanagers$Resize { + export interface Params$Resource$Instancegroupmanagers$Resize extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -29611,7 +30508,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Instancegroupmanagers$Resizeadvanced { + export interface Params$Resource$Instancegroupmanagers$Resizeadvanced extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -29648,7 +30546,8 @@ export namespace compute_alpha { */ requestBody?: Schema$InstanceGroupManagersResizeAdvancedRequest; } - export interface Params$Resource$Instancegroupmanagers$Setautohealingpolicies { + export interface Params$Resource$Instancegroupmanagers$Setautohealingpolicies + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -29685,7 +30584,8 @@ export namespace compute_alpha { */ requestBody?: Schema$InstanceGroupManagersSetAutoHealingRequest; } - export interface Params$Resource$Instancegroupmanagers$Setinstancetemplate { + export interface Params$Resource$Instancegroupmanagers$Setinstancetemplate + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -29722,7 +30622,8 @@ export namespace compute_alpha { */ requestBody?: Schema$InstanceGroupManagersSetInstanceTemplateRequest; } - export interface Params$Resource$Instancegroupmanagers$Settargetpools { + export interface Params$Resource$Instancegroupmanagers$Settargetpools extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -29759,7 +30660,8 @@ export namespace compute_alpha { */ requestBody?: Schema$InstanceGroupManagersSetTargetPoolsRequest; } - export interface Params$Resource$Instancegroupmanagers$Testiampermissions { + export interface Params$Resource$Instancegroupmanagers$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -29770,7 +30672,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; /** @@ -29783,7 +30685,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Instancegroupmanagers$Update { + export interface Params$Resource$Instancegroupmanagers$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -29820,7 +30723,8 @@ export namespace compute_alpha { */ requestBody?: Schema$InstanceGroupManager; } - export interface Params$Resource$Instancegroupmanagers$Updateperinstanceconfigs { + export interface Params$Resource$Instancegroupmanagers$Updateperinstanceconfigs + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -30557,7 +31461,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {string} params.zone The name of the zone for this request. * @param {().TestPermissionsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -30623,7 +31527,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Instancegroups$Addinstances { + export interface Params$Resource$Instancegroups$Addinstances extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -30660,7 +31565,8 @@ export namespace compute_alpha { */ requestBody?: Schema$InstanceGroupsAddInstancesRequest; } - export interface Params$Resource$Instancegroups$Aggregatedlist { + export interface Params$Resource$Instancegroups$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -30714,7 +31620,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Instancegroups$Delete { + export interface Params$Resource$Instancegroups$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -30746,7 +31653,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Instancegroups$Get { + export interface Params$Resource$Instancegroups$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -30765,7 +31673,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Instancegroups$Insert { + export interface Params$Resource$Instancegroups$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -30798,7 +31707,8 @@ export namespace compute_alpha { */ requestBody?: Schema$InstanceGroup; } - export interface Params$Resource$Instancegroups$List { + export interface Params$Resource$Instancegroups$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -30856,7 +31766,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Instancegroups$Listinstances { + export interface Params$Resource$Instancegroups$Listinstances extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -30924,7 +31835,8 @@ export namespace compute_alpha { */ requestBody?: Schema$InstanceGroupsListInstancesRequest; } - export interface Params$Resource$Instancegroups$Removeinstances { + export interface Params$Resource$Instancegroups$Removeinstances extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -30962,7 +31874,8 @@ export namespace compute_alpha { */ requestBody?: Schema$InstanceGroupsRemoveInstancesRequest; } - export interface Params$Resource$Instancegroups$Setnamedports { + export interface Params$Resource$Instancegroups$Setnamedports extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -30999,7 +31912,8 @@ export namespace compute_alpha { */ requestBody?: Schema$InstanceGroupsSetNamedPortsRequest; } - export interface Params$Resource$Instancegroups$Testiampermissions { + export interface Params$Resource$Instancegroups$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -31010,7 +31924,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; /** @@ -31706,7 +32620,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {string} params.zone The name of the zone for this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -32062,7 +32976,8 @@ export namespace compute_alpha { /** * compute.instances.listReferrers * @desc Retrieves the list of referrers to instances contained within the - * specified zone. + * specified zone. For more information, read Viewing Referrers to VM + * Instances. * @alias compute.instances.listReferrers * @memberOf! () * @@ -32512,7 +33427,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {string} params.zone The name of the zone for this request. * @param {().ZoneSetPolicyRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -33172,8 +34087,8 @@ export namespace compute_alpha { /** * compute.instances.setTags - * @desc Sets tags for the specified instance to the data included in the - * request. + * @desc Sets network tags for the specified instance to the data included + * in the request. * @alias compute.instances.setTags * @memberOf! () * @@ -33624,7 +34539,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {string} params.zone The name of the zone for this request. * @param {().TestPermissionsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -33919,7 +34834,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Instances$Addaccessconfig { + export interface Params$Resource$Instances$Addaccessconfig extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -33960,7 +34876,8 @@ export namespace compute_alpha { */ requestBody?: Schema$AccessConfig; } - export interface Params$Resource$Instances$Addresourcepolicies { + export interface Params$Resource$Instances$Addresourcepolicies extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -33997,7 +34914,8 @@ export namespace compute_alpha { */ requestBody?: Schema$InstancesAddResourcePoliciesRequest; } - export interface Params$Resource$Instances$Aggregatedlist { + export interface Params$Resource$Instances$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -34051,7 +34969,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Instances$Attachdisk { + export interface Params$Resource$Instances$Attachdisk extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -34093,7 +35012,7 @@ export namespace compute_alpha { */ requestBody?: Schema$AttachedDisk; } - export interface Params$Resource$Instances$Delete { + export interface Params$Resource$Instances$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -34125,7 +35044,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Instances$Deleteaccessconfig { + export interface Params$Resource$Instances$Deleteaccessconfig extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -34165,7 +35085,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Instances$Detachdisk { + export interface Params$Resource$Instances$Detachdisk extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -34201,7 +35122,7 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Instances$Get { + export interface Params$Resource$Instances$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -34220,7 +35141,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Instances$Getguestattributes { + export interface Params$Resource$Instances$Getguestattributes extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -34247,7 +35169,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Instances$Getiampolicy { + export interface Params$Resource$Instances$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -34258,7 +35181,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; /** @@ -34266,7 +35189,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Instances$Getserialportoutput { + export interface Params$Resource$Instances$Getserialportoutput extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -34297,7 +35221,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Instances$Getshieldedvmidentity { + export interface Params$Resource$Instances$Getshieldedvmidentity extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -34316,7 +35241,7 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Instances$Insert { + export interface Params$Resource$Instances$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -34367,7 +35292,7 @@ export namespace compute_alpha { */ requestBody?: Schema$Instance; } - export interface Params$Resource$Instances$List { + export interface Params$Resource$Instances$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -34425,7 +35350,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Instances$Listreferrers { + export interface Params$Resource$Instances$Listreferrers extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -34488,7 +35414,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Instances$Removeresourcepolicies { + export interface Params$Resource$Instances$Removeresourcepolicies extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -34525,7 +35452,7 @@ export namespace compute_alpha { */ requestBody?: Schema$InstancesRemoveResourcePoliciesRequest; } - export interface Params$Resource$Instances$Reset { + export interface Params$Resource$Instances$Reset extends StandardParameters { /** * Auth client or API Key for the request */ @@ -34557,7 +35484,7 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Instances$Resume { + export interface Params$Resource$Instances$Resume extends StandardParameters { /** * Auth client or API Key for the request */ @@ -34594,7 +35521,8 @@ export namespace compute_alpha { */ requestBody?: Schema$InstancesResumeRequest; } - export interface Params$Resource$Instances$Setdeletionprotection { + export interface Params$Resource$Instances$Setdeletionprotection extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -34630,7 +35558,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Instances$Setdiskautodelete { + export interface Params$Resource$Instances$Setdiskautodelete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -34670,7 +35599,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Instances$Setiampolicy { + export interface Params$Resource$Instances$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -34681,7 +35611,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; /** @@ -34694,7 +35624,8 @@ export namespace compute_alpha { */ requestBody?: Schema$ZoneSetPolicyRequest; } - export interface Params$Resource$Instances$Setlabels { + export interface Params$Resource$Instances$Setlabels extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -34731,7 +35662,8 @@ export namespace compute_alpha { */ requestBody?: Schema$InstancesSetLabelsRequest; } - export interface Params$Resource$Instances$Setmachineresources { + export interface Params$Resource$Instances$Setmachineresources extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -34768,7 +35700,8 @@ export namespace compute_alpha { */ requestBody?: Schema$InstancesSetMachineResourcesRequest; } - export interface Params$Resource$Instances$Setmachinetype { + export interface Params$Resource$Instances$Setmachinetype extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -34805,7 +35738,8 @@ export namespace compute_alpha { */ requestBody?: Schema$InstancesSetMachineTypeRequest; } - export interface Params$Resource$Instances$Setmetadata { + export interface Params$Resource$Instances$Setmetadata extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -34842,7 +35776,8 @@ export namespace compute_alpha { */ requestBody?: Schema$Metadata; } - export interface Params$Resource$Instances$Setmincpuplatform { + export interface Params$Resource$Instances$Setmincpuplatform extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -34879,7 +35814,8 @@ export namespace compute_alpha { */ requestBody?: Schema$InstancesSetMinCpuPlatformRequest; } - export interface Params$Resource$Instances$Setscheduling { + export interface Params$Resource$Instances$Setscheduling extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -34916,7 +35852,8 @@ export namespace compute_alpha { */ requestBody?: Schema$Scheduling; } - export interface Params$Resource$Instances$Setserviceaccount { + export interface Params$Resource$Instances$Setserviceaccount extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -34953,7 +35890,8 @@ export namespace compute_alpha { */ requestBody?: Schema$InstancesSetServiceAccountRequest; } - export interface Params$Resource$Instances$Setshieldedvmintegritypolicy { + export interface Params$Resource$Instances$Setshieldedvmintegritypolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -34990,7 +35928,8 @@ export namespace compute_alpha { */ requestBody?: Schema$ShieldedVmIntegrityPolicy; } - export interface Params$Resource$Instances$Settags { + export interface Params$Resource$Instances$Settags extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -35027,7 +35966,8 @@ export namespace compute_alpha { */ requestBody?: Schema$Tags; } - export interface Params$Resource$Instances$Simulatemaintenanceevent { + export interface Params$Resource$Instances$Simulatemaintenanceevent extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -35046,7 +35986,7 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Instances$Start { + export interface Params$Resource$Instances$Start extends StandardParameters { /** * Auth client or API Key for the request */ @@ -35078,7 +36018,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Instances$Startwithencryptionkey { + export interface Params$Resource$Instances$Startwithencryptionkey extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -35115,7 +36056,7 @@ export namespace compute_alpha { */ requestBody?: Schema$InstancesStartWithEncryptionKeyRequest; } - export interface Params$Resource$Instances$Stop { + export interface Params$Resource$Instances$Stop extends StandardParameters { /** * Auth client or API Key for the request */ @@ -35152,7 +36093,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Instances$Suspend { + export interface Params$Resource$Instances$Suspend extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -35189,7 +36131,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Instances$Testiampermissions { + export interface Params$Resource$Instances$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -35200,7 +36143,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; /** @@ -35213,7 +36156,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Instances$Updateaccessconfig { + export interface Params$Resource$Instances$Updateaccessconfig extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -35254,7 +36198,8 @@ export namespace compute_alpha { */ requestBody?: Schema$AccessConfig; } - export interface Params$Resource$Instances$Updatenetworkinterface { + export interface Params$Resource$Instances$Updatenetworkinterface extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -35295,7 +36240,8 @@ export namespace compute_alpha { */ requestBody?: Schema$NetworkInterface; } - export interface Params$Resource$Instances$Updateshieldedvmconfig { + export interface Params$Resource$Instances$Updateshieldedvmconfig extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -35495,7 +36441,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for 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 @@ -35715,7 +36661,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().GlobalSetPolicyRequest} 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. @@ -35785,7 +36731,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -35850,7 +36796,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Instancetemplates$Delete { + export interface Params$Resource$Instancetemplates$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -35878,7 +36825,8 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Instancetemplates$Get { + export interface Params$Resource$Instancetemplates$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -35893,7 +36841,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Instancetemplates$Getiampolicy { + export interface Params$Resource$Instancetemplates$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -35904,11 +36853,12 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; } - export interface Params$Resource$Instancetemplates$Insert { + export interface Params$Resource$Instancetemplates$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -35937,7 +36887,8 @@ export namespace compute_alpha { */ requestBody?: Schema$InstanceTemplate; } - export interface Params$Resource$Instancetemplates$List { + export interface Params$Resource$Instancetemplates$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -35991,7 +36942,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Instancetemplates$Setiampolicy { + export interface Params$Resource$Instancetemplates$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -36002,7 +36954,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -36011,7 +36963,8 @@ export namespace compute_alpha { */ requestBody?: Schema$GlobalSetPolicyRequest; } - export interface Params$Resource$Instancetemplates$Testiampermissions { + export interface Params$Resource$Instancetemplates$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -36022,7 +36975,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -36281,7 +37234,7 @@ export namespace compute_alpha { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for 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 @@ -36581,7 +37534,7 @@ export namespace compute_alpha { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().RegionSetPolicyRequest} 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. @@ -36726,7 +37679,7 @@ export namespace compute_alpha { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -36793,7 +37746,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Interconnectattachments$Aggregatedlist { + export interface Params$Resource$Interconnectattachments$Aggregatedlist + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -36847,7 +37801,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Interconnectattachments$Delete { + export interface Params$Resource$Interconnectattachments$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -36879,7 +37834,8 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Interconnectattachments$Get { + export interface Params$Resource$Interconnectattachments$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -36898,7 +37854,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Interconnectattachments$Getiampolicy { + export interface Params$Resource$Interconnectattachments$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -36913,11 +37870,12 @@ export namespace compute_alpha { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; } - export interface Params$Resource$Interconnectattachments$Insert { + export interface Params$Resource$Interconnectattachments$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -36950,7 +37908,8 @@ export namespace compute_alpha { */ requestBody?: Schema$InterconnectAttachment; } - export interface Params$Resource$Interconnectattachments$List { + export interface Params$Resource$Interconnectattachments$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -37008,7 +37967,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Interconnectattachments$Patch { + export interface Params$Resource$Interconnectattachments$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -37045,7 +38005,8 @@ export namespace compute_alpha { */ requestBody?: Schema$InterconnectAttachment; } - export interface Params$Resource$Interconnectattachments$Setiampolicy { + export interface Params$Resource$Interconnectattachments$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -37060,7 +38021,7 @@ export namespace compute_alpha { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -37069,7 +38030,8 @@ export namespace compute_alpha { */ requestBody?: Schema$RegionSetPolicyRequest; } - export interface Params$Resource$Interconnectattachments$Setlabels { + export interface Params$Resource$Interconnectattachments$Setlabels extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -37106,7 +38068,8 @@ export namespace compute_alpha { */ requestBody?: Schema$RegionSetLabelsRequest; } - export interface Params$Resource$Interconnectattachments$Testiampermissions { + export interface Params$Resource$Interconnectattachments$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -37121,7 +38084,7 @@ export namespace compute_alpha { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -37295,7 +38258,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -37361,7 +38324,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Interconnectlocations$Get { + export interface Params$Resource$Interconnectlocations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -37376,7 +38340,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Interconnectlocations$List { + export interface Params$Resource$Interconnectlocations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -37430,7 +38395,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Interconnectlocations$Testiampermissions { + export interface Params$Resource$Interconnectlocations$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -37441,7 +38407,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -37693,7 +38659,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for 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 @@ -37980,7 +38946,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().GlobalSetPolicyRequest} 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. @@ -38122,7 +39088,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -38187,7 +39153,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Interconnects$Delete { + export interface Params$Resource$Interconnects$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -38215,7 +39182,8 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Interconnects$Get { + export interface Params$Resource$Interconnects$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -38230,7 +39198,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Interconnects$Getdiagnostics { + export interface Params$Resource$Interconnects$Getdiagnostics extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -38245,7 +39214,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Interconnects$Getiampolicy { + export interface Params$Resource$Interconnects$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -38256,11 +39226,12 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; } - export interface Params$Resource$Interconnects$Insert { + export interface Params$Resource$Interconnects$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -38289,7 +39260,8 @@ export namespace compute_alpha { */ requestBody?: Schema$Interconnect; } - export interface Params$Resource$Interconnects$List { + export interface Params$Resource$Interconnects$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -38343,7 +39315,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Interconnects$Patch { + export interface Params$Resource$Interconnects$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -38376,7 +39349,8 @@ export namespace compute_alpha { */ requestBody?: Schema$Interconnect; } - export interface Params$Resource$Interconnects$Setiampolicy { + export interface Params$Resource$Interconnects$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -38387,7 +39361,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -38396,7 +39370,8 @@ export namespace compute_alpha { */ requestBody?: Schema$GlobalSetPolicyRequest; } - export interface Params$Resource$Interconnects$Setlabels { + export interface Params$Resource$Interconnects$Setlabels extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -38416,7 +39391,8 @@ export namespace compute_alpha { */ requestBody?: Schema$GlobalSetLabelsRequest; } - export interface Params$Resource$Interconnects$Testiampermissions { + export interface Params$Resource$Interconnects$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -38427,7 +39403,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -38525,7 +39501,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for 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 @@ -38595,7 +39571,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().GlobalSetPolicyRequest} 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. @@ -38665,7 +39641,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -38730,7 +39706,7 @@ export namespace compute_alpha { } } - export interface Params$Resource$Licensecodes$Get { + export interface Params$Resource$Licensecodes$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -38745,7 +39721,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Licensecodes$Getiampolicy { + export interface Params$Resource$Licensecodes$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -38756,11 +39733,12 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; } - export interface Params$Resource$Licensecodes$Setiampolicy { + export interface Params$Resource$Licensecodes$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -38771,7 +39749,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -38780,7 +39758,8 @@ export namespace compute_alpha { */ requestBody?: Schema$GlobalSetPolicyRequest; } - export interface Params$Resource$Licensecodes$Testiampermissions { + export interface Params$Resource$Licensecodes$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -38791,7 +39770,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -38956,7 +39935,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for 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 @@ -39170,7 +40149,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().GlobalSetPolicyRequest} 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. @@ -39240,7 +40219,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -39305,7 +40284,7 @@ export namespace compute_alpha { } } - export interface Params$Resource$Licenses$Delete { + export interface Params$Resource$Licenses$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -39333,7 +40312,7 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Licenses$Get { + export interface Params$Resource$Licenses$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -39348,7 +40327,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Licenses$Getiampolicy { + export interface Params$Resource$Licenses$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -39359,11 +40339,11 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; } - export interface Params$Resource$Licenses$Insert { + export interface Params$Resource$Licenses$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -39392,7 +40372,7 @@ export namespace compute_alpha { */ requestBody?: Schema$License; } - export interface Params$Resource$Licenses$List { + export interface Params$Resource$Licenses$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -39446,7 +40426,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Licenses$Setiampolicy { + export interface Params$Resource$Licenses$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -39457,7 +40438,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -39466,7 +40447,8 @@ export namespace compute_alpha { */ requestBody?: Schema$GlobalSetPolicyRequest; } - export interface Params$Resource$Licenses$Testiampermissions { + export interface Params$Resource$Licenses$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -39477,7 +40459,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -39648,7 +40630,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for 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 @@ -39865,7 +40847,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().GlobalSetPolicyRequest} 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. @@ -39935,7 +40917,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -40000,7 +40982,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Machineimages$Delete { + export interface Params$Resource$Machineimages$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40028,7 +41011,8 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Machineimages$Get { + export interface Params$Resource$Machineimages$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40043,7 +41027,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Machineimages$Getiampolicy { + export interface Params$Resource$Machineimages$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40054,11 +41039,12 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; } - export interface Params$Resource$Machineimages$Insert { + export interface Params$Resource$Machineimages$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40091,7 +41077,8 @@ export namespace compute_alpha { */ requestBody?: Schema$MachineImage; } - export interface Params$Resource$Machineimages$List { + export interface Params$Resource$Machineimages$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40145,7 +41132,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Machineimages$Setiampolicy { + export interface Params$Resource$Machineimages$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40156,7 +41144,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -40165,7 +41153,8 @@ export namespace compute_alpha { */ requestBody?: Schema$GlobalSetPolicyRequest; } - export interface Params$Resource$Machineimages$Testiampermissions { + export interface Params$Resource$Machineimages$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40176,7 +41165,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -40416,7 +41405,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Machinetypes$Aggregatedlist { + export interface Params$Resource$Machinetypes$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40470,7 +41460,7 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Machinetypes$Get { + export interface Params$Resource$Machinetypes$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -40489,7 +41479,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Machinetypes$List { + export interface Params$Resource$Machinetypes$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -41190,7 +42181,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {string} params.zone The name of the zone for this request. * @param {().TestPermissionsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -41257,7 +42248,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Networkendpointgroups$Aggregatedlist { + export interface Params$Resource$Networkendpointgroups$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -41311,7 +42303,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Networkendpointgroups$Attachnetworkendpoints { + export interface Params$Resource$Networkendpointgroups$Attachnetworkendpoints + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -41350,7 +42343,8 @@ export namespace compute_alpha { */ requestBody?: Schema$NetworkEndpointGroupsAttachEndpointsRequest; } - export interface Params$Resource$Networkendpointgroups$Delete { + export interface Params$Resource$Networkendpointgroups$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -41384,7 +42378,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Networkendpointgroups$Detachnetworkendpoints { + export interface Params$Resource$Networkendpointgroups$Detachnetworkendpoints + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -41423,7 +42418,8 @@ export namespace compute_alpha { */ requestBody?: Schema$NetworkEndpointGroupsDetachEndpointsRequest; } - export interface Params$Resource$Networkendpointgroups$Get { + export interface Params$Resource$Networkendpointgroups$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -41443,7 +42439,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Networkendpointgroups$Insert { + export interface Params$Resource$Networkendpointgroups$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -41477,7 +42474,8 @@ export namespace compute_alpha { */ requestBody?: Schema$NetworkEndpointGroup; } - export interface Params$Resource$Networkendpointgroups$List { + export interface Params$Resource$Networkendpointgroups$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -41536,7 +42534,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Networkendpointgroups$Listnetworkendpoints { + export interface Params$Resource$Networkendpointgroups$Listnetworkendpoints + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -41605,7 +42604,8 @@ export namespace compute_alpha { */ requestBody?: Schema$NetworkEndpointGroupsListEndpointsRequest; } - export interface Params$Resource$Networkendpointgroups$Testiampermissions { + export interface Params$Resource$Networkendpointgroups$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -41616,7 +42616,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; /** @@ -42143,6 +43143,90 @@ export namespace compute_alpha { } + /** + * compute.networks.listPeeringRoutes + * @desc Lists the peering routes exchanged over peering connection. + * @alias compute.networks.listPeeringRoutes + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.direction The direction of the exchanged routes. + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string} params.network Name of the network for this request. + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string=} params.peeringName The response will show routes exchanged over the given peering connection. + * @param {string} params.project Project ID for this request. + * @param {string=} params.region The region of the request. The response will include all subnet routes, static routes and dynamic routes in the region. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + listPeeringRoutes( + params?: Params$Resource$Networks$Listpeeringroutes, + options?: MethodOptions): + AxiosPromise; + listPeeringRoutes( + params: Params$Resource$Networks$Listpeeringroutes, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + listPeeringRoutes( + params: Params$Resource$Networks$Listpeeringroutes, + callback: BodyResponseCallback): + void; + listPeeringRoutes( + callback: BodyResponseCallback): + void; + listPeeringRoutes( + paramsOrCallback?: Params$Resource$Networks$Listpeeringroutes| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Networks$Listpeeringroutes; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Networks$Listpeeringroutes; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/global/networks/{network}/listPeeringRoutes') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'network'], + pathParams: ['network', 'project'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.networks.patch * @desc Patches the specified network with the data included in the @@ -42367,7 +43451,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -42507,7 +43591,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Networks$Addpeering { + export interface Params$Resource$Networks$Addpeering extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -42540,7 +43625,7 @@ export namespace compute_alpha { */ requestBody?: Schema$NetworksAddPeeringRequest; } - export interface Params$Resource$Networks$Delete { + export interface Params$Resource$Networks$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -42568,7 +43653,7 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Networks$Get { + export interface Params$Resource$Networks$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -42583,7 +43668,7 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Networks$Insert { + export interface Params$Resource$Networks$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -42612,7 +43697,7 @@ export namespace compute_alpha { */ requestBody?: Schema$Network; } - export interface Params$Resource$Networks$List { + export interface Params$Resource$Networks$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -42666,7 +43751,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Networks$Listipaddresses { + export interface Params$Resource$Networks$Listipaddresses extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -42729,7 +43815,8 @@ export namespace compute_alpha { */ types?: string; } - export interface Params$Resource$Networks$Listipowners { + export interface Params$Resource$Networks$Listipowners extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -42807,7 +43894,80 @@ export namespace compute_alpha { */ subnetRegion?: string; } - export interface Params$Resource$Networks$Patch { + export interface Params$Resource$Networks$Listpeeringroutes extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The direction of the exchanged routes. + */ + direction?: string; + /** + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) + */ + maxResults?: number; + /** + * Name of the network for this request. + */ + network?: string; + /** + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * The response will show routes exchanged over the given peering + * connection. + */ + peeringName?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The region of the request. The response will include all subnet routes, + * static routes and dynamic routes in the region. + */ + region?: string; + } + export interface Params$Resource$Networks$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -42840,7 +44000,8 @@ export namespace compute_alpha { */ requestBody?: Schema$Network; } - export interface Params$Resource$Networks$Removepeering { + export interface Params$Resource$Networks$Removepeering extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -42873,7 +44034,8 @@ export namespace compute_alpha { */ requestBody?: Schema$NetworksRemovePeeringRequest; } - export interface Params$Resource$Networks$Switchtocustommode { + export interface Params$Resource$Networks$Switchtocustommode extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -42901,7 +44063,8 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Networks$Testiampermissions { + export interface Params$Resource$Networks$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -42912,7 +44075,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -42921,7 +44084,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Networks$Updatepeering { + export interface Params$Resource$Networks$Updatepeering extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -43337,7 +44501,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {string} params.zone The name of the zone for this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -43627,7 +44791,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {string} params.zone The name of the zone for this request. * @param {().ZoneSetPolicyRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -43771,7 +44935,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {string} params.zone The name of the zone for this request. * @param {().TestPermissionsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -43837,7 +45001,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Nodegroups$Addnodes { + export interface Params$Resource$Nodegroups$Addnodes extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -43874,7 +45039,8 @@ export namespace compute_alpha { */ requestBody?: Schema$NodeGroupsAddNodesRequest; } - export interface Params$Resource$Nodegroups$Aggregatedlist { + export interface Params$Resource$Nodegroups$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -43928,7 +45094,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Nodegroups$Delete { + export interface Params$Resource$Nodegroups$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -43960,7 +45127,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Nodegroups$Deletenodes { + export interface Params$Resource$Nodegroups$Deletenodes extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -43997,7 +45165,7 @@ export namespace compute_alpha { */ requestBody?: Schema$NodeGroupsDeleteNodesRequest; } - export interface Params$Resource$Nodegroups$Get { + export interface Params$Resource$Nodegroups$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -44016,7 +45184,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Nodegroups$Getiampolicy { + export interface Params$Resource$Nodegroups$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -44027,7 +45196,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; /** @@ -44035,7 +45204,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Nodegroups$Insert { + export interface Params$Resource$Nodegroups$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -44072,7 +45242,7 @@ export namespace compute_alpha { */ requestBody?: Schema$NodeGroup; } - export interface Params$Resource$Nodegroups$List { + export interface Params$Resource$Nodegroups$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -44130,7 +45300,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Nodegroups$Listnodes { + export interface Params$Resource$Nodegroups$Listnodes extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -44192,7 +45363,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Nodegroups$Setiampolicy { + export interface Params$Resource$Nodegroups$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -44203,7 +45375,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; /** @@ -44216,7 +45388,8 @@ export namespace compute_alpha { */ requestBody?: Schema$ZoneSetPolicyRequest; } - export interface Params$Resource$Nodegroups$Setnodetemplate { + export interface Params$Resource$Nodegroups$Setnodetemplate extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -44253,7 +45426,8 @@ export namespace compute_alpha { */ requestBody?: Schema$NodeGroupsSetNodeTemplateRequest; } - export interface Params$Resource$Nodegroups$Testiampermissions { + export interface Params$Resource$Nodegroups$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -44264,7 +45438,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; /** @@ -44521,7 +45695,7 @@ export namespace compute_alpha { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for 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 @@ -44739,7 +45913,7 @@ export namespace compute_alpha { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().RegionSetPolicyRequest} 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. @@ -44810,7 +45984,7 @@ export namespace compute_alpha { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -44875,7 +46049,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Nodetemplates$Aggregatedlist { + export interface Params$Resource$Nodetemplates$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -44929,7 +46104,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Nodetemplates$Delete { + export interface Params$Resource$Nodetemplates$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -44961,7 +46137,8 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Nodetemplates$Get { + export interface Params$Resource$Nodetemplates$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -44980,7 +46157,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Nodetemplates$Getiampolicy { + export interface Params$Resource$Nodetemplates$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -44995,11 +46173,12 @@ export namespace compute_alpha { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; } - export interface Params$Resource$Nodetemplates$Insert { + export interface Params$Resource$Nodetemplates$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -45032,7 +46211,8 @@ export namespace compute_alpha { */ requestBody?: Schema$NodeTemplate; } - export interface Params$Resource$Nodetemplates$List { + export interface Params$Resource$Nodetemplates$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -45090,7 +46270,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Nodetemplates$Setiampolicy { + export interface Params$Resource$Nodetemplates$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -45105,7 +46286,7 @@ export namespace compute_alpha { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -45114,7 +46295,8 @@ export namespace compute_alpha { */ requestBody?: Schema$RegionSetPolicyRequest; } - export interface Params$Resource$Nodetemplates$Testiampermissions { + export interface Params$Resource$Nodetemplates$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -45129,7 +46311,7 @@ export namespace compute_alpha { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -45363,7 +46545,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Nodetypes$Aggregatedlist { + export interface Params$Resource$Nodetypes$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -45417,7 +46600,7 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Nodetypes$Get { + export interface Params$Resource$Nodetypes$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -45436,7 +46619,7 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Nodetypes$List { + export interface Params$Resource$Nodetypes$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -46496,7 +47679,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Projects$Disablexpnhost { + export interface Params$Resource$Projects$Disablexpnhost extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -46520,7 +47704,8 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Projects$Disablexpnresource { + export interface Params$Resource$Projects$Disablexpnresource extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -46549,7 +47734,8 @@ export namespace compute_alpha { */ requestBody?: Schema$ProjectsDisableXpnResourceRequest; } - export interface Params$Resource$Projects$Enablexpnhost { + export interface Params$Resource$Projects$Enablexpnhost extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -46573,7 +47759,8 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Projects$Enablexpnresource { + export interface Params$Resource$Projects$Enablexpnresource extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -46602,7 +47789,7 @@ export namespace compute_alpha { */ requestBody?: Schema$ProjectsEnableXpnResourceRequest; } - export interface Params$Resource$Projects$Get { + export interface Params$Resource$Projects$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -46613,7 +47800,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Projects$Getxpnhost { + export interface Params$Resource$Projects$Getxpnhost extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -46624,7 +47812,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Projects$Getxpnresources { + export interface Params$Resource$Projects$Getxpnresources extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -46678,7 +47867,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Projects$Listxpnhosts { + export interface Params$Resource$Projects$Listxpnhosts extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -46737,7 +47927,8 @@ export namespace compute_alpha { */ requestBody?: Schema$ProjectsListXpnHostsRequest; } - export interface Params$Resource$Projects$Movedisk { + export interface Params$Resource$Projects$Movedisk extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -46766,7 +47957,8 @@ export namespace compute_alpha { */ requestBody?: Schema$DiskMoveRequest; } - export interface Params$Resource$Projects$Moveinstance { + export interface Params$Resource$Projects$Moveinstance extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -46795,7 +47987,8 @@ export namespace compute_alpha { */ requestBody?: Schema$InstanceMoveRequest; } - export interface Params$Resource$Projects$Setcommoninstancemetadata { + export interface Params$Resource$Projects$Setcommoninstancemetadata extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -46824,7 +48017,8 @@ export namespace compute_alpha { */ requestBody?: Schema$Metadata; } - export interface Params$Resource$Projects$Setdefaultnetworktier { + export interface Params$Resource$Projects$Setdefaultnetworktier extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -46853,7 +48047,8 @@ export namespace compute_alpha { */ requestBody?: Schema$ProjectsSetDefaultNetworkTierRequest; } - export interface Params$Resource$Projects$Setdefaultserviceaccount { + export interface Params$Resource$Projects$Setdefaultserviceaccount extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -46882,7 +48077,8 @@ export namespace compute_alpha { */ requestBody?: Schema$ProjectsSetDefaultServiceAccountRequest; } - export interface Params$Resource$Projects$Setusageexportbucket { + export interface Params$Resource$Projects$Setusageexportbucket extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -47297,7 +48493,7 @@ export namespace compute_alpha { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -47436,7 +48632,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Regionautoscalers$Delete { + export interface Params$Resource$Regionautoscalers$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -47468,7 +48665,8 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Regionautoscalers$Get { + export interface Params$Resource$Regionautoscalers$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -47487,7 +48685,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Regionautoscalers$Insert { + export interface Params$Resource$Regionautoscalers$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -47520,7 +48719,8 @@ export namespace compute_alpha { */ requestBody?: Schema$Autoscaler; } - export interface Params$Resource$Regionautoscalers$List { + export interface Params$Resource$Regionautoscalers$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -47578,7 +48778,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Regionautoscalers$Patch { + export interface Params$Resource$Regionautoscalers$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -47615,7 +48816,8 @@ export namespace compute_alpha { */ requestBody?: Schema$Autoscaler; } - export interface Params$Resource$Regionautoscalers$Testiampermissions { + export interface Params$Resource$Regionautoscalers$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -47630,7 +48832,7 @@ export namespace compute_alpha { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -47639,7 +48841,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Regionautoscalers$Update { + export interface Params$Resource$Regionautoscalers$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -48143,7 +49346,7 @@ export namespace compute_alpha { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -48285,7 +49488,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Regionbackendservices$Delete { + export interface Params$Resource$Regionbackendservices$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -48317,7 +49521,8 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Regionbackendservices$Get { + export interface Params$Resource$Regionbackendservices$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -48336,7 +49541,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Regionbackendservices$Gethealth { + export interface Params$Resource$Regionbackendservices$Gethealth extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -48360,7 +49566,8 @@ export namespace compute_alpha { */ requestBody?: Schema$ResourceGroupReference; } - export interface Params$Resource$Regionbackendservices$Insert { + export interface Params$Resource$Regionbackendservices$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -48393,7 +49600,8 @@ export namespace compute_alpha { */ requestBody?: Schema$BackendService; } - export interface Params$Resource$Regionbackendservices$List { + export interface Params$Resource$Regionbackendservices$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -48451,7 +49659,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Regionbackendservices$Patch { + export interface Params$Resource$Regionbackendservices$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -48488,7 +49697,8 @@ export namespace compute_alpha { */ requestBody?: Schema$BackendService; } - export interface Params$Resource$Regionbackendservices$Testiampermissions { + export interface Params$Resource$Regionbackendservices$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -48503,7 +49713,7 @@ export namespace compute_alpha { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -48512,7 +49722,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Regionbackendservices$Update { + export interface Params$Resource$Regionbackendservices$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -48862,7 +50073,7 @@ export namespace compute_alpha { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -48927,7 +50138,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Regioncommitments$Aggregatedlist { + export interface Params$Resource$Regioncommitments$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -48981,7 +50193,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Regioncommitments$Get { + export interface Params$Resource$Regioncommitments$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -49000,7 +50213,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Regioncommitments$Insert { + export interface Params$Resource$Regioncommitments$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -49033,7 +50247,8 @@ export namespace compute_alpha { */ requestBody?: Schema$Commitment; } - export interface Params$Resource$Regioncommitments$List { + export interface Params$Resource$Regioncommitments$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -49091,7 +50306,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Regioncommitments$Testiampermissions { + export interface Params$Resource$Regioncommitments$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -49106,7 +50322,7 @@ export namespace compute_alpha { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -49791,7 +51007,7 @@ export namespace compute_alpha { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -49856,7 +51072,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Regiondisks$Addresourcepolicies { + export interface Params$Resource$Regiondisks$Addresourcepolicies extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -49893,7 +51110,8 @@ export namespace compute_alpha { */ requestBody?: Schema$RegionDisksAddResourcePoliciesRequest; } - export interface Params$Resource$Regiondisks$Createsnapshot { + export interface Params$Resource$Regiondisks$Createsnapshot extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -49934,7 +51152,8 @@ export namespace compute_alpha { */ requestBody?: Schema$Snapshot; } - export interface Params$Resource$Regiondisks$Delete { + export interface Params$Resource$Regiondisks$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -49966,7 +51185,7 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Regiondisks$Get { + export interface Params$Resource$Regiondisks$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -49985,7 +51204,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Regiondisks$Insert { + export interface Params$Resource$Regiondisks$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -50022,7 +51242,7 @@ export namespace compute_alpha { */ requestBody?: Schema$Disk; } - export interface Params$Resource$Regiondisks$List { + export interface Params$Resource$Regiondisks$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -50080,7 +51300,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Regiondisks$Removeresourcepolicies { + export interface Params$Resource$Regiondisks$Removeresourcepolicies extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -50117,7 +51338,8 @@ export namespace compute_alpha { */ requestBody?: Schema$RegionDisksRemoveResourcePoliciesRequest; } - export interface Params$Resource$Regiondisks$Resize { + export interface Params$Resource$Regiondisks$Resize extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -50154,7 +51376,8 @@ export namespace compute_alpha { */ requestBody?: Schema$RegionDisksResizeRequest; } - export interface Params$Resource$Regiondisks$Setlabels { + export interface Params$Resource$Regiondisks$Setlabels extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -50191,7 +51414,8 @@ export namespace compute_alpha { */ requestBody?: Schema$RegionSetLabelsRequest; } - export interface Params$Resource$Regiondisks$Testiampermissions { + export interface Params$Resource$Regiondisks$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -50206,7 +51430,7 @@ export namespace compute_alpha { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -50371,7 +51595,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Regiondisktypes$Get { + export interface Params$Resource$Regiondisktypes$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -50390,7 +51615,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Regiondisktypes$List { + export interface Params$Resource$Regiondisktypes$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -50834,7 +52060,7 @@ export namespace compute_alpha { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -50974,7 +52200,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Regionhealthchecks$Delete { + export interface Params$Resource$Regionhealthchecks$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -51006,7 +52233,8 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Regionhealthchecks$Get { + export interface Params$Resource$Regionhealthchecks$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -51025,7 +52253,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Regionhealthchecks$Insert { + export interface Params$Resource$Regionhealthchecks$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -51058,7 +52287,8 @@ export namespace compute_alpha { */ requestBody?: Schema$HealthCheck; } - export interface Params$Resource$Regionhealthchecks$List { + export interface Params$Resource$Regionhealthchecks$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -51116,7 +52346,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Regionhealthchecks$Patch { + export interface Params$Resource$Regionhealthchecks$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -51153,7 +52384,8 @@ export namespace compute_alpha { */ requestBody?: Schema$HealthCheck; } - export interface Params$Resource$Regionhealthchecks$Testiampermissions { + export interface Params$Resource$Regionhealthchecks$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -51168,7 +52400,7 @@ export namespace compute_alpha { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -51177,7 +52409,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Regionhealthchecks$Update { + export interface Params$Resource$Regionhealthchecks$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -51230,7 +52463,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.abandonInstances - * @desc Schedules a group action to remove the specified instances from the + * @desc Flags the specified instances to be immediately removed from the * managed instance group. Abandoning an instance does not delete the * instance, but it does remove the instance from any target pools that are * applied by the managed instance group. This method reduces the targetSize @@ -51468,17 +52701,18 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.deleteInstances - * @desc Schedules a group action to delete the specified instances in the - * managed instance group. The instances are also removed from any target - * pools of which they were a member. This method reduces the targetSize of - * the managed instance group by the number of instances that you delete. - * This operation is marked as DONE when the action is scheduled even if the - * instances are still being deleted. You must separately verify the status - * of the deleting action with the listmanagedinstances method. If the - * group is part of a backend service that has enabled connection draining, - * it can take up to 60 seconds after the connection draining duration has - * elapsed before the VM instance is removed or deleted. You can specify a - * maximum of 1000 instances with this method per request. + * @desc Flags the specified instances in the managed instance group to be + * immediately deleted. The instances are also removed from any target pools + * of which they were a member. This method reduces the targetSize of the + * managed instance group by the number of instances that you delete. The + * deleteInstances operation is marked DONE if the deleteInstances request + * is successful. The underlying actions take additional time. You must + * separately verify the status of the deleting action with the + * listmanagedinstances method. If the group is part of a backend service + * that has enabled connection draining, it can take up to 60 seconds after + * the connection draining duration has elapsed before the VM instance is + * removed or deleted. You can specify a maximum of 1000 instances with + * this method per request. * @alias compute.regionInstanceGroupManagers.deleteInstances * @memberOf! () * @@ -51702,13 +52936,12 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.insert * @desc Creates a managed instance group using the information that you - * specify in the request. After the group is created, it schedules an - * action to create instances in the group using the specified instance - * template. This operation is marked as DONE when the group is created even - * if the instances in the group have not yet been created. You must - * separately verify the status of the individual instances with the - * listmanagedinstances method. A regional managed instance group can - * contain up to 2000 instances. + * specify in the request. After the group is created, instances in the + * group are created using the specified instance template. This operation + * is marked as DONE when the group is created even if the instances in the + * group have not yet been created. You must separately verify the status of + * the individual instances with the listmanagedinstances method. A + * regional managed instance group can contain up to 2000 instances. * @alias compute.regionInstanceGroupManagers.insert * @memberOf! () * @@ -52129,16 +53362,16 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.recreateInstances - * @desc Schedules a group action to recreate the specified instances in the - * managed instance group. The instances are deleted and recreated using the + * @desc Flags the specified instances in the managed instance group to be + * immediately recreated. The instances are deleted and recreated using the * current instance template for the managed instance group. This operation - * is marked as DONE when the action is scheduled even if the instances have - * not yet been recreated. You must separately verify the status of the - * recreating action with the listmanagedinstances method. If the group is - * part of a backend service that has enabled connection draining, it can - * take up to 60 seconds after the connection draining duration has elapsed - * before the VM instance is removed or deleted. You can specify a maximum - * of 1000 instances with this method per request. + * is marked as DONE when the flag is set even if the instances have not yet + * been recreated. You must separately verify the status of the recreating + * action with the listmanagedinstances method. If the group is part of a + * backend service that has enabled connection draining, it can take up to + * 60 seconds after the connection draining duration has elapsed before the + * VM instance is removed or deleted. You can specify a maximum of 1000 + * instances with this method per request. * @alias compute.regionInstanceGroupManagers.recreateInstances * @memberOf! () * @@ -52213,17 +53446,16 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.resize - * @desc Changes the intended size for the managed instance group. If you - * increase the size, the group schedules actions to create new instances - * using the current instance template. If you decrease the size, the group - * schedules delete actions on one or more instances. The resize operation - * is marked DONE when the resize actions are scheduled even if the group - * has not yet added or deleted any instances. You must separately verify - * the status of the creating or deleting actions with the - * listmanagedinstances method. If the group is part of a backend service - * that has enabled connection draining, it can take up to 60 seconds after - * the connection draining duration has elapsed before the VM instance is - * removed or deleted. + * @desc Changes the intended size of the managed instance group. If you + * increase the size, the group creates new instances using the current + * instance template. If you decrease the size, the group deletes one or + * more instances. The resize operation is marked DONE if the resize + * request is successful. The underlying actions take additional time. You + * must separately verify the status of the creating or deleting actions + * with the listmanagedinstances method. If the group is part of a backend + * service that has enabled connection draining, it can take up to 60 + * seconds after the connection draining duration has elapsed before the VM + * instance is removed or deleted. * @alias compute.regionInstanceGroupManagers.resize * @memberOf! () * @@ -52536,7 +53768,7 @@ export namespace compute_alpha { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -52761,7 +53993,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Regioninstancegroupmanagers$Abandoninstances { + export interface Params$Resource$Regioninstancegroupmanagers$Abandoninstances + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -52798,7 +54031,8 @@ export namespace compute_alpha { */ requestBody?: Schema$RegionInstanceGroupManagersAbandonInstancesRequest; } - export interface Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances { + export interface Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -52822,7 +54056,8 @@ export namespace compute_alpha { */ requestBody?: Schema$RegionInstanceGroupManagersApplyUpdatesRequest; } - export interface Params$Resource$Regioninstancegroupmanagers$Delete { + export interface Params$Resource$Regioninstancegroupmanagers$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -52854,7 +54089,8 @@ export namespace compute_alpha { */ requestId?: string; } - export interface Params$Resource$Regioninstancegroupmanagers$Deleteinstances { + export interface Params$Resource$Regioninstancegroupmanagers$Deleteinstances + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -52891,7 +54127,8 @@ export namespace compute_alpha { */ requestBody?: Schema$RegionInstanceGroupManagersDeleteInstancesRequest; } - export interface Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs { + export interface Params$Resource$Regioninstancegroupmanagers$Deleteperinstanceconfigs + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -52915,7 +54152,8 @@ export namespace compute_alpha { */ requestBody?: Schema$RegionInstanceGroupManagerDeleteInstanceConfigReq; } - export interface Params$Resource$Regioninstancegroupmanagers$Get { + export interface Params$Resource$Regioninstancegroupmanagers$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -52934,7 +54172,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Regioninstancegroupmanagers$Insert { + export interface Params$Resource$Regioninstancegroupmanagers$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -52967,7 +54206,8 @@ export namespace compute_alpha { */ requestBody?: Schema$InstanceGroupManager; } - export interface Params$Resource$Regioninstancegroupmanagers$List { + export interface Params$Resource$Regioninstancegroupmanagers$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -53025,7 +54265,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances { + export interface Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -53087,7 +54328,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs { + export interface Params$Resource$Regioninstancegroupmanagers$Listperinstanceconfigs + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -53149,7 +54391,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Regioninstancegroupmanagers$Patch { + export interface Params$Resource$Regioninstancegroupmanagers$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -53186,7 +54429,8 @@ export namespace compute_alpha { */ requestBody?: Schema$InstanceGroupManager; } - export interface Params$Resource$Regioninstancegroupmanagers$Recreateinstances { + export interface Params$Resource$Regioninstancegroupmanagers$Recreateinstances + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -53223,7 +54467,8 @@ export namespace compute_alpha { */ requestBody?: Schema$RegionInstanceGroupManagersRecreateRequest; } - export interface Params$Resource$Regioninstancegroupmanagers$Resize { + export interface Params$Resource$Regioninstancegroupmanagers$Resize extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -53259,7 +54504,8 @@ export namespace compute_alpha { */ size?: number; } - export interface Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies { + export interface Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -53296,7 +54542,8 @@ export namespace compute_alpha { */ requestBody?: Schema$RegionInstanceGroupManagersSetAutoHealingRequest; } - export interface Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate { + export interface Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -53333,7 +54580,8 @@ export namespace compute_alpha { */ requestBody?: Schema$RegionInstanceGroupManagersSetTemplateRequest; } - export interface Params$Resource$Regioninstancegroupmanagers$Settargetpools { + export interface Params$Resource$Regioninstancegroupmanagers$Settargetpools + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -53370,7 +54618,8 @@ export namespace compute_alpha { */ requestBody?: Schema$RegionInstanceGroupManagersSetTargetPoolsRequest; } - export interface Params$Resource$Regioninstancegroupmanagers$Testiampermissions { + export interface Params$Resource$Regioninstancegroupmanagers$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -53385,7 +54634,7 @@ export namespace compute_alpha { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -53394,7 +54643,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Regioninstancegroupmanagers$Update { + export interface Params$Resource$Regioninstancegroupmanagers$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -53431,7 +54681,8 @@ export namespace compute_alpha { */ requestBody?: Schema$InstanceGroupManager; } - export interface Params$Resource$Regioninstancegroupmanagers$Updateperinstanceconfigs { + export interface Params$Resource$Regioninstancegroupmanagers$Updateperinstanceconfigs + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -53798,7 +55049,7 @@ export namespace compute_alpha { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -53864,7 +55115,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Regioninstancegroups$Get { + export interface Params$Resource$Regioninstancegroups$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -53883,7 +55135,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Regioninstancegroups$List { + export interface Params$Resource$Regioninstancegroups$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -53941,7 +55194,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Regioninstancegroups$Listinstances { + export interface Params$Resource$Regioninstancegroups$Listinstances extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -54009,7 +55263,8 @@ export namespace compute_alpha { */ requestBody?: Schema$RegionInstanceGroupsListInstancesRequest; } - export interface Params$Resource$Regioninstancegroups$Setnamedports { + export interface Params$Resource$Regioninstancegroups$Setnamedports extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -54047,7 +55302,8 @@ export namespace compute_alpha { */ requestBody?: Schema$RegionInstanceGroupsSetNamedPortsRequest; } - export interface Params$Resource$Regioninstancegroups$Testiampermissions { + export interface Params$Resource$Regioninstancegroups$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -54062,7 +55318,7 @@ export namespace compute_alpha { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -54376,7 +55632,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Regionoperations$Delete { + export interface Params$Resource$Regionoperations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -54395,7 +55652,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Regionoperations$Get { + export interface Params$Resource$Regionoperations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -54414,7 +55672,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Regionoperations$List { + export interface Params$Resource$Regionoperations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -54472,7 +55731,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Regionoperations$Wait { + export interface Params$Resource$Regionoperations$Wait extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -54639,7 +55899,7 @@ export namespace compute_alpha { } } - export interface Params$Resource$Regions$Get { + export interface Params$Resource$Regions$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -54654,7 +55914,7 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Regions$List { + export interface Params$Resource$Regions$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -55021,7 +56281,7 @@ export namespace compute_alpha { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -55087,7 +56347,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Regionsslcertificates$Delete { + export interface Params$Resource$Regionsslcertificates$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -55119,7 +56380,8 @@ export namespace compute_alpha { */ sslCertificate?: string; } - export interface Params$Resource$Regionsslcertificates$Get { + export interface Params$Resource$Regionsslcertificates$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -55138,7 +56400,8 @@ export namespace compute_alpha { */ sslCertificate?: string; } - export interface Params$Resource$Regionsslcertificates$Insert { + export interface Params$Resource$Regionsslcertificates$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -55171,7 +56434,8 @@ export namespace compute_alpha { */ requestBody?: Schema$SslCertificate; } - export interface Params$Resource$Regionsslcertificates$List { + export interface Params$Resource$Regionsslcertificates$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -55229,7 +56493,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Regionsslcertificates$Testiampermissions { + export interface Params$Resource$Regionsslcertificates$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -55244,7 +56509,7 @@ export namespace compute_alpha { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -55638,7 +56903,7 @@ export namespace compute_alpha { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -55705,7 +56970,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Regiontargethttpproxies$Delete { + export interface Params$Resource$Regiontargethttpproxies$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -55737,7 +57003,8 @@ export namespace compute_alpha { */ targetHttpProxy?: string; } - export interface Params$Resource$Regiontargethttpproxies$Get { + export interface Params$Resource$Regiontargethttpproxies$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -55756,7 +57023,8 @@ export namespace compute_alpha { */ targetHttpProxy?: string; } - export interface Params$Resource$Regiontargethttpproxies$Insert { + export interface Params$Resource$Regiontargethttpproxies$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -55789,7 +57057,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TargetHttpProxy; } - export interface Params$Resource$Regiontargethttpproxies$List { + export interface Params$Resource$Regiontargethttpproxies$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -55847,7 +57116,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Regiontargethttpproxies$Seturlmap { + export interface Params$Resource$Regiontargethttpproxies$Seturlmap extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -55884,7 +57154,8 @@ export namespace compute_alpha { */ requestBody?: Schema$UrlMapReference; } - export interface Params$Resource$Regiontargethttpproxies$Testiampermissions { + export interface Params$Resource$Regiontargethttpproxies$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -55899,7 +57170,7 @@ export namespace compute_alpha { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -56369,7 +57640,7 @@ export namespace compute_alpha { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -56436,7 +57707,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Regiontargethttpsproxies$Delete { + export interface Params$Resource$Regiontargethttpsproxies$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -56468,7 +57740,8 @@ export namespace compute_alpha { */ targetHttpsProxy?: string; } - export interface Params$Resource$Regiontargethttpsproxies$Get { + export interface Params$Resource$Regiontargethttpsproxies$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -56487,7 +57760,8 @@ export namespace compute_alpha { */ targetHttpsProxy?: string; } - export interface Params$Resource$Regiontargethttpsproxies$Insert { + export interface Params$Resource$Regiontargethttpsproxies$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -56520,7 +57794,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TargetHttpsProxy; } - export interface Params$Resource$Regiontargethttpsproxies$List { + export interface Params$Resource$Regiontargethttpsproxies$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -56578,7 +57853,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Regiontargethttpsproxies$Setsslcertificates { + export interface Params$Resource$Regiontargethttpsproxies$Setsslcertificates + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -56616,7 +57892,8 @@ export namespace compute_alpha { */ requestBody?: Schema$RegionTargetHttpsProxiesSetSslCertificatesRequest; } - export interface Params$Resource$Regiontargethttpsproxies$Seturlmap { + export interface Params$Resource$Regiontargethttpsproxies$Seturlmap extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -56653,7 +57930,8 @@ export namespace compute_alpha { */ requestBody?: Schema$UrlMapReference; } - export interface Params$Resource$Regiontargethttpsproxies$Testiampermissions { + export interface Params$Resource$Regiontargethttpsproxies$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -56668,7 +57946,7 @@ export namespace compute_alpha { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -57135,7 +58413,7 @@ export namespace compute_alpha { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -57350,7 +58628,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Regionurlmaps$Delete { + export interface Params$Resource$Regionurlmaps$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -57374,7 +58653,8 @@ export namespace compute_alpha { */ urlMap?: string; } - export interface Params$Resource$Regionurlmaps$Get { + export interface Params$Resource$Regionurlmaps$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -57393,7 +58673,8 @@ export namespace compute_alpha { */ urlMap?: string; } - export interface Params$Resource$Regionurlmaps$Insert { + export interface Params$Resource$Regionurlmaps$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -57418,7 +58699,8 @@ export namespace compute_alpha { */ requestBody?: Schema$UrlMap; } - export interface Params$Resource$Regionurlmaps$Invalidatecache { + export interface Params$Resource$Regionurlmaps$Invalidatecache extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -57447,7 +58729,8 @@ export namespace compute_alpha { */ requestBody?: Schema$CacheInvalidationRule; } - export interface Params$Resource$Regionurlmaps$List { + export interface Params$Resource$Regionurlmaps$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -57505,7 +58788,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Regionurlmaps$Patch { + export interface Params$Resource$Regionurlmaps$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -57534,7 +58818,8 @@ export namespace compute_alpha { */ requestBody?: Schema$UrlMap; } - export interface Params$Resource$Regionurlmaps$Testiampermissions { + export interface Params$Resource$Regionurlmaps$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -57549,7 +58834,7 @@ export namespace compute_alpha { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -57558,7 +58843,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Regionurlmaps$Update { + export interface Params$Resource$Regionurlmaps$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -57587,7 +58873,8 @@ export namespace compute_alpha { */ requestBody?: Schema$UrlMap; } - export interface Params$Resource$Regionurlmaps$Validate { + export interface Params$Resource$Regionurlmaps$Validate extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -57855,7 +59142,7 @@ export namespace compute_alpha { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for 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 @@ -58073,7 +59360,7 @@ export namespace compute_alpha { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().RegionSetPolicyRequest} 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. @@ -58144,7 +59431,7 @@ export namespace compute_alpha { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -58209,7 +59496,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Resourcepolicies$Aggregatedlist { + export interface Params$Resource$Resourcepolicies$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -58263,7 +59551,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Resourcepolicies$Delete { + export interface Params$Resource$Resourcepolicies$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -58295,7 +59584,8 @@ export namespace compute_alpha { */ resourcePolicy?: string; } - export interface Params$Resource$Resourcepolicies$Get { + export interface Params$Resource$Resourcepolicies$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -58314,7 +59604,8 @@ export namespace compute_alpha { */ resourcePolicy?: string; } - export interface Params$Resource$Resourcepolicies$Getiampolicy { + export interface Params$Resource$Resourcepolicies$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -58329,11 +59620,12 @@ export namespace compute_alpha { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; } - export interface Params$Resource$Resourcepolicies$Insert { + export interface Params$Resource$Resourcepolicies$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -58366,7 +59658,8 @@ export namespace compute_alpha { */ requestBody?: Schema$ResourcePolicy; } - export interface Params$Resource$Resourcepolicies$List { + export interface Params$Resource$Resourcepolicies$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -58424,7 +59717,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Resourcepolicies$Setiampolicy { + export interface Params$Resource$Resourcepolicies$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -58439,7 +59733,7 @@ export namespace compute_alpha { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -58448,7 +59742,8 @@ export namespace compute_alpha { */ requestBody?: Schema$RegionSetPolicyRequest; } - export interface Params$Resource$Resourcepolicies$Testiampermissions { + export interface Params$Resource$Resourcepolicies$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -58463,7 +59758,7 @@ export namespace compute_alpha { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -59147,7 +60442,7 @@ export namespace compute_alpha { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -59284,7 +60579,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Routers$Aggregatedlist { + export interface Params$Resource$Routers$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -59338,7 +60634,7 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Routers$Delete { + export interface Params$Resource$Routers$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -59370,7 +60666,7 @@ export namespace compute_alpha { */ router?: string; } - export interface Params$Resource$Routers$Get { + export interface Params$Resource$Routers$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -59389,7 +60685,8 @@ export namespace compute_alpha { */ router?: string; } - export interface Params$Resource$Routers$Getnatmappinginfo { + export interface Params$Resource$Routers$Getnatmappinginfo extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -59452,7 +60749,8 @@ export namespace compute_alpha { */ router?: string; } - export interface Params$Resource$Routers$Getrouterstatus { + export interface Params$Resource$Routers$Getrouterstatus extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -59471,7 +60769,7 @@ export namespace compute_alpha { */ router?: string; } - export interface Params$Resource$Routers$Insert { + export interface Params$Resource$Routers$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -59504,7 +60802,7 @@ export namespace compute_alpha { */ requestBody?: Schema$Router; } - export interface Params$Resource$Routers$List { + export interface Params$Resource$Routers$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -59562,7 +60860,7 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Routers$Patch { + export interface Params$Resource$Routers$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -59599,7 +60897,7 @@ export namespace compute_alpha { */ requestBody?: Schema$Router; } - export interface Params$Resource$Routers$Preview { + export interface Params$Resource$Routers$Preview extends StandardParameters { /** * Auth client or API Key for the request */ @@ -59623,7 +60921,8 @@ export namespace compute_alpha { */ requestBody?: Schema$Router; } - export interface Params$Resource$Routers$Testiampermissions { + export interface Params$Resource$Routers$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -59638,7 +60937,7 @@ export namespace compute_alpha { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -59647,7 +60946,7 @@ export namespace compute_alpha { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Routers$Update { + export interface Params$Resource$Routers$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -59976,7 +61275,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -60041,7 +61340,7 @@ export namespace compute_alpha { } } - export interface Params$Resource$Routes$Delete { + export interface Params$Resource$Routes$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -60069,7 +61368,7 @@ export namespace compute_alpha { */ route?: string; } - export interface Params$Resource$Routes$Get { + export interface Params$Resource$Routes$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -60084,7 +61383,7 @@ export namespace compute_alpha { */ route?: string; } - export interface Params$Resource$Routes$Insert { + export interface Params$Resource$Routes$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -60113,7 +61412,7 @@ export namespace compute_alpha { */ requestBody?: Schema$Route; } - export interface Params$Resource$Routes$List { + export interface Params$Resource$Routes$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -60167,7 +61466,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Routes$Testiampermissions { + export interface Params$Resource$Routes$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -60178,7 +61478,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -61018,7 +62318,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -61083,7 +62383,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Securitypolicies$Addrule { + export interface Params$Resource$Securitypolicies$Addrule extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -61107,7 +62408,8 @@ export namespace compute_alpha { */ requestBody?: Schema$SecurityPolicyRule; } - export interface Params$Resource$Securitypolicies$Delete { + export interface Params$Resource$Securitypolicies$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -61135,7 +62437,8 @@ export namespace compute_alpha { */ securityPolicy?: string; } - export interface Params$Resource$Securitypolicies$Get { + export interface Params$Resource$Securitypolicies$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -61150,7 +62453,8 @@ export namespace compute_alpha { */ securityPolicy?: string; } - export interface Params$Resource$Securitypolicies$Getrule { + export interface Params$Resource$Securitypolicies$Getrule extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -61169,7 +62473,8 @@ export namespace compute_alpha { */ securityPolicy?: string; } - export interface Params$Resource$Securitypolicies$Insert { + export interface Params$Resource$Securitypolicies$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -61202,7 +62507,8 @@ export namespace compute_alpha { */ requestBody?: Schema$SecurityPolicy; } - export interface Params$Resource$Securitypolicies$List { + export interface Params$Resource$Securitypolicies$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -61256,7 +62562,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Securitypolicies$Listpreconfiguredexpressionsets { + export interface Params$Resource$Securitypolicies$Listpreconfiguredexpressionsets + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -61310,7 +62617,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Securitypolicies$Patch { + export interface Params$Resource$Securitypolicies$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -61343,7 +62651,8 @@ export namespace compute_alpha { */ requestBody?: Schema$SecurityPolicy; } - export interface Params$Resource$Securitypolicies$Patchrule { + export interface Params$Resource$Securitypolicies$Patchrule extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -61371,7 +62680,8 @@ export namespace compute_alpha { */ requestBody?: Schema$SecurityPolicyRule; } - export interface Params$Resource$Securitypolicies$Removerule { + export interface Params$Resource$Securitypolicies$Removerule extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -61390,7 +62700,8 @@ export namespace compute_alpha { */ securityPolicy?: string; } - export interface Params$Resource$Securitypolicies$Setlabels { + export interface Params$Resource$Securitypolicies$Setlabels extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -61410,7 +62721,8 @@ export namespace compute_alpha { */ requestBody?: Schema$GlobalSetLabelsRequest; } - export interface Params$Resource$Securitypolicies$Testiampermissions { + export interface Params$Resource$Securitypolicies$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -61421,7 +62733,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -61591,7 +62903,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for 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 @@ -61732,7 +63044,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().GlobalSetPolicyRequest} 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. @@ -61874,7 +63186,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -61939,7 +63251,7 @@ export namespace compute_alpha { } } - export interface Params$Resource$Snapshots$Delete { + export interface Params$Resource$Snapshots$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -61967,7 +63279,7 @@ export namespace compute_alpha { */ snapshot?: string; } - export interface Params$Resource$Snapshots$Get { + export interface Params$Resource$Snapshots$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -61982,7 +63294,8 @@ export namespace compute_alpha { */ snapshot?: string; } - export interface Params$Resource$Snapshots$Getiampolicy { + export interface Params$Resource$Snapshots$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -61993,11 +63306,11 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; } - export interface Params$Resource$Snapshots$List { + export interface Params$Resource$Snapshots$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -62051,7 +63364,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Snapshots$Setiampolicy { + export interface Params$Resource$Snapshots$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -62062,7 +63376,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -62071,7 +63385,8 @@ export namespace compute_alpha { */ requestBody?: Schema$GlobalSetPolicyRequest; } - export interface Params$Resource$Snapshots$Setlabels { + export interface Params$Resource$Snapshots$Setlabels extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -62091,7 +63406,8 @@ export namespace compute_alpha { */ requestBody?: Schema$GlobalSetLabelsRequest; } - export interface Params$Resource$Snapshots$Testiampermissions { + export interface Params$Resource$Snapshots$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -62102,7 +63418,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -62497,7 +63813,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -62562,7 +63878,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Sslcertificates$Aggregatedlist { + export interface Params$Resource$Sslcertificates$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -62616,7 +63933,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Sslcertificates$Delete { + export interface Params$Resource$Sslcertificates$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -62644,7 +63962,8 @@ export namespace compute_alpha { */ sslCertificate?: string; } - export interface Params$Resource$Sslcertificates$Get { + export interface Params$Resource$Sslcertificates$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -62659,7 +63978,8 @@ export namespace compute_alpha { */ sslCertificate?: string; } - export interface Params$Resource$Sslcertificates$Insert { + export interface Params$Resource$Sslcertificates$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -62688,7 +64008,8 @@ export namespace compute_alpha { */ requestBody?: Schema$SslCertificate; } - export interface Params$Resource$Sslcertificates$List { + export interface Params$Resource$Sslcertificates$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -62742,7 +64063,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Sslcertificates$Testiampermissions { + export interface Params$Resource$Sslcertificates$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -62753,7 +64075,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -63220,7 +64542,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -63285,7 +64607,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Sslpolicies$Delete { + export interface Params$Resource$Sslpolicies$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -63314,7 +64637,7 @@ export namespace compute_alpha { */ sslPolicy?: string; } - export interface Params$Resource$Sslpolicies$Get { + export interface Params$Resource$Sslpolicies$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -63330,7 +64653,8 @@ export namespace compute_alpha { */ sslPolicy?: string; } - export interface Params$Resource$Sslpolicies$Insert { + export interface Params$Resource$Sslpolicies$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -63359,7 +64683,7 @@ export namespace compute_alpha { */ requestBody?: Schema$SslPolicy; } - export interface Params$Resource$Sslpolicies$List { + export interface Params$Resource$Sslpolicies$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -63413,7 +64737,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Sslpolicies$Listavailablefeatures { + export interface Params$Resource$Sslpolicies$Listavailablefeatures extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -63467,7 +64792,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Sslpolicies$Patch { + export interface Params$Resource$Sslpolicies$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -63501,7 +64827,8 @@ export namespace compute_alpha { */ requestBody?: Schema$SslPolicy; } - export interface Params$Resource$Sslpolicies$Testiampermissions { + export interface Params$Resource$Sslpolicies$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -63512,7 +64839,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -63831,7 +65158,7 @@ export namespace compute_alpha { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for 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 @@ -64206,7 +65533,7 @@ export namespace compute_alpha { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().RegionSetPolicyRequest} 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. @@ -64352,7 +65679,7 @@ export namespace compute_alpha { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -64417,7 +65744,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Subnetworks$Aggregatedlist { + export interface Params$Resource$Subnetworks$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -64471,7 +65799,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Subnetworks$Delete { + export interface Params$Resource$Subnetworks$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -64503,7 +65832,8 @@ export namespace compute_alpha { */ subnetwork?: string; } - export interface Params$Resource$Subnetworks$Expandipcidrrange { + export interface Params$Resource$Subnetworks$Expandipcidrrange extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -64540,7 +65870,7 @@ export namespace compute_alpha { */ requestBody?: Schema$SubnetworksExpandIpCidrRangeRequest; } - export interface Params$Resource$Subnetworks$Get { + export interface Params$Resource$Subnetworks$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -64559,7 +65889,8 @@ export namespace compute_alpha { */ subnetwork?: string; } - export interface Params$Resource$Subnetworks$Getiampolicy { + export interface Params$Resource$Subnetworks$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -64574,11 +65905,12 @@ export namespace compute_alpha { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; } - export interface Params$Resource$Subnetworks$Insert { + export interface Params$Resource$Subnetworks$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -64611,7 +65943,7 @@ export namespace compute_alpha { */ requestBody?: Schema$Subnetwork; } - export interface Params$Resource$Subnetworks$List { + export interface Params$Resource$Subnetworks$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -64669,7 +66001,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Subnetworks$Listusable { + export interface Params$Resource$Subnetworks$Listusable extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -64723,7 +66056,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Subnetworks$Patch { + export interface Params$Resource$Subnetworks$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -64771,7 +66105,8 @@ export namespace compute_alpha { */ requestBody?: Schema$Subnetwork; } - export interface Params$Resource$Subnetworks$Setiampolicy { + export interface Params$Resource$Subnetworks$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -64786,7 +66121,7 @@ export namespace compute_alpha { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -64795,7 +66130,8 @@ export namespace compute_alpha { */ requestBody?: Schema$RegionSetPolicyRequest; } - export interface Params$Resource$Subnetworks$Setprivateipgoogleaccess { + export interface Params$Resource$Subnetworks$Setprivateipgoogleaccess extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -64832,7 +66168,8 @@ export namespace compute_alpha { */ requestBody?: Schema$SubnetworksSetPrivateIpGoogleAccessRequest; } - export interface Params$Resource$Subnetworks$Testiampermissions { + export interface Params$Resource$Subnetworks$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -64847,7 +66184,7 @@ export namespace compute_alpha { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -65316,7 +66653,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -65381,7 +66718,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Targethttpproxies$Aggregatedlist { + export interface Params$Resource$Targethttpproxies$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -65435,7 +66773,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Targethttpproxies$Delete { + export interface Params$Resource$Targethttpproxies$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -65463,7 +66802,8 @@ export namespace compute_alpha { */ targetHttpProxy?: string; } - export interface Params$Resource$Targethttpproxies$Get { + export interface Params$Resource$Targethttpproxies$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -65478,7 +66818,8 @@ export namespace compute_alpha { */ targetHttpProxy?: string; } - export interface Params$Resource$Targethttpproxies$Insert { + export interface Params$Resource$Targethttpproxies$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -65507,7 +66848,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TargetHttpProxy; } - export interface Params$Resource$Targethttpproxies$List { + export interface Params$Resource$Targethttpproxies$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -65561,7 +66903,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Targethttpproxies$Seturlmap { + export interface Params$Resource$Targethttpproxies$Seturlmap extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -65594,7 +66937,8 @@ export namespace compute_alpha { */ requestBody?: Schema$UrlMapReference; } - export interface Params$Resource$Targethttpproxies$Testiampermissions { + export interface Params$Resource$Targethttpproxies$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -65605,7 +66949,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -66295,7 +67639,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -66361,7 +67705,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Targethttpsproxies$Aggregatedlist { + export interface Params$Resource$Targethttpsproxies$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -66415,7 +67760,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Targethttpsproxies$Delete { + export interface Params$Resource$Targethttpsproxies$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -66443,7 +67789,8 @@ export namespace compute_alpha { */ targetHttpsProxy?: string; } - export interface Params$Resource$Targethttpsproxies$Get { + export interface Params$Resource$Targethttpsproxies$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -66458,7 +67805,8 @@ export namespace compute_alpha { */ targetHttpsProxy?: string; } - export interface Params$Resource$Targethttpsproxies$Insert { + export interface Params$Resource$Targethttpsproxies$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -66487,7 +67835,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TargetHttpsProxy; } - export interface Params$Resource$Targethttpsproxies$List { + export interface Params$Resource$Targethttpsproxies$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -66541,7 +67890,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Targethttpsproxies$Setquicoverride { + export interface Params$Resource$Targethttpsproxies$Setquicoverride extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -66575,7 +67925,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TargetHttpsProxiesSetQuicOverrideRequest; } - export interface Params$Resource$Targethttpsproxies$Setsslcertificates { + export interface Params$Resource$Targethttpsproxies$Setsslcertificates extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -66609,7 +67960,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TargetHttpsProxiesSetSslCertificatesRequest; } - export interface Params$Resource$Targethttpsproxies$Setsslpolicy { + export interface Params$Resource$Targethttpsproxies$Setsslpolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -66643,7 +67995,8 @@ export namespace compute_alpha { */ requestBody?: Schema$SslPolicyReference; } - export interface Params$Resource$Targethttpsproxies$Seturlmap { + export interface Params$Resource$Targethttpsproxies$Seturlmap extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -66676,7 +68029,8 @@ export namespace compute_alpha { */ requestBody?: Schema$UrlMapReference; } - export interface Params$Resource$Targethttpsproxies$Testiampermissions { + export interface Params$Resource$Targethttpsproxies$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -66687,7 +68041,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -67087,7 +68441,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {string} params.zone The name of the zone for this request. * @param {().TestPermissionsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -67153,7 +68507,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Targetinstances$Aggregatedlist { + export interface Params$Resource$Targetinstances$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -67207,7 +68562,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Targetinstances$Delete { + export interface Params$Resource$Targetinstances$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -67239,7 +68595,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Targetinstances$Get { + export interface Params$Resource$Targetinstances$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -67258,7 +68615,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Targetinstances$Insert { + export interface Params$Resource$Targetinstances$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -67291,7 +68649,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TargetInstance; } - export interface Params$Resource$Targetinstances$List { + export interface Params$Resource$Targetinstances$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -67349,7 +68708,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Targetinstances$Testiampermissions { + export interface Params$Resource$Targetinstances$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -67360,7 +68720,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; /** @@ -68196,7 +69556,7 @@ export namespace compute_alpha { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -68261,7 +69621,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Targetpools$Addhealthcheck { + export interface Params$Resource$Targetpools$Addhealthcheck extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -68298,7 +69659,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TargetPoolsAddHealthCheckRequest; } - export interface Params$Resource$Targetpools$Addinstance { + export interface Params$Resource$Targetpools$Addinstance extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -68335,7 +69697,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TargetPoolsAddInstanceRequest; } - export interface Params$Resource$Targetpools$Aggregatedlist { + export interface Params$Resource$Targetpools$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -68389,7 +69752,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Targetpools$Delete { + export interface Params$Resource$Targetpools$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -68421,7 +69785,7 @@ export namespace compute_alpha { */ targetPool?: string; } - export interface Params$Resource$Targetpools$Get { + export interface Params$Resource$Targetpools$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -68440,7 +69804,8 @@ export namespace compute_alpha { */ targetPool?: string; } - export interface Params$Resource$Targetpools$Gethealth { + export interface Params$Resource$Targetpools$Gethealth extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -68464,7 +69829,8 @@ export namespace compute_alpha { */ requestBody?: Schema$InstanceReference; } - export interface Params$Resource$Targetpools$Insert { + export interface Params$Resource$Targetpools$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -68497,7 +69863,7 @@ export namespace compute_alpha { */ requestBody?: Schema$TargetPool; } - export interface Params$Resource$Targetpools$List { + export interface Params$Resource$Targetpools$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -68555,7 +69921,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Targetpools$Removehealthcheck { + export interface Params$Resource$Targetpools$Removehealthcheck extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -68592,7 +69959,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TargetPoolsRemoveHealthCheckRequest; } - export interface Params$Resource$Targetpools$Removeinstance { + export interface Params$Resource$Targetpools$Removeinstance extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -68629,7 +69997,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TargetPoolsRemoveInstanceRequest; } - export interface Params$Resource$Targetpools$Setbackup { + export interface Params$Resource$Targetpools$Setbackup extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -68670,7 +70039,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TargetReference; } - export interface Params$Resource$Targetpools$Testiampermissions { + export interface Params$Resource$Targetpools$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -68685,7 +70055,7 @@ export namespace compute_alpha { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -69289,7 +70659,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -69354,7 +70724,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Targetsslproxies$Delete { + export interface Params$Resource$Targetsslproxies$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -69382,7 +70753,8 @@ export namespace compute_alpha { */ targetSslProxy?: string; } - export interface Params$Resource$Targetsslproxies$Get { + export interface Params$Resource$Targetsslproxies$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -69397,7 +70769,8 @@ export namespace compute_alpha { */ targetSslProxy?: string; } - export interface Params$Resource$Targetsslproxies$Insert { + export interface Params$Resource$Targetsslproxies$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -69426,7 +70799,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TargetSslProxy; } - export interface Params$Resource$Targetsslproxies$List { + export interface Params$Resource$Targetsslproxies$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -69480,7 +70854,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Targetsslproxies$Setbackendservice { + export interface Params$Resource$Targetsslproxies$Setbackendservice extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -69514,7 +70889,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TargetSslProxiesSetBackendServiceRequest; } - export interface Params$Resource$Targetsslproxies$Setproxyheader { + export interface Params$Resource$Targetsslproxies$Setproxyheader extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -69547,7 +70923,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TargetSslProxiesSetProxyHeaderRequest; } - export interface Params$Resource$Targetsslproxies$Setsslcertificates { + export interface Params$Resource$Targetsslproxies$Setsslcertificates extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -69581,7 +70958,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TargetSslProxiesSetSslCertificatesRequest; } - export interface Params$Resource$Targetsslproxies$Setsslpolicy { + export interface Params$Resource$Targetsslproxies$Setsslpolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -69615,7 +70993,8 @@ export namespace compute_alpha { */ requestBody?: Schema$SslPolicyReference; } - export interface Params$Resource$Targetsslproxies$Testiampermissions { + export interface Params$Resource$Targetsslproxies$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -69626,7 +71005,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -70083,7 +71462,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -70148,7 +71527,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Targettcpproxies$Delete { + export interface Params$Resource$Targettcpproxies$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -70176,7 +71556,8 @@ export namespace compute_alpha { */ targetTcpProxy?: string; } - export interface Params$Resource$Targettcpproxies$Get { + export interface Params$Resource$Targettcpproxies$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -70191,7 +71572,8 @@ export namespace compute_alpha { */ targetTcpProxy?: string; } - export interface Params$Resource$Targettcpproxies$Insert { + export interface Params$Resource$Targettcpproxies$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -70220,7 +71602,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TargetTcpProxy; } - export interface Params$Resource$Targettcpproxies$List { + export interface Params$Resource$Targettcpproxies$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -70274,7 +71657,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Targettcpproxies$Setbackendservice { + export interface Params$Resource$Targettcpproxies$Setbackendservice extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -70308,7 +71692,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TargetTcpProxiesSetBackendServiceRequest; } - export interface Params$Resource$Targettcpproxies$Setproxyheader { + export interface Params$Resource$Targettcpproxies$Setproxyheader extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -70341,7 +71726,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TargetTcpProxiesSetProxyHeaderRequest; } - export interface Params$Resource$Targettcpproxies$Testiampermissions { + export interface Params$Resource$Targettcpproxies$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -70352,7 +71738,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -70828,7 +72214,7 @@ export namespace compute_alpha { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -70893,7 +72279,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Targetvpngateways$Aggregatedlist { + export interface Params$Resource$Targetvpngateways$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -70947,7 +72334,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Targetvpngateways$Delete { + export interface Params$Resource$Targetvpngateways$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -70979,7 +72367,8 @@ export namespace compute_alpha { */ targetVpnGateway?: string; } - export interface Params$Resource$Targetvpngateways$Get { + export interface Params$Resource$Targetvpngateways$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -70998,7 +72387,8 @@ export namespace compute_alpha { */ targetVpnGateway?: string; } - export interface Params$Resource$Targetvpngateways$Insert { + export interface Params$Resource$Targetvpngateways$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -71031,7 +72421,8 @@ export namespace compute_alpha { */ requestBody?: Schema$TargetVpnGateway; } - export interface Params$Resource$Targetvpngateways$List { + export interface Params$Resource$Targetvpngateways$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -71089,7 +72480,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Targetvpngateways$Setlabels { + export interface Params$Resource$Targetvpngateways$Setlabels extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -71126,7 +72518,8 @@ export namespace compute_alpha { */ requestBody?: Schema$RegionSetLabelsRequest; } - export interface Params$Resource$Targetvpngateways$Testiampermissions { + export interface Params$Resource$Targetvpngateways$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -71141,7 +72534,7 @@ export namespace compute_alpha { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -71663,7 +73056,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -71872,7 +73265,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Urlmaps$Aggregatedlist { + export interface Params$Resource$Urlmaps$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -71926,7 +73320,7 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Urlmaps$Delete { + export interface Params$Resource$Urlmaps$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -71954,7 +73348,7 @@ export namespace compute_alpha { */ urlMap?: string; } - export interface Params$Resource$Urlmaps$Get { + export interface Params$Resource$Urlmaps$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -71969,7 +73363,7 @@ export namespace compute_alpha { */ urlMap?: string; } - export interface Params$Resource$Urlmaps$Insert { + export interface Params$Resource$Urlmaps$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -71998,7 +73392,8 @@ export namespace compute_alpha { */ requestBody?: Schema$UrlMap; } - export interface Params$Resource$Urlmaps$Invalidatecache { + export interface Params$Resource$Urlmaps$Invalidatecache extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -72031,7 +73426,7 @@ export namespace compute_alpha { */ requestBody?: Schema$CacheInvalidationRule; } - export interface Params$Resource$Urlmaps$List { + export interface Params$Resource$Urlmaps$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -72085,7 +73480,7 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Urlmaps$Patch { + export interface Params$Resource$Urlmaps$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -72118,7 +73513,8 @@ export namespace compute_alpha { */ requestBody?: Schema$UrlMap; } - export interface Params$Resource$Urlmaps$Testiampermissions { + export interface Params$Resource$Urlmaps$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -72129,7 +73525,7 @@ export namespace compute_alpha { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -72138,7 +73534,7 @@ export namespace compute_alpha { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Urlmaps$Update { + export interface Params$Resource$Urlmaps$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -72171,7 +73567,7 @@ export namespace compute_alpha { */ requestBody?: Schema$UrlMap; } - export interface Params$Resource$Urlmaps$Validate { + export interface Params$Resource$Urlmaps$Validate extends StandardParameters { /** * Auth client or API Key for the request */ @@ -72647,7 +74043,7 @@ export namespace compute_alpha { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -72712,7 +74108,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Vpngateways$Aggregatedlist { + export interface Params$Resource$Vpngateways$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -72766,7 +74163,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Vpngateways$Delete { + export interface Params$Resource$Vpngateways$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -72798,7 +74196,7 @@ export namespace compute_alpha { */ vpnGateway?: string; } - export interface Params$Resource$Vpngateways$Get { + export interface Params$Resource$Vpngateways$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -72817,7 +74215,8 @@ export namespace compute_alpha { */ vpnGateway?: string; } - export interface Params$Resource$Vpngateways$Insert { + export interface Params$Resource$Vpngateways$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -72850,7 +74249,7 @@ export namespace compute_alpha { */ requestBody?: Schema$VpnGateway; } - export interface Params$Resource$Vpngateways$List { + export interface Params$Resource$Vpngateways$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -72908,7 +74307,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Vpngateways$Setlabels { + export interface Params$Resource$Vpngateways$Setlabels extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -72945,7 +74345,8 @@ export namespace compute_alpha { */ requestBody?: Schema$RegionSetLabelsRequest; } - export interface Params$Resource$Vpngateways$Testiampermissions { + export interface Params$Resource$Vpngateways$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -72960,7 +74361,7 @@ export namespace compute_alpha { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -73423,7 +74824,7 @@ export namespace compute_alpha { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -73488,7 +74889,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Vpntunnels$Aggregatedlist { + export interface Params$Resource$Vpntunnels$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -73542,7 +74944,8 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Vpntunnels$Delete { + export interface Params$Resource$Vpntunnels$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -73574,7 +74977,7 @@ export namespace compute_alpha { */ vpnTunnel?: string; } - export interface Params$Resource$Vpntunnels$Get { + export interface Params$Resource$Vpntunnels$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -73593,7 +74996,8 @@ export namespace compute_alpha { */ vpnTunnel?: string; } - export interface Params$Resource$Vpntunnels$Insert { + export interface Params$Resource$Vpntunnels$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -73626,7 +75030,7 @@ export namespace compute_alpha { */ requestBody?: Schema$VpnTunnel; } - export interface Params$Resource$Vpntunnels$List { + export interface Params$Resource$Vpntunnels$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -73684,7 +75088,8 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Vpntunnels$Setlabels { + export interface Params$Resource$Vpntunnels$Setlabels extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -73721,7 +75126,8 @@ export namespace compute_alpha { */ requestBody?: Schema$RegionSetLabelsRequest; } - export interface Params$Resource$Vpntunnels$Testiampermissions { + export interface Params$Resource$Vpntunnels$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -73736,7 +75142,7 @@ export namespace compute_alpha { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -74046,7 +75452,8 @@ export namespace compute_alpha { } } - export interface Params$Resource$Zoneoperations$Delete { + export interface Params$Resource$Zoneoperations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -74065,7 +75472,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Zoneoperations$Get { + export interface Params$Resource$Zoneoperations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -74084,7 +75492,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Zoneoperations$List { + export interface Params$Resource$Zoneoperations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -74142,7 +75551,8 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Zoneoperations$Wait { + export interface Params$Resource$Zoneoperations$Wait extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -74307,7 +75717,7 @@ export namespace compute_alpha { } } - export interface Params$Resource$Zones$Get { + export interface Params$Resource$Zones$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -74322,7 +75732,7 @@ export namespace compute_alpha { */ zone?: string; } - export interface Params$Resource$Zones$List { + export interface Params$Resource$Zones$List extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/compute/beta.ts b/src/apis/compute/beta.ts index 6220bf7809..8946c89178 100644 --- a/src/apis/compute/beta.ts +++ b/src/apis/compute/beta.ts @@ -29,6 +29,40 @@ export namespace compute_beta { version: 'beta'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Compute Engine API * @@ -1135,14 +1169,21 @@ export namespace compute_beta { */ description?: string; /** - * The fully-qualified URL of a Instance Group resource. This instance group - * defines the list of instances that serve traffic. Member virtual machine - * instances from each instance group must live in the same zone as the - * instance group itself. No two backends in a backend service are allowed - * to use same Instance Group resource. Note that you must specify an - * Instance Group resource using the fully-qualified URL, rather than a + * The fully-qualified URL of an Instance Group or Network Endpoint Group + * resource. In case of instance group this defines the list of instances + * that serve traffic. Member virtual machine instances from each instance + * group must live in the same zone as the instance group itself. No two + * backends in a backend service are allowed to use same Instance Group + * resource. For Network Endpoint Groups this defines list of endpoints. + * All endpoints of Network Endpoint Group must be hosted on instances + * located in the same zone as the Network Endpoint Group. Backend service + * can not contain mix of Instance Group and Network Endpoint Group + * backends. Note that you must specify an Instance Group or Network + * Endpoint Group resource using the fully-qualified URL, rather than a * partial URL. When the BackendService has load balancing scheme INTERNAL, * the instance group must be within the same region as the BackendService. + * Network Endpoint Groups are not supported for INTERNAL load balancing + * scheme. */ group?: string; /** @@ -1491,6 +1532,10 @@ export namespace compute_beta { signedUrlKeyNames?: string[]; } export interface Schema$BackendServiceGroupHealth { + /** + * Health state of the backend instances or endpoints in requested instance + * or network endpoint group, determined based on configured health checks. + */ healthStatus?: Schema$HealthStatus[]; /** * [Output Only] Type of resource. Always compute#backendServiceGroupHealth @@ -2637,6 +2682,15 @@ export namespace compute_beta { * v1.regionForwardingRules ==) */ export interface Schema$ForwardingRule { + /** + * This field is used along with the backend_service field for internal load + * balancing or with the target field for internal TargetInstance. This + * field cannot be used with port or portRange fields. When the load + * balancing scheme is INTERNAL and protocol is TCP/UDP, specify this field + * to allow packets addressed to any ports will be forwarded to the backends + * configured with this forwarding rule. + */ + allPorts?: boolean; /** * This field is only used for INTERNAL load balancing. For internal load * balancing, this field identifies the BackendService resource to receive @@ -3772,6 +3826,7 @@ export namespace compute_beta { * instance. */ guestAccelerators?: Schema$AcceleratorConfig[]; + hostname?: string; /** * [Output Only] The unique identifier for the resource. This identifier is * defined by the server. @@ -4405,7 +4460,7 @@ export namespace compute_beta { * instances initiated by this resize request only once. If there is an * error during creation, the managed instance group does not retry create * this instance, and we will decrease the targetSize of the request - * instead. If the flag is false, the group attemps to recreate each + * instead. If the flag is false, the group attempts to recreate each * instance continuously until it succeeds. This flag matters only in the * first attempt of creation of an instance. After an instance is * successfully created while this flag is enabled, the instance behaves the @@ -4787,6 +4842,23 @@ export namespace compute_beta { */ instance?: string; } + export interface Schema$InstancesResumeRequest { + /** + * Array of disks associated with this instance that are protected with a + * customer-supplied encryption key. In order to resume the instance, the + * disk url and its corresponding key must be provided. If the disk is not + * protected with a customer-supplied encryption key it should not be + * specified. + */ + disks?: Schema$CustomerEncryptionKeyProtectedDisk[]; + /** + * Decrypts data associated with an instance that is protected with a + * customer-supplied encryption key. If the instance you are starting is + * protected with a customer-supplied encryption key, the correct key must + * be provided otherwise the instance resume will not succeed. + */ + instanceEncryptionKey?: Schema$CustomerEncryptionKey; + } export interface Schema$InstancesScopedList { /** * [Output Only] A list of instances contained in this scope. @@ -5876,7 +5948,11 @@ export namespace compute_beta { export interface Schema$LogConfigDataAccessOptions { /** * Whether Gin logging should happen in a fail-closed manner at the caller. - * This is relevant only in the LocalIAM implementation, for now. + * This is relevant only in the LocalIAM implementation, for now. NOTE: + * Logging to Gin in a fail-closed manner is currently unsupported while + * work is being done to satisfy the requirements of go/345. Currently, + * setting LOG_FAIL_CLOSED mode will have no effect, but still exists + * because there is active work being done to support it (b/115874152). */ logMode?: string; } @@ -6852,7 +6928,7 @@ export namespace compute_beta { * with RFC1035. Specifically, the name must be 1-63 characters long and * match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the * first character must be a lowercase letter, and all following characters - * must be a dash, lowercase letter, or digit, except the last charaicter, + * must be a dash, lowercase letter, or digit, except the last character, * which cannot be a dash. */ name?: string; @@ -7322,12 +7398,19 @@ export namespace compute_beta { export interface Schema$PathMatcher { /** * The full or partial URL to the BackendService resource. This will be used - * if none of the pathRules defined by this PathMatcher is matched by the - * URL's path portion. For example, the following are all valid URLs to - * a BackendService resource: - + * if none of the pathRules or routeRules defined by this PathMatcher are + * matched. For example, the following are all valid URLs to a + * BackendService resource: - * https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService * - compute/v1/projects/project/global/backendServices/backendService - - * global/backendServices/backendService + * global/backendServices/backendService Use defaultService instead of + * defaultRouteAction when simple routing to a backend service is desired + * and other advanced capabilities like traffic splitting and URL rewrites + * are not required. Only one of defaultService, defaultRouteAction or + * defaultUrlRedirect must be set. Authorization requires one or more of the + * following Google IAM permissions on the specified resource + * default_service: - compute.backendBuckets.use - + * compute.backendServices.use */ defaultService?: string; /** @@ -7340,7 +7423,13 @@ export namespace compute_beta { */ name?: string; /** - * The list of path rules. + * The list of path rules. Use this list instead of routeRules when routing + * based on simple path matching is all that's required. The order by + * which path rules are specified does not matter. Matches are always done + * on the longest-path-first basis. For example: a pathRule with a path + * /a/b/c/* will match before /a/b/* irrespective of the order in which + * those paths appear in this list. Only one of pathRules or routeRules must + * be set. */ pathRules?: Schema$PathRule[]; } @@ -7357,7 +7446,11 @@ export namespace compute_beta { */ paths?: string[]; /** - * The URL of the BackendService resource if this rule is matched. + * The URL of the backend service resource if this rule is matched. Use + * service instead of routeAction when simple routing to a backend service + * is desired and other advanced capabilities like traffic splitting and + * rewrites are not required. Only one of service, routeAction or + * urlRedirect should must be set. */ service?: string; } @@ -7981,8 +8074,8 @@ export namespace compute_beta { } export interface Schema$ResourceGroupReference { /** - * A URI referencing one of the instance groups listed in the backend - * service. + * A URI referencing one of the instance groups or network endpoint groups + * listed in the backend service. */ group?: string; } @@ -8070,7 +8163,7 @@ export namespace compute_beta { /** * A backup schedule policy specifies when and how frequently snapshots are to * be created for the target disk. Also specifies how many and how long these - * automatically created snapshot should be retained. + * scheduled snapshots should be retained. */ export interface Schema$ResourcePolicyBackupSchedulePolicy { /** @@ -8084,20 +8177,25 @@ export namespace compute_beta { */ schedule?: Schema$ResourcePolicyBackupSchedulePolicySchedule; /** - * Properties with which snapshots are created such as lables, encryption + * Properties with which snapshots are created such as labels, encryption * keys. */ snapshotProperties?: Schema$ResourcePolicyBackupSchedulePolicySnapshotProperties; } /** - * Policy for retention of automatically created snapshots. + * Policy for retention of scheduled snapshots. */ export interface Schema$ResourcePolicyBackupSchedulePolicyRetentionPolicy { /** * Maximum age of the snapshot that is allowed to be kept. */ maxRetentionDays?: number; + /** + * Specifies the behavior to apply to scheduled snapshots when the source + * disk is deleted. + */ + onSourceDiskDelete?: string; } /** * A schedule for disks where the schedueled operations are performed. @@ -8108,7 +8206,7 @@ export namespace compute_beta { weeklySchedule?: Schema$ResourcePolicyWeeklyCycle; } /** - * Specified snapshot properties for automatic snapshots created by this + * Specified snapshot properties for scheduled snapshots created by this * policy. */ export interface Schema$ResourcePolicyBackupSchedulePolicySnapshotProperties { @@ -8117,15 +8215,10 @@ export namespace compute_beta { */ guestFlush?: boolean; /** - * Labels to apply to automatic snapshots. These can be later modified by + * Labels to apply to scheduled snapshots. These can be later modified by * the setLabels method. Label values may be empty. */ labels?: any; - /** - * GCS bucket storage location of the auto snapshot (regional or - * multi-regional). - */ - storageLocations?: string[]; } /** * Time window specified for daily operations. @@ -8142,7 +8235,7 @@ export namespace compute_beta { duration?: string; /** * Time within the window to start the operations. It must be in format - * "HH:MM?, where HH : [00-23] and MM : [00-59] GMT. + * "HH:MM?, where HH : [00-23] and MM : [00-00] GMT. */ startTime?: string; } @@ -8161,7 +8254,7 @@ export namespace compute_beta { hoursInCycle?: number; /** * Time within the window to start the operations. It must be in format - * "HH:MM?, where HH : [00-23] and MM : [00-59] GMT. + * "HH:MM?, where HH : [00-23] and MM : [00-00] GMT. */ startTime?: string; } @@ -8219,7 +8312,7 @@ export namespace compute_beta { duration?: string; /** * Time within the window to start the operations. It must be in format - * "HH:MM?, where HH : [00-23] and MM : [00-59] GMT. + * "HH:MM?, where HH : [00-23] and MM : [00-00] GMT. */ startTime?: string; } @@ -8284,6 +8377,17 @@ export namespace compute_beta { * projects/<project-id>/global/gateways/default-internet-gateway */ nextHopGateway?: string; + /** + * The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that + * should handle matching packets. You can only specify the forwarding rule + * as a partial or full URL. For example, the following are all valid URLs: + * - + * https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule + * - regions/region/forwardingRules/forwardingRule Note that this can only + * be used when the destination_range is a public (non-RFC 1918) IP CIDR + * range. + */ + nextHopIlb?: string; /** * The URL to an instance that should handle matching packets. You can * specify this as a full or partial URL. For example: @@ -9086,10 +9190,6 @@ export namespace compute_beta { * request header. */ expr?: Schema$Expr; - /** - * CIDR IP address range. - */ - srcIpRanges?: string[]; /** * Preconfigured versioned expression. If this field is specified, config * must also be specified. Available preconfigured expressions along with @@ -9220,7 +9320,7 @@ export namespace compute_beta { */ export interface Schema$Snapshot { /** - * [Output Only] Set to true if snapshots are autoamtically by applying + * [Output Only] Set to true if snapshots are automatically by applying * resource policy on the target disk. */ autoCreated?: boolean; @@ -10060,8 +10160,9 @@ export namespace compute_beta { selfLink?: string; /** * URLs to SslCertificate resources that are used to authenticate - * connections between users and the load balancer. Currently, exactly one - * SSL certificate must be specified. + * connections between users and the load balancer. At least one SSL + * certificate must be specified. Currently, you may specify up to 15 SSL + * certificates. */ sslCertificates?: string[]; /** @@ -10334,7 +10435,7 @@ export namespace compute_beta { */ selfLink?: string; /** - * Sesssion affinity option, must be one of the following values: NONE: + * Session affinity option, must be one of the following values: NONE: * Connections from the same client IP may go to any instance in the pool. * CLIENT_IP: Connections from the same client IP will go to the same * instance in the pool while that instance remains healthy. @@ -10533,8 +10634,8 @@ export namespace compute_beta { service?: string; /** * URLs to SslCertificate resources that are used to authenticate - * connections to Backends. Currently exactly one SSL certificate must be - * specified. + * connections to Backends. At least one SSL certificate must be specified. + * Currently, you may specify up to 15 SSL certificates. */ sslCertificates?: string[]; /** @@ -10903,7 +11004,11 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * The URL of the BackendService resource if none of the hostRules match. + * The URL of the backendService resource if none of the hostRules match. + * Use defaultService instead of defaultRouteAction when simple routing to a + * backendService is desired and other advanced capabilities like traffic + * splitting and rewrites are not required. Only one of defaultService, + * defaultRouteAction or defaultUrlRedirect should must be set. */ defaultService?: string; /** @@ -12008,7 +12113,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Acceleratortypes$Aggregatedlist { + export interface Params$Resource$Acceleratortypes$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12062,7 +12168,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Acceleratortypes$Get { + export interface Params$Resource$Acceleratortypes$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12081,7 +12188,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Acceleratortypes$List { + export interface Params$Resource$Acceleratortypes$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13029,7 +13137,7 @@ export namespace compute_beta { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -13094,7 +13202,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Addresses$Aggregatedlist { + export interface Params$Resource$Addresses$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13148,7 +13257,7 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Addresses$Delete { + export interface Params$Resource$Addresses$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -13180,7 +13289,7 @@ export namespace compute_beta { */ requestId?: string; } - export interface Params$Resource$Addresses$Get { + export interface Params$Resource$Addresses$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -13199,7 +13308,7 @@ export namespace compute_beta { */ region?: string; } - export interface Params$Resource$Addresses$Insert { + export interface Params$Resource$Addresses$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -13232,7 +13341,7 @@ export namespace compute_beta { */ requestBody?: Schema$Address; } - export interface Params$Resource$Addresses$List { + export interface Params$Resource$Addresses$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -13290,7 +13399,8 @@ export namespace compute_beta { */ region?: string; } - export interface Params$Resource$Addresses$Setlabels { + export interface Params$Resource$Addresses$Setlabels extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13327,7 +13437,8 @@ export namespace compute_beta { */ requestBody?: Schema$RegionSetLabelsRequest; } - export interface Params$Resource$Addresses$Testiampermissions { + export interface Params$Resource$Addresses$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13342,7 +13453,7 @@ export namespace compute_beta { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -14240,7 +14351,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {string} params.zone The name of the zone for this request. * @param {().TestPermissionsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14441,7 +14552,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Autoscalers$Aggregatedlist { + export interface Params$Resource$Autoscalers$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14495,7 +14607,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Autoscalers$Delete { + export interface Params$Resource$Autoscalers$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14527,7 +14640,7 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Autoscalers$Get { + export interface Params$Resource$Autoscalers$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -14546,7 +14659,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Autoscalers$Insert { + export interface Params$Resource$Autoscalers$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14579,7 +14693,7 @@ export namespace compute_beta { */ requestBody?: Schema$Autoscaler; } - export interface Params$Resource$Autoscalers$List { + export interface Params$Resource$Autoscalers$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -14637,7 +14751,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Autoscalers$Patch { + export interface Params$Resource$Autoscalers$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14674,7 +14789,8 @@ export namespace compute_beta { */ requestBody?: Schema$Autoscaler; } - export interface Params$Resource$Autoscalers$Testiampermissions { + export interface Params$Resource$Autoscalers$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14685,7 +14801,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; /** @@ -14698,7 +14814,8 @@ export namespace compute_beta { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Autoscalers$Update { + export interface Params$Resource$Autoscalers$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15686,7 +15803,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Backendbuckets$Addsignedurlkey { + export interface Params$Resource$Backendbuckets$Addsignedurlkey extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15720,7 +15838,8 @@ export namespace compute_beta { */ requestBody?: Schema$SignedUrlKey; } - export interface Params$Resource$Backendbuckets$Delete { + export interface Params$Resource$Backendbuckets$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15748,7 +15867,8 @@ export namespace compute_beta { */ requestId?: string; } - export interface Params$Resource$Backendbuckets$Deletesignedurlkey { + export interface Params$Resource$Backendbuckets$Deletesignedurlkey extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15781,7 +15901,8 @@ export namespace compute_beta { */ requestId?: string; } - export interface Params$Resource$Backendbuckets$Get { + export interface Params$Resource$Backendbuckets$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15796,7 +15917,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Backendbuckets$Insert { + export interface Params$Resource$Backendbuckets$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15825,7 +15947,8 @@ export namespace compute_beta { */ requestBody?: Schema$BackendBucket; } - export interface Params$Resource$Backendbuckets$List { + export interface Params$Resource$Backendbuckets$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15879,7 +16002,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Backendbuckets$Patch { + export interface Params$Resource$Backendbuckets$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15912,7 +16036,8 @@ export namespace compute_beta { */ requestBody?: Schema$BackendBucket; } - export interface Params$Resource$Backendbuckets$Update { + export interface Params$Resource$Backendbuckets$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17248,7 +17373,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -17451,7 +17576,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Backendservices$Addsignedurlkey { + export interface Params$Resource$Backendservices$Addsignedurlkey extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17485,7 +17611,8 @@ export namespace compute_beta { */ requestBody?: Schema$SignedUrlKey; } - export interface Params$Resource$Backendservices$Aggregatedlist { + export interface Params$Resource$Backendservices$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17539,7 +17666,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Backendservices$Delete { + export interface Params$Resource$Backendservices$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17567,7 +17695,8 @@ export namespace compute_beta { */ requestId?: string; } - export interface Params$Resource$Backendservices$Deletesignedurlkey { + export interface Params$Resource$Backendservices$Deletesignedurlkey extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17600,7 +17729,8 @@ export namespace compute_beta { */ requestId?: string; } - export interface Params$Resource$Backendservices$Get { + export interface Params$Resource$Backendservices$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17615,7 +17745,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Backendservices$Gethealth { + export interface Params$Resource$Backendservices$Gethealth extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17636,7 +17767,8 @@ export namespace compute_beta { */ requestBody?: Schema$ResourceGroupReference; } - export interface Params$Resource$Backendservices$Insert { + export interface Params$Resource$Backendservices$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17665,7 +17797,8 @@ export namespace compute_beta { */ requestBody?: Schema$BackendService; } - export interface Params$Resource$Backendservices$List { + export interface Params$Resource$Backendservices$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17719,7 +17852,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Backendservices$Patch { + export interface Params$Resource$Backendservices$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17752,7 +17886,8 @@ export namespace compute_beta { */ requestBody?: Schema$BackendService; } - export interface Params$Resource$Backendservices$Setsecuritypolicy { + export interface Params$Resource$Backendservices$Setsecuritypolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17786,7 +17921,8 @@ export namespace compute_beta { */ requestBody?: Schema$SecurityPolicyReference; } - export interface Params$Resource$Backendservices$Testiampermissions { + export interface Params$Resource$Backendservices$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17797,7 +17933,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -17806,7 +17942,8 @@ export namespace compute_beta { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Backendservices$Update { + export interface Params$Resource$Backendservices$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18471,7 +18608,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {string} params.zone The name of the zone for this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -19025,7 +19162,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {string} params.zone The name of the zone for this request. * @param {().ZoneSetPolicyRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -19295,7 +19432,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {string} params.zone The name of the zone for this request. * @param {().TestPermissionsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -19361,7 +19498,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Disks$Addresourcepolicies { + export interface Params$Resource$Disks$Addresourcepolicies extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19398,7 +19536,8 @@ export namespace compute_beta { */ requestBody?: Schema$DisksAddResourcePoliciesRequest; } - export interface Params$Resource$Disks$Aggregatedlist { + export interface Params$Resource$Disks$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19452,7 +19591,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Disks$Createsnapshot { + export interface Params$Resource$Disks$Createsnapshot extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19493,7 +19633,7 @@ export namespace compute_beta { */ requestBody?: Schema$Snapshot; } - export interface Params$Resource$Disks$Delete { + export interface Params$Resource$Disks$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -19525,7 +19665,7 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Disks$Get { + export interface Params$Resource$Disks$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -19544,7 +19684,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Disks$Getiampolicy { + export interface Params$Resource$Disks$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19555,7 +19696,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; /** @@ -19563,7 +19704,7 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Disks$Insert { + export interface Params$Resource$Disks$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -19600,7 +19741,7 @@ export namespace compute_beta { */ requestBody?: Schema$Disk; } - export interface Params$Resource$Disks$List { + export interface Params$Resource$Disks$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -19658,7 +19799,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Disks$Removeresourcepolicies { + export interface Params$Resource$Disks$Removeresourcepolicies extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19695,7 +19837,7 @@ export namespace compute_beta { */ requestBody?: Schema$DisksRemoveResourcePoliciesRequest; } - export interface Params$Resource$Disks$Resize { + export interface Params$Resource$Disks$Resize extends StandardParameters { /** * Auth client or API Key for the request */ @@ -19732,7 +19874,8 @@ export namespace compute_beta { */ requestBody?: Schema$DisksResizeRequest; } - export interface Params$Resource$Disks$Setiampolicy { + export interface Params$Resource$Disks$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19743,7 +19886,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; /** @@ -19756,7 +19899,7 @@ export namespace compute_beta { */ requestBody?: Schema$ZoneSetPolicyRequest; } - export interface Params$Resource$Disks$Setlabels { + export interface Params$Resource$Disks$Setlabels extends StandardParameters { /** * Auth client or API Key for the request */ @@ -19793,7 +19936,8 @@ export namespace compute_beta { */ requestBody?: Schema$ZoneSetLabelsRequest; } - export interface Params$Resource$Disks$Testiampermissions { + export interface Params$Resource$Disks$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19804,7 +19948,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; /** @@ -20237,7 +20381,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Disktypes$Aggregatedlist { + export interface Params$Resource$Disktypes$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -20291,7 +20436,7 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Disktypes$Get { + export interface Params$Resource$Disktypes$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -20310,7 +20455,7 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Disktypes$List { + export interface Params$Resource$Disktypes$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -21092,7 +21237,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -21291,7 +21436,7 @@ export namespace compute_beta { } } - export interface Params$Resource$Firewalls$Delete { + export interface Params$Resource$Firewalls$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -21319,7 +21464,7 @@ export namespace compute_beta { */ requestId?: string; } - export interface Params$Resource$Firewalls$Get { + export interface Params$Resource$Firewalls$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -21334,7 +21479,7 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Firewalls$Insert { + export interface Params$Resource$Firewalls$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -21363,7 +21508,7 @@ export namespace compute_beta { */ requestBody?: Schema$Firewall; } - export interface Params$Resource$Firewalls$List { + export interface Params$Resource$Firewalls$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -21417,7 +21562,7 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Firewalls$Patch { + export interface Params$Resource$Firewalls$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -21450,7 +21595,8 @@ export namespace compute_beta { */ requestBody?: Schema$Firewall; } - export interface Params$Resource$Firewalls$Testiampermissions { + export interface Params$Resource$Firewalls$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -21461,7 +21607,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -21470,7 +21616,7 @@ export namespace compute_beta { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Firewalls$Update { + export interface Params$Resource$Firewalls$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -22546,7 +22692,7 @@ export namespace compute_beta { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -22611,7 +22757,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Forwardingrules$Aggregatedlist { + export interface Params$Resource$Forwardingrules$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22665,7 +22812,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Forwardingrules$Delete { + export interface Params$Resource$Forwardingrules$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22697,7 +22845,8 @@ export namespace compute_beta { */ requestId?: string; } - export interface Params$Resource$Forwardingrules$Get { + export interface Params$Resource$Forwardingrules$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22716,7 +22865,8 @@ export namespace compute_beta { */ region?: string; } - export interface Params$Resource$Forwardingrules$Insert { + export interface Params$Resource$Forwardingrules$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22749,7 +22899,8 @@ export namespace compute_beta { */ requestBody?: Schema$ForwardingRule; } - export interface Params$Resource$Forwardingrules$List { + export interface Params$Resource$Forwardingrules$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22807,7 +22958,8 @@ export namespace compute_beta { */ region?: string; } - export interface Params$Resource$Forwardingrules$Setlabels { + export interface Params$Resource$Forwardingrules$Setlabels extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22844,7 +22996,8 @@ export namespace compute_beta { */ requestBody?: Schema$RegionSetLabelsRequest; } - export interface Params$Resource$Forwardingrules$Settarget { + export interface Params$Resource$Forwardingrules$Settarget extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22881,7 +23034,8 @@ export namespace compute_beta { */ requestBody?: Schema$TargetReference; } - export interface Params$Resource$Forwardingrules$Testiampermissions { + export interface Params$Resource$Forwardingrules$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22896,7 +23050,7 @@ export namespace compute_beta { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -23632,7 +23786,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -23697,7 +23851,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Globaladdresses$Delete { + export interface Params$Resource$Globaladdresses$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23725,7 +23880,8 @@ export namespace compute_beta { */ requestId?: string; } - export interface Params$Resource$Globaladdresses$Get { + export interface Params$Resource$Globaladdresses$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23740,7 +23896,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Globaladdresses$Insert { + export interface Params$Resource$Globaladdresses$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23769,7 +23926,8 @@ export namespace compute_beta { */ requestBody?: Schema$Address; } - export interface Params$Resource$Globaladdresses$List { + export interface Params$Resource$Globaladdresses$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23823,7 +23981,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Globaladdresses$Setlabels { + export interface Params$Resource$Globaladdresses$Setlabels extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23843,7 +24002,8 @@ export namespace compute_beta { */ requestBody?: Schema$GlobalSetLabelsRequest; } - export interface Params$Resource$Globaladdresses$Testiampermissions { + export interface Params$Resource$Globaladdresses$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23854,7 +24014,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -24724,7 +24884,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -24790,7 +24950,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Globalforwardingrules$Delete { + export interface Params$Resource$Globalforwardingrules$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -24818,7 +24979,8 @@ export namespace compute_beta { */ requestId?: string; } - export interface Params$Resource$Globalforwardingrules$Get { + export interface Params$Resource$Globalforwardingrules$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -24833,7 +24995,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Globalforwardingrules$Insert { + export interface Params$Resource$Globalforwardingrules$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -24862,7 +25025,8 @@ export namespace compute_beta { */ requestBody?: Schema$ForwardingRule; } - export interface Params$Resource$Globalforwardingrules$List { + export interface Params$Resource$Globalforwardingrules$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -24916,7 +25080,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Globalforwardingrules$Setlabels { + export interface Params$Resource$Globalforwardingrules$Setlabels extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -24936,7 +25101,8 @@ export namespace compute_beta { */ requestBody?: Schema$GlobalSetLabelsRequest; } - export interface Params$Resource$Globalforwardingrules$Settarget { + export interface Params$Resource$Globalforwardingrules$Settarget extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -24969,7 +25135,8 @@ export namespace compute_beta { */ requestBody?: Schema$TargetReference; } - export interface Params$Resource$Globalforwardingrules$Testiampermissions { + export interface Params$Resource$Globalforwardingrules$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -24980,7 +25147,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -25527,7 +25694,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Globaloperations$Aggregatedlist { + export interface Params$Resource$Globaloperations$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -25581,7 +25749,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Globaloperations$Delete { + export interface Params$Resource$Globaloperations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -25596,7 +25765,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Globaloperations$Get { + export interface Params$Resource$Globaloperations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -25611,7 +25781,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Globaloperations$List { + export interface Params$Resource$Globaloperations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26395,7 +26566,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -26595,7 +26766,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Healthchecks$Delete { + export interface Params$Resource$Healthchecks$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26623,7 +26795,7 @@ export namespace compute_beta { */ requestId?: string; } - export interface Params$Resource$Healthchecks$Get { + export interface Params$Resource$Healthchecks$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -26638,7 +26810,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Healthchecks$Insert { + export interface Params$Resource$Healthchecks$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26667,7 +26840,8 @@ export namespace compute_beta { */ requestBody?: Schema$HealthCheck; } - export interface Params$Resource$Healthchecks$List { + export interface Params$Resource$Healthchecks$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26721,7 +26895,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Healthchecks$Patch { + export interface Params$Resource$Healthchecks$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26754,7 +26929,8 @@ export namespace compute_beta { */ requestBody?: Schema$HealthCheck; } - export interface Params$Resource$Healthchecks$Testiampermissions { + export interface Params$Resource$Healthchecks$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26765,7 +26941,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -26774,7 +26950,8 @@ export namespace compute_beta { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Healthchecks$Update { + export interface Params$Resource$Healthchecks$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -27543,7 +27720,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -27744,7 +27921,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Httphealthchecks$Delete { + export interface Params$Resource$Httphealthchecks$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -27772,7 +27950,8 @@ export namespace compute_beta { */ requestId?: string; } - export interface Params$Resource$Httphealthchecks$Get { + export interface Params$Resource$Httphealthchecks$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -27787,7 +27966,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Httphealthchecks$Insert { + export interface Params$Resource$Httphealthchecks$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -27816,7 +27996,8 @@ export namespace compute_beta { */ requestBody?: Schema$HttpHealthCheck; } - export interface Params$Resource$Httphealthchecks$List { + export interface Params$Resource$Httphealthchecks$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -27870,7 +28051,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Httphealthchecks$Patch { + export interface Params$Resource$Httphealthchecks$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -27903,7 +28085,8 @@ export namespace compute_beta { */ requestBody?: Schema$HttpHealthCheck; } - export interface Params$Resource$Httphealthchecks$Testiampermissions { + export interface Params$Resource$Httphealthchecks$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -27914,7 +28097,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -27923,7 +28106,8 @@ export namespace compute_beta { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Httphealthchecks$Update { + export interface Params$Resource$Httphealthchecks$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -28693,7 +28877,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -28894,7 +29078,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Httpshealthchecks$Delete { + export interface Params$Resource$Httpshealthchecks$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -28922,7 +29107,8 @@ export namespace compute_beta { */ requestId?: string; } - export interface Params$Resource$Httpshealthchecks$Get { + export interface Params$Resource$Httpshealthchecks$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -28937,7 +29123,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Httpshealthchecks$Insert { + export interface Params$Resource$Httpshealthchecks$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -28966,7 +29153,8 @@ export namespace compute_beta { */ requestBody?: Schema$HttpsHealthCheck; } - export interface Params$Resource$Httpshealthchecks$List { + export interface Params$Resource$Httpshealthchecks$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -29020,7 +29208,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Httpshealthchecks$Patch { + export interface Params$Resource$Httpshealthchecks$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -29053,7 +29242,8 @@ export namespace compute_beta { */ requestBody?: Schema$HttpsHealthCheck; } - export interface Params$Resource$Httpshealthchecks$Testiampermissions { + export interface Params$Resource$Httpshealthchecks$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -29064,7 +29254,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -29073,7 +29263,8 @@ export namespace compute_beta { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Httpshealthchecks$Update { + export interface Params$Resource$Httpshealthchecks$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -29631,7 +29822,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for 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 @@ -29967,7 +30158,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().GlobalSetPolicyRequest} 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. @@ -30228,7 +30419,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -30293,7 +30484,7 @@ export namespace compute_beta { } } - export interface Params$Resource$Images$Delete { + export interface Params$Resource$Images$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -30321,7 +30512,7 @@ export namespace compute_beta { */ requestId?: string; } - export interface Params$Resource$Images$Deprecate { + export interface Params$Resource$Images$Deprecate extends StandardParameters { /** * Auth client or API Key for the request */ @@ -30354,7 +30545,7 @@ export namespace compute_beta { */ requestBody?: Schema$DeprecationStatus; } - export interface Params$Resource$Images$Get { + export interface Params$Resource$Images$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -30369,7 +30560,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Images$Getfromfamily { + export interface Params$Resource$Images$Getfromfamily extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -30384,7 +30576,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Images$Getiampolicy { + export interface Params$Resource$Images$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -30395,11 +30588,11 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; } - export interface Params$Resource$Images$Insert { + export interface Params$Resource$Images$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -30432,7 +30625,7 @@ export namespace compute_beta { */ requestBody?: Schema$Image; } - export interface Params$Resource$Images$List { + export interface Params$Resource$Images$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -30486,7 +30679,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Images$Setiampolicy { + export interface Params$Resource$Images$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -30497,7 +30691,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -30506,7 +30700,7 @@ export namespace compute_beta { */ requestBody?: Schema$GlobalSetPolicyRequest; } - export interface Params$Resource$Images$Setlabels { + export interface Params$Resource$Images$Setlabels extends StandardParameters { /** * Auth client or API Key for the request */ @@ -30526,7 +30720,8 @@ export namespace compute_beta { */ requestBody?: Schema$GlobalSetLabelsRequest; } - export interface Params$Resource$Images$Testiampermissions { + export interface Params$Resource$Images$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -30537,7 +30732,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -30562,19 +30757,19 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.abandonInstances - * @desc Schedules a group action to remove the specified instances from the - * managed instance group. Abandoning an instance does not delete the - * instance, but it does remove the instance from any target pools that are - * applied by the managed instance group. This method reduces the targetSize - * of the managed instance group by the number of instances that you - * abandon. This operation is marked as DONE when the action is scheduled - * even if the instances have not yet been removed from the group. You must - * separately verify the status of the abandoning action with the - * listmanagedinstances method. If the group is part of a backend service - * that has enabled connection draining, it can take up to 60 seconds after - * the connection draining duration has elapsed before the VM instance is - * removed or deleted. You can specify a maximum of 1000 instances with - * this method per request. + * @desc Flags the specified instances to be removed from the managed + * instance group. Abandoning an instance does not delete the instance, but + * it does remove the instance from any target pools that are applied by the + * managed instance group. This method reduces the targetSize of the managed + * instance group by the number of instances that you abandon. This + * operation is marked as DONE when the action is scheduled even if the + * instances have not yet been removed from the group. You must separately + * verify the status of the abandoning action with the listmanagedinstances + * method. If the group is part of a backend service that has enabled + * connection draining, it can take up to 60 seconds after the connection + * draining duration has elapsed before the VM instance is removed or + * deleted. You can specify a maximum of 1000 instances with this method + * per request. * @example * * // BEFORE RUNNING: * // --------------- @@ -30997,11 +31192,11 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.deleteInstances - * @desc Schedules a group action to delete the specified instances in the - * managed instance group. The instances are also removed from any target - * pools of which they were a member. This method reduces the targetSize of - * the managed instance group by the number of instances that you delete. - * This operation is marked as DONE when the action is scheduled even if the + * @desc Flags the specified instances in the managed instance group for + * immediate deletion. The instances are also removed from any target pools + * of which they were a member. This method reduces the targetSize of the + * managed instance group by the number of instances that you delete. This + * operation is marked as DONE when the action is scheduled even if the * instances are still being deleted. You must separately verify the status * of the deleting action with the listmanagedinstances method. If the * group is part of a backend service that has enabled connection draining, @@ -31274,14 +31469,13 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.insert * @desc Creates a managed instance group using the information that you - * specify in the request. After the group is created, it schedules an - * action to create instances in the group using the specified instance - * template. This operation is marked as DONE when the group is created even - * if the instances in the group have not yet been created. You must - * separately verify the status of the individual instances with the - * listmanagedinstances method. A managed instance group can have up to - * 1000 VM instances per group. Please contact Cloud Support if you need an - * increase in this limit. + * specify in the request. After the group is created, instances in the + * group are created using the specified instance template. This operation + * is marked as DONE when the group is created even if the instances in the + * group have not yet been created. You must separately verify the status of + * the individual instances with the listmanagedinstances method. A managed + * instance group can have up to 1000 VM instances per group. Please contact + * Cloud Support if you need an increase in this limit. * @example * * // BEFORE RUNNING: * // --------------- @@ -31873,16 +32067,16 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.recreateInstances - * @desc Schedules a group action to recreate the specified instances in the - * managed instance group. The instances are deleted and recreated using the + * @desc Flags the specified instances in the managed instance group to be + * immediately recreated. The instances are deleted and recreated using the * current instance template for the managed instance group. This operation - * is marked as DONE when the action is scheduled even if the instances have - * not yet been recreated. You must separately verify the status of the - * recreating action with the listmanagedinstances method. If the group is - * part of a backend service that has enabled connection draining, it can - * take up to 60 seconds after the connection draining duration has elapsed - * before the VM instance is removed or deleted. You can specify a maximum - * of 1000 instances with this method per request. + * is marked as DONE when the flag is set even if the instances have not yet + * been recreated. You must separately verify the status of the recreating + * action with the listmanagedinstances method. If the group is part of a + * backend service that has enabled connection draining, it can take up to + * 60 seconds after the connection draining duration has elapsed before the + * VM instance is removed or deleted. You can specify a maximum of 1000 + * instances with this method per request. * @example * * // BEFORE RUNNING: * // --------------- @@ -32024,10 +32218,15 @@ export namespace compute_beta { * marked DONE when the resize actions are scheduled even if the group has * not yet added or deleted any instances. You must separately verify the * status of the creating or deleting actions with the listmanagedinstances - * method. If the group is part of a backend service that has enabled - * connection draining, it can take up to 60 seconds after the connection - * draining duration has elapsed before the VM instance is removed or - * deleted. + * method. When resizing down, the instance group arbitrarily chooses the + * order in which VMs are deleted. The group takes into account some VM + * attributes when making the selection including: + The status of the VM + * instance. + The health of the VM instance. + The instance template + * version the VM is based on. + For regional managed instance groups, the + * location of the VM instance. This list is subject to change. If the + * group is part of a backend service that has enabled connection draining, + * it can take up to 60 seconds after the connection draining duration has + * elapsed before the VM instance is removed or deleted. * @example * * // BEFORE RUNNING: * // --------------- @@ -32797,7 +32996,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {string} params.zone The name of the zone for this request. * @param {().TestPermissionsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -33007,7 +33206,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Instancegroupmanagers$Abandoninstances { + export interface Params$Resource$Instancegroupmanagers$Abandoninstances + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -33044,7 +33244,8 @@ export namespace compute_beta { */ requestBody?: Schema$InstanceGroupManagersAbandonInstancesRequest; } - export interface Params$Resource$Instancegroupmanagers$Aggregatedlist { + export interface Params$Resource$Instancegroupmanagers$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -33098,7 +33299,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Instancegroupmanagers$Delete { + export interface Params$Resource$Instancegroupmanagers$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -33130,7 +33332,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Instancegroupmanagers$Deleteinstances { + export interface Params$Resource$Instancegroupmanagers$Deleteinstances extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -33167,7 +33370,8 @@ export namespace compute_beta { */ requestBody?: Schema$InstanceGroupManagersDeleteInstancesRequest; } - export interface Params$Resource$Instancegroupmanagers$Get { + export interface Params$Resource$Instancegroupmanagers$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -33186,7 +33390,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Instancegroupmanagers$Insert { + export interface Params$Resource$Instancegroupmanagers$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -33219,7 +33424,8 @@ export namespace compute_beta { */ requestBody?: Schema$InstanceGroupManager; } - export interface Params$Resource$Instancegroupmanagers$List { + export interface Params$Resource$Instancegroupmanagers$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -33277,7 +33483,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Instancegroupmanagers$Listmanagedinstances { + export interface Params$Resource$Instancegroupmanagers$Listmanagedinstances + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -33339,7 +33546,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Instancegroupmanagers$Patch { + export interface Params$Resource$Instancegroupmanagers$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -33376,7 +33584,8 @@ export namespace compute_beta { */ requestBody?: Schema$InstanceGroupManager; } - export interface Params$Resource$Instancegroupmanagers$Recreateinstances { + export interface Params$Resource$Instancegroupmanagers$Recreateinstances + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -33413,7 +33622,8 @@ export namespace compute_beta { */ requestBody?: Schema$InstanceGroupManagersRecreateInstancesRequest; } - export interface Params$Resource$Instancegroupmanagers$Resize { + export interface Params$Resource$Instancegroupmanagers$Resize extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -33452,7 +33662,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Instancegroupmanagers$Resizeadvanced { + export interface Params$Resource$Instancegroupmanagers$Resizeadvanced extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -33489,7 +33700,8 @@ export namespace compute_beta { */ requestBody?: Schema$InstanceGroupManagersResizeAdvancedRequest; } - export interface Params$Resource$Instancegroupmanagers$Setautohealingpolicies { + export interface Params$Resource$Instancegroupmanagers$Setautohealingpolicies + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -33526,7 +33738,8 @@ export namespace compute_beta { */ requestBody?: Schema$InstanceGroupManagersSetAutoHealingRequest; } - export interface Params$Resource$Instancegroupmanagers$Setinstancetemplate { + export interface Params$Resource$Instancegroupmanagers$Setinstancetemplate + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -33563,7 +33776,8 @@ export namespace compute_beta { */ requestBody?: Schema$InstanceGroupManagersSetInstanceTemplateRequest; } - export interface Params$Resource$Instancegroupmanagers$Settargetpools { + export interface Params$Resource$Instancegroupmanagers$Settargetpools extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -33600,7 +33814,8 @@ export namespace compute_beta { */ requestBody?: Schema$InstanceGroupManagersSetTargetPoolsRequest; } - export interface Params$Resource$Instancegroupmanagers$Testiampermissions { + export interface Params$Resource$Instancegroupmanagers$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -33611,7 +33826,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; /** @@ -33624,7 +33839,8 @@ export namespace compute_beta { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Instancegroupmanagers$Update { + export interface Params$Resource$Instancegroupmanagers$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -35004,7 +35220,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {string} params.zone The name of the zone for this request. * @param {().TestPermissionsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -35070,7 +35286,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Instancegroups$Addinstances { + export interface Params$Resource$Instancegroups$Addinstances extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -35107,7 +35324,8 @@ export namespace compute_beta { */ requestBody?: Schema$InstanceGroupsAddInstancesRequest; } - export interface Params$Resource$Instancegroups$Aggregatedlist { + export interface Params$Resource$Instancegroups$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -35161,7 +35379,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Instancegroups$Delete { + export interface Params$Resource$Instancegroups$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -35193,7 +35412,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Instancegroups$Get { + export interface Params$Resource$Instancegroups$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -35212,7 +35432,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Instancegroups$Insert { + export interface Params$Resource$Instancegroups$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -35245,7 +35466,8 @@ export namespace compute_beta { */ requestBody?: Schema$InstanceGroup; } - export interface Params$Resource$Instancegroups$List { + export interface Params$Resource$Instancegroups$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -35303,7 +35525,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Instancegroups$Listinstances { + export interface Params$Resource$Instancegroups$Listinstances extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -35371,7 +35594,8 @@ export namespace compute_beta { */ requestBody?: Schema$InstanceGroupsListInstancesRequest; } - export interface Params$Resource$Instancegroups$Removeinstances { + export interface Params$Resource$Instancegroups$Removeinstances extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -35409,7 +35633,8 @@ export namespace compute_beta { */ requestBody?: Schema$InstanceGroupsRemoveInstancesRequest; } - export interface Params$Resource$Instancegroups$Setnamedports { + export interface Params$Resource$Instancegroups$Setnamedports extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -35446,7 +35671,8 @@ export namespace compute_beta { */ requestBody?: Schema$InstanceGroupsSetNamedPortsRequest; } - export interface Params$Resource$Instancegroups$Testiampermissions { + export interface Params$Resource$Instancegroups$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -35457,7 +35683,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; /** @@ -36519,7 +36745,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {string} params.zone The name of the zone for this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -37060,7 +37286,8 @@ export namespace compute_beta { /** * compute.instances.listReferrers * @desc Retrieves the list of referrers to instances contained within the - * specified zone. + * specified zone. For more information, read Viewing Referrers to VM + * Instances. * @example * * // BEFORE RUNNING: * // --------------- @@ -37339,6 +37566,78 @@ export namespace compute_beta { } + /** + * compute.instances.resume + * @desc Resumes an instance that was suspended using the + * instances().suspend method. + * @alias compute.instances.resume + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Name of the instance resource to resume. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {().InstancesResumeRequest} 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 + */ + resume(params?: Params$Resource$Instances$Resume, options?: MethodOptions): + AxiosPromise; + resume( + params: Params$Resource$Instances$Resume, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + resume( + params: Params$Resource$Instances$Resume, + callback: BodyResponseCallback): void; + resume(callback: BodyResponseCallback): void; + resume( + paramsOrCallback?: Params$Resource$Instances$Resume| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Instances$Resume; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Resume; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/instances/{instance}/resume') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.instances.setDeletionProtection * @desc Sets deletion protection on the instance. @@ -37619,7 +37918,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {string} params.zone The name of the zone for this request. * @param {().ZoneSetPolicyRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -38718,8 +39017,8 @@ export namespace compute_beta { /** * compute.instances.setTags - * @desc Sets tags for the specified instance to the data included in the - * request. + * @desc Sets network tags for the specified instance to the data included + * in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -39325,6 +39624,84 @@ export namespace compute_beta { } + /** + * compute.instances.suspend + * @desc This method suspends a running instance, saving its state to + * persistent storage, and allows you to resume the instance at a later + * time. Suspended instances incur reduced per-minute, virtual machine usage + * charges while they are suspended. Any resources the virtual machine is + * using, such as persistent disks and static IP addresses, will continue to + * be charged until they are deleted. + * @alias compute.instances.suspend + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.discardLocalSsd If true, discard the contents of any attached localSSD partitions. Default value is false (== preserve localSSD data). + * @param {string} params.instance Name of the instance resource to suspend. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for 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 + */ + suspend( + params?: Params$Resource$Instances$Suspend, + options?: MethodOptions): AxiosPromise; + suspend( + params: Params$Resource$Instances$Suspend, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + suspend( + params: Params$Resource$Instances$Suspend, + callback: BodyResponseCallback): void; + suspend(callback: BodyResponseCallback): void; + suspend( + paramsOrCallback?: Params$Resource$Instances$Suspend| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Instances$Suspend; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Suspend; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/instances/{instance}/suspend') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.instances.testIamPermissions * @desc Returns permissions that a caller has on the specified resource. @@ -39396,7 +39773,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {string} params.zone The name of the zone for this request. * @param {().TestPermissionsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -39823,7 +40200,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Instances$Addaccessconfig { + export interface Params$Resource$Instances$Addaccessconfig extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -39864,7 +40242,8 @@ export namespace compute_beta { */ requestBody?: Schema$AccessConfig; } - export interface Params$Resource$Instances$Aggregatedlist { + export interface Params$Resource$Instances$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -39918,7 +40297,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Instances$Attachdisk { + export interface Params$Resource$Instances$Attachdisk extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -39960,7 +40340,7 @@ export namespace compute_beta { */ requestBody?: Schema$AttachedDisk; } - export interface Params$Resource$Instances$Delete { + export interface Params$Resource$Instances$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -39992,7 +40372,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Instances$Deleteaccessconfig { + export interface Params$Resource$Instances$Deleteaccessconfig extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40032,7 +40413,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Instances$Detachdisk { + export interface Params$Resource$Instances$Detachdisk extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40068,7 +40450,7 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Instances$Get { + export interface Params$Resource$Instances$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -40087,7 +40469,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Instances$Getguestattributes { + export interface Params$Resource$Instances$Getguestattributes extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40114,7 +40497,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Instances$Getiampolicy { + export interface Params$Resource$Instances$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40125,7 +40509,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; /** @@ -40133,7 +40517,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Instances$Getserialportoutput { + export interface Params$Resource$Instances$Getserialportoutput extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40164,7 +40549,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Instances$Getshieldedvmidentity { + export interface Params$Resource$Instances$Getshieldedvmidentity extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40183,7 +40569,7 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Instances$Insert { + export interface Params$Resource$Instances$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -40225,7 +40611,7 @@ export namespace compute_beta { */ requestBody?: Schema$Instance; } - export interface Params$Resource$Instances$List { + export interface Params$Resource$Instances$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -40283,7 +40669,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Instances$Listreferrers { + export interface Params$Resource$Instances$Listreferrers extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40346,7 +40733,7 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Instances$Reset { + export interface Params$Resource$Instances$Reset extends StandardParameters { /** * Auth client or API Key for the request */ @@ -40378,7 +40765,45 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Instances$Setdeletionprotection { + export interface Params$Resource$Instances$Resume extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the instance resource to resume. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstancesResumeRequest; + } + export interface Params$Resource$Instances$Setdeletionprotection extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40414,7 +40839,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Instances$Setdiskautodelete { + export interface Params$Resource$Instances$Setdiskautodelete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40454,7 +40880,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Instances$Setiampolicy { + export interface Params$Resource$Instances$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40465,7 +40892,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; /** @@ -40478,7 +40905,8 @@ export namespace compute_beta { */ requestBody?: Schema$ZoneSetPolicyRequest; } - export interface Params$Resource$Instances$Setlabels { + export interface Params$Resource$Instances$Setlabels extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40515,7 +40943,8 @@ export namespace compute_beta { */ requestBody?: Schema$InstancesSetLabelsRequest; } - export interface Params$Resource$Instances$Setmachineresources { + export interface Params$Resource$Instances$Setmachineresources extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40552,7 +40981,8 @@ export namespace compute_beta { */ requestBody?: Schema$InstancesSetMachineResourcesRequest; } - export interface Params$Resource$Instances$Setmachinetype { + export interface Params$Resource$Instances$Setmachinetype extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40589,7 +41019,8 @@ export namespace compute_beta { */ requestBody?: Schema$InstancesSetMachineTypeRequest; } - export interface Params$Resource$Instances$Setmetadata { + export interface Params$Resource$Instances$Setmetadata extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40626,7 +41057,8 @@ export namespace compute_beta { */ requestBody?: Schema$Metadata; } - export interface Params$Resource$Instances$Setmincpuplatform { + export interface Params$Resource$Instances$Setmincpuplatform extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40663,7 +41095,8 @@ export namespace compute_beta { */ requestBody?: Schema$InstancesSetMinCpuPlatformRequest; } - export interface Params$Resource$Instances$Setscheduling { + export interface Params$Resource$Instances$Setscheduling extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40700,7 +41133,8 @@ export namespace compute_beta { */ requestBody?: Schema$Scheduling; } - export interface Params$Resource$Instances$Setserviceaccount { + export interface Params$Resource$Instances$Setserviceaccount extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40737,7 +41171,8 @@ export namespace compute_beta { */ requestBody?: Schema$InstancesSetServiceAccountRequest; } - export interface Params$Resource$Instances$Setshieldedvmintegritypolicy { + export interface Params$Resource$Instances$Setshieldedvmintegritypolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -40774,7 +41209,8 @@ export namespace compute_beta { */ requestBody?: Schema$ShieldedVmIntegrityPolicy; } - export interface Params$Resource$Instances$Settags { + export interface Params$Resource$Instances$Settags extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40811,7 +41247,8 @@ export namespace compute_beta { */ requestBody?: Schema$Tags; } - export interface Params$Resource$Instances$Simulatemaintenanceevent { + export interface Params$Resource$Instances$Simulatemaintenanceevent extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40830,7 +41267,7 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Instances$Start { + export interface Params$Resource$Instances$Start extends StandardParameters { /** * Auth client or API Key for the request */ @@ -40862,7 +41299,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Instances$Startwithencryptionkey { + export interface Params$Resource$Instances$Startwithencryptionkey extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40899,7 +41337,7 @@ export namespace compute_beta { */ requestBody?: Schema$InstancesStartWithEncryptionKeyRequest; } - export interface Params$Resource$Instances$Stop { + export interface Params$Resource$Instances$Stop extends StandardParameters { /** * Auth client or API Key for the request */ @@ -40931,18 +41369,57 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Instances$Testiampermissions { + export interface Params$Resource$Instances$Suspend extends + StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + /** + * If true, discard the contents of any attached localSSD partitions. + * Default value is false (== preserve localSSD data). + */ + discardLocalSsd?: boolean; + /** + * Name of the instance resource to suspend. + */ + instance?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the resource for this request. + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instances$Testiampermissions extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. */ resource?: string; /** @@ -40955,7 +41432,8 @@ export namespace compute_beta { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Instances$Updateaccessconfig { + export interface Params$Resource$Instances$Updateaccessconfig extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40996,7 +41474,8 @@ export namespace compute_beta { */ requestBody?: Schema$AccessConfig; } - export interface Params$Resource$Instances$Updatenetworkinterface { + export interface Params$Resource$Instances$Updatenetworkinterface extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -41037,7 +41516,8 @@ export namespace compute_beta { */ requestBody?: Schema$NetworkInterface; } - export interface Params$Resource$Instances$Updateshieldedvmconfig { + export interface Params$Resource$Instances$Updateshieldedvmconfig extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -41351,7 +41831,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for 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 @@ -41692,7 +42172,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().GlobalSetPolicyRequest} 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. @@ -41820,7 +42300,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -41885,7 +42365,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Instancetemplates$Delete { + export interface Params$Resource$Instancetemplates$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -41913,7 +42394,8 @@ export namespace compute_beta { */ requestId?: string; } - export interface Params$Resource$Instancetemplates$Get { + export interface Params$Resource$Instancetemplates$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -41928,7 +42410,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Instancetemplates$Getiampolicy { + export interface Params$Resource$Instancetemplates$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -41939,11 +42422,12 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; } - export interface Params$Resource$Instancetemplates$Insert { + export interface Params$Resource$Instancetemplates$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -41972,7 +42456,8 @@ export namespace compute_beta { */ requestBody?: Schema$InstanceTemplate; } - export interface Params$Resource$Instancetemplates$List { + export interface Params$Resource$Instancetemplates$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -42026,7 +42511,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Instancetemplates$Setiampolicy { + export interface Params$Resource$Instancetemplates$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -42037,7 +42523,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -42046,7 +42532,8 @@ export namespace compute_beta { */ requestBody?: Schema$GlobalSetPolicyRequest; } - export interface Params$Resource$Instancetemplates$Testiampermissions { + export interface Params$Resource$Instancetemplates$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -42057,7 +42544,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -42992,7 +43479,7 @@ export namespace compute_beta { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -43059,7 +43546,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Interconnectattachments$Aggregatedlist { + export interface Params$Resource$Interconnectattachments$Aggregatedlist + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -43113,7 +43601,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Interconnectattachments$Delete { + export interface Params$Resource$Interconnectattachments$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -43145,7 +43634,8 @@ export namespace compute_beta { */ requestId?: string; } - export interface Params$Resource$Interconnectattachments$Get { + export interface Params$Resource$Interconnectattachments$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -43164,7 +43654,8 @@ export namespace compute_beta { */ region?: string; } - export interface Params$Resource$Interconnectattachments$Insert { + export interface Params$Resource$Interconnectattachments$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -43197,7 +43688,8 @@ export namespace compute_beta { */ requestBody?: Schema$InterconnectAttachment; } - export interface Params$Resource$Interconnectattachments$List { + export interface Params$Resource$Interconnectattachments$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -43255,7 +43747,8 @@ export namespace compute_beta { */ region?: string; } - export interface Params$Resource$Interconnectattachments$Patch { + export interface Params$Resource$Interconnectattachments$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -43292,7 +43785,8 @@ export namespace compute_beta { */ requestBody?: Schema$InterconnectAttachment; } - export interface Params$Resource$Interconnectattachments$Setlabels { + export interface Params$Resource$Interconnectattachments$Setlabels extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -43329,7 +43823,8 @@ export namespace compute_beta { */ requestBody?: Schema$RegionSetLabelsRequest; } - export interface Params$Resource$Interconnectattachments$Testiampermissions { + export interface Params$Resource$Interconnectattachments$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -43344,7 +43839,7 @@ export namespace compute_beta { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -43633,7 +44128,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Interconnectlocations$Get { + export interface Params$Resource$Interconnectlocations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -43648,7 +44144,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Interconnectlocations$List { + export interface Params$Resource$Interconnectlocations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -44588,7 +45085,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -44653,7 +45150,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Interconnects$Delete { + export interface Params$Resource$Interconnects$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -44681,7 +45179,8 @@ export namespace compute_beta { */ requestId?: string; } - export interface Params$Resource$Interconnects$Get { + export interface Params$Resource$Interconnects$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -44696,7 +45195,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Interconnects$Getdiagnostics { + export interface Params$Resource$Interconnects$Getdiagnostics extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -44711,7 +45211,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Interconnects$Insert { + export interface Params$Resource$Interconnects$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -44740,7 +45241,8 @@ export namespace compute_beta { */ requestBody?: Schema$Interconnect; } - export interface Params$Resource$Interconnects$List { + export interface Params$Resource$Interconnects$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -44794,7 +45296,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Interconnects$Patch { + export interface Params$Resource$Interconnects$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -44827,7 +45330,8 @@ export namespace compute_beta { */ requestBody?: Schema$Interconnect; } - export interface Params$Resource$Interconnects$Setlabels { + export interface Params$Resource$Interconnects$Setlabels extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -44847,7 +45351,8 @@ export namespace compute_beta { */ requestBody?: Schema$GlobalSetLabelsRequest; } - export interface Params$Resource$Interconnects$Testiampermissions { + export interface Params$Resource$Interconnects$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -44858,7 +45363,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -44947,7 +45452,7 @@ export namespace compute_beta { } } - export interface Params$Resource$Licensecodes$Get { + export interface Params$Resource$Licensecodes$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -45309,7 +45814,7 @@ export namespace compute_beta { } } - export interface Params$Resource$Licenses$Delete { + export interface Params$Resource$Licenses$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -45337,7 +45842,7 @@ export namespace compute_beta { */ requestId?: string; } - export interface Params$Resource$Licenses$Get { + export interface Params$Resource$Licenses$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -45352,7 +45857,7 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Licenses$Insert { + export interface Params$Resource$Licenses$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -45381,7 +45886,7 @@ export namespace compute_beta { */ requestBody?: Schema$License; } - export interface Params$Resource$Licenses$List { + export interface Params$Resource$Licenses$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -45861,7 +46366,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Machinetypes$Aggregatedlist { + export interface Params$Resource$Machinetypes$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -45915,7 +46421,7 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Machinetypes$Get { + export interface Params$Resource$Machinetypes$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -45934,7 +46440,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Machinetypes$List { + export interface Params$Resource$Machinetypes$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -46635,7 +47142,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {string} params.zone The name of the zone for this request. * @param {().TestPermissionsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -46702,7 +47209,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Networkendpointgroups$Aggregatedlist { + export interface Params$Resource$Networkendpointgroups$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -46756,7 +47264,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Networkendpointgroups$Attachnetworkendpoints { + export interface Params$Resource$Networkendpointgroups$Attachnetworkendpoints + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -46795,7 +47304,8 @@ export namespace compute_beta { */ requestBody?: Schema$NetworkEndpointGroupsAttachEndpointsRequest; } - export interface Params$Resource$Networkendpointgroups$Delete { + export interface Params$Resource$Networkendpointgroups$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -46829,7 +47339,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Networkendpointgroups$Detachnetworkendpoints { + export interface Params$Resource$Networkendpointgroups$Detachnetworkendpoints + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -46868,7 +47379,8 @@ export namespace compute_beta { */ requestBody?: Schema$NetworkEndpointGroupsDetachEndpointsRequest; } - export interface Params$Resource$Networkendpointgroups$Get { + export interface Params$Resource$Networkendpointgroups$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -46888,7 +47400,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Networkendpointgroups$Insert { + export interface Params$Resource$Networkendpointgroups$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -46922,7 +47435,8 @@ export namespace compute_beta { */ requestBody?: Schema$NetworkEndpointGroup; } - export interface Params$Resource$Networkendpointgroups$List { + export interface Params$Resource$Networkendpointgroups$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -46981,7 +47495,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Networkendpointgroups$Listnetworkendpoints { + export interface Params$Resource$Networkendpointgroups$Listnetworkendpoints + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -47050,7 +47565,8 @@ export namespace compute_beta { */ requestBody?: Schema$NetworkEndpointGroupsListEndpointsRequest; } - export interface Params$Resource$Networkendpointgroups$Testiampermissions { + export interface Params$Resource$Networkendpointgroups$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -47061,7 +47577,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; /** @@ -48190,7 +48706,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -48255,7 +48771,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Networks$Addpeering { + export interface Params$Resource$Networks$Addpeering extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -48288,7 +48805,7 @@ export namespace compute_beta { */ requestBody?: Schema$NetworksAddPeeringRequest; } - export interface Params$Resource$Networks$Delete { + export interface Params$Resource$Networks$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -48316,7 +48833,7 @@ export namespace compute_beta { */ requestId?: string; } - export interface Params$Resource$Networks$Get { + export interface Params$Resource$Networks$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -48331,7 +48848,7 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Networks$Insert { + export interface Params$Resource$Networks$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -48360,7 +48877,7 @@ export namespace compute_beta { */ requestBody?: Schema$Network; } - export interface Params$Resource$Networks$List { + export interface Params$Resource$Networks$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -48414,7 +48931,7 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Networks$Patch { + export interface Params$Resource$Networks$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -48447,7 +48964,8 @@ export namespace compute_beta { */ requestBody?: Schema$Network; } - export interface Params$Resource$Networks$Removepeering { + export interface Params$Resource$Networks$Removepeering extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -48480,7 +48998,8 @@ export namespace compute_beta { */ requestBody?: Schema$NetworksRemovePeeringRequest; } - export interface Params$Resource$Networks$Switchtocustommode { + export interface Params$Resource$Networks$Switchtocustommode extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -48508,7 +49027,8 @@ export namespace compute_beta { */ requestId?: string; } - export interface Params$Resource$Networks$Testiampermissions { + export interface Params$Resource$Networks$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -48519,7 +49039,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -48911,7 +49431,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {string} params.zone The name of the zone for this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -49201,7 +49721,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {string} params.zone The name of the zone for this request. * @param {().ZoneSetPolicyRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -49345,7 +49865,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {string} params.zone The name of the zone for this request. * @param {().TestPermissionsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -49411,7 +49931,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Nodegroups$Addnodes { + export interface Params$Resource$Nodegroups$Addnodes extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -49448,7 +49969,8 @@ export namespace compute_beta { */ requestBody?: Schema$NodeGroupsAddNodesRequest; } - export interface Params$Resource$Nodegroups$Aggregatedlist { + export interface Params$Resource$Nodegroups$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -49502,7 +50024,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Nodegroups$Delete { + export interface Params$Resource$Nodegroups$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -49534,7 +50057,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Nodegroups$Deletenodes { + export interface Params$Resource$Nodegroups$Deletenodes extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -49571,7 +50095,7 @@ export namespace compute_beta { */ requestBody?: Schema$NodeGroupsDeleteNodesRequest; } - export interface Params$Resource$Nodegroups$Get { + export interface Params$Resource$Nodegroups$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -49590,7 +50114,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Nodegroups$Getiampolicy { + export interface Params$Resource$Nodegroups$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -49601,7 +50126,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; /** @@ -49609,7 +50134,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Nodegroups$Insert { + export interface Params$Resource$Nodegroups$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -49646,7 +50172,7 @@ export namespace compute_beta { */ requestBody?: Schema$NodeGroup; } - export interface Params$Resource$Nodegroups$List { + export interface Params$Resource$Nodegroups$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -49704,7 +50230,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Nodegroups$Listnodes { + export interface Params$Resource$Nodegroups$Listnodes extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -49766,7 +50293,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Nodegroups$Setiampolicy { + export interface Params$Resource$Nodegroups$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -49777,7 +50305,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; /** @@ -49790,7 +50318,8 @@ export namespace compute_beta { */ requestBody?: Schema$ZoneSetPolicyRequest; } - export interface Params$Resource$Nodegroups$Setnodetemplate { + export interface Params$Resource$Nodegroups$Setnodetemplate extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -49827,7 +50356,8 @@ export namespace compute_beta { */ requestBody?: Schema$NodeGroupsSetNodeTemplateRequest; } - export interface Params$Resource$Nodegroups$Testiampermissions { + export interface Params$Resource$Nodegroups$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -49838,7 +50368,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; /** @@ -50094,7 +50624,7 @@ export namespace compute_beta { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for 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 @@ -50312,7 +50842,7 @@ export namespace compute_beta { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().RegionSetPolicyRequest} 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. @@ -50383,7 +50913,7 @@ export namespace compute_beta { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -50448,7 +50978,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Nodetemplates$Aggregatedlist { + export interface Params$Resource$Nodetemplates$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -50502,7 +51033,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Nodetemplates$Delete { + export interface Params$Resource$Nodetemplates$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -50534,7 +51066,8 @@ export namespace compute_beta { */ requestId?: string; } - export interface Params$Resource$Nodetemplates$Get { + export interface Params$Resource$Nodetemplates$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -50553,7 +51086,8 @@ export namespace compute_beta { */ region?: string; } - export interface Params$Resource$Nodetemplates$Getiampolicy { + export interface Params$Resource$Nodetemplates$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -50568,11 +51102,12 @@ export namespace compute_beta { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; } - export interface Params$Resource$Nodetemplates$Insert { + export interface Params$Resource$Nodetemplates$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -50605,7 +51140,8 @@ export namespace compute_beta { */ requestBody?: Schema$NodeTemplate; } - export interface Params$Resource$Nodetemplates$List { + export interface Params$Resource$Nodetemplates$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -50663,7 +51199,8 @@ export namespace compute_beta { */ region?: string; } - export interface Params$Resource$Nodetemplates$Setiampolicy { + export interface Params$Resource$Nodetemplates$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -50678,7 +51215,7 @@ export namespace compute_beta { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -50687,7 +51224,8 @@ export namespace compute_beta { */ requestBody?: Schema$RegionSetPolicyRequest; } - export interface Params$Resource$Nodetemplates$Testiampermissions { + export interface Params$Resource$Nodetemplates$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -50702,7 +51240,7 @@ export namespace compute_beta { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -50936,7 +51474,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Nodetypes$Aggregatedlist { + export interface Params$Resource$Nodetypes$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -50990,7 +51529,7 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Nodetypes$Get { + export interface Params$Resource$Nodetypes$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -51009,7 +51548,7 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Nodetypes$List { + export interface Params$Resource$Nodetypes$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -52680,7 +53219,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Projects$Disablexpnhost { + export interface Params$Resource$Projects$Disablexpnhost extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -52704,7 +53244,8 @@ export namespace compute_beta { */ requestId?: string; } - export interface Params$Resource$Projects$Disablexpnresource { + export interface Params$Resource$Projects$Disablexpnresource extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -52733,7 +53274,8 @@ export namespace compute_beta { */ requestBody?: Schema$ProjectsDisableXpnResourceRequest; } - export interface Params$Resource$Projects$Enablexpnhost { + export interface Params$Resource$Projects$Enablexpnhost extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -52757,7 +53299,8 @@ export namespace compute_beta { */ requestId?: string; } - export interface Params$Resource$Projects$Enablexpnresource { + export interface Params$Resource$Projects$Enablexpnresource extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -52786,7 +53329,7 @@ export namespace compute_beta { */ requestBody?: Schema$ProjectsEnableXpnResourceRequest; } - export interface Params$Resource$Projects$Get { + export interface Params$Resource$Projects$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -52797,7 +53340,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Projects$Getxpnhost { + export interface Params$Resource$Projects$Getxpnhost extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -52808,7 +53352,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Projects$Getxpnresources { + export interface Params$Resource$Projects$Getxpnresources extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -52862,7 +53407,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Projects$Listxpnhosts { + export interface Params$Resource$Projects$Listxpnhosts extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -52921,7 +53467,8 @@ export namespace compute_beta { */ requestBody?: Schema$ProjectsListXpnHostsRequest; } - export interface Params$Resource$Projects$Movedisk { + export interface Params$Resource$Projects$Movedisk extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -52950,7 +53497,8 @@ export namespace compute_beta { */ requestBody?: Schema$DiskMoveRequest; } - export interface Params$Resource$Projects$Moveinstance { + export interface Params$Resource$Projects$Moveinstance extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -52979,7 +53527,8 @@ export namespace compute_beta { */ requestBody?: Schema$InstanceMoveRequest; } - export interface Params$Resource$Projects$Setcommoninstancemetadata { + export interface Params$Resource$Projects$Setcommoninstancemetadata extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -53008,7 +53557,8 @@ export namespace compute_beta { */ requestBody?: Schema$Metadata; } - export interface Params$Resource$Projects$Setdefaultnetworktier { + export interface Params$Resource$Projects$Setdefaultnetworktier extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -53037,7 +53587,8 @@ export namespace compute_beta { */ requestBody?: Schema$ProjectsSetDefaultNetworkTierRequest; } - export interface Params$Resource$Projects$Setusageexportbucket { + export interface Params$Resource$Projects$Setusageexportbucket extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -53822,7 +54373,7 @@ export namespace compute_beta { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -54023,7 +54574,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Regionautoscalers$Delete { + export interface Params$Resource$Regionautoscalers$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -54055,7 +54607,8 @@ export namespace compute_beta { */ requestId?: string; } - export interface Params$Resource$Regionautoscalers$Get { + export interface Params$Resource$Regionautoscalers$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -54074,7 +54627,8 @@ export namespace compute_beta { */ region?: string; } - export interface Params$Resource$Regionautoscalers$Insert { + export interface Params$Resource$Regionautoscalers$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -54107,7 +54661,8 @@ export namespace compute_beta { */ requestBody?: Schema$Autoscaler; } - export interface Params$Resource$Regionautoscalers$List { + export interface Params$Resource$Regionautoscalers$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -54165,7 +54720,8 @@ export namespace compute_beta { */ region?: string; } - export interface Params$Resource$Regionautoscalers$Patch { + export interface Params$Resource$Regionautoscalers$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -54202,7 +54758,8 @@ export namespace compute_beta { */ requestBody?: Schema$Autoscaler; } - export interface Params$Resource$Regionautoscalers$Testiampermissions { + export interface Params$Resource$Regionautoscalers$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -54217,7 +54774,7 @@ export namespace compute_beta { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -54226,7 +54783,8 @@ export namespace compute_beta { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Regionautoscalers$Update { + export interface Params$Resource$Regionautoscalers$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -55167,7 +55725,7 @@ export namespace compute_beta { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -55375,7 +55933,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Regionbackendservices$Delete { + export interface Params$Resource$Regionbackendservices$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -55407,7 +55966,8 @@ export namespace compute_beta { */ requestId?: string; } - export interface Params$Resource$Regionbackendservices$Get { + export interface Params$Resource$Regionbackendservices$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -55426,7 +55986,8 @@ export namespace compute_beta { */ region?: string; } - export interface Params$Resource$Regionbackendservices$Gethealth { + export interface Params$Resource$Regionbackendservices$Gethealth extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -55450,7 +56011,8 @@ export namespace compute_beta { */ requestBody?: Schema$ResourceGroupReference; } - export interface Params$Resource$Regionbackendservices$Insert { + export interface Params$Resource$Regionbackendservices$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -55483,7 +56045,8 @@ export namespace compute_beta { */ requestBody?: Schema$BackendService; } - export interface Params$Resource$Regionbackendservices$List { + export interface Params$Resource$Regionbackendservices$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -55541,7 +56104,8 @@ export namespace compute_beta { */ region?: string; } - export interface Params$Resource$Regionbackendservices$Patch { + export interface Params$Resource$Regionbackendservices$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -55578,7 +56142,8 @@ export namespace compute_beta { */ requestBody?: Schema$BackendService; } - export interface Params$Resource$Regionbackendservices$Testiampermissions { + export interface Params$Resource$Regionbackendservices$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -55593,7 +56158,7 @@ export namespace compute_beta { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -55602,7 +56167,8 @@ export namespace compute_beta { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Regionbackendservices$Update { + export interface Params$Resource$Regionbackendservices$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -56198,7 +56764,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Regioncommitments$Aggregatedlist { + export interface Params$Resource$Regioncommitments$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -56252,7 +56819,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Regioncommitments$Get { + export interface Params$Resource$Regioncommitments$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -56271,7 +56839,8 @@ export namespace compute_beta { */ region?: string; } - export interface Params$Resource$Regioncommitments$Insert { + export interface Params$Resource$Regioncommitments$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -56304,7 +56873,8 @@ export namespace compute_beta { */ requestBody?: Schema$Commitment; } - export interface Params$Resource$Regioncommitments$List { + export interface Params$Resource$Regioncommitments$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -57037,7 +57607,7 @@ export namespace compute_beta { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -57102,7 +57672,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Regiondisks$Addresourcepolicies { + export interface Params$Resource$Regiondisks$Addresourcepolicies extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -57139,7 +57710,8 @@ export namespace compute_beta { */ requestBody?: Schema$RegionDisksAddResourcePoliciesRequest; } - export interface Params$Resource$Regiondisks$Createsnapshot { + export interface Params$Resource$Regiondisks$Createsnapshot extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -57176,7 +57748,8 @@ export namespace compute_beta { */ requestBody?: Schema$Snapshot; } - export interface Params$Resource$Regiondisks$Delete { + export interface Params$Resource$Regiondisks$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -57208,7 +57781,7 @@ export namespace compute_beta { */ requestId?: string; } - export interface Params$Resource$Regiondisks$Get { + export interface Params$Resource$Regiondisks$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -57227,7 +57800,8 @@ export namespace compute_beta { */ region?: string; } - export interface Params$Resource$Regiondisks$Insert { + export interface Params$Resource$Regiondisks$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -57264,7 +57838,7 @@ export namespace compute_beta { */ requestBody?: Schema$Disk; } - export interface Params$Resource$Regiondisks$List { + export interface Params$Resource$Regiondisks$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -57322,7 +57896,8 @@ export namespace compute_beta { */ region?: string; } - export interface Params$Resource$Regiondisks$Removeresourcepolicies { + export interface Params$Resource$Regiondisks$Removeresourcepolicies extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -57359,7 +57934,8 @@ export namespace compute_beta { */ requestBody?: Schema$RegionDisksRemoveResourcePoliciesRequest; } - export interface Params$Resource$Regiondisks$Resize { + export interface Params$Resource$Regiondisks$Resize extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -57396,7 +57972,8 @@ export namespace compute_beta { */ requestBody?: Schema$RegionDisksResizeRequest; } - export interface Params$Resource$Regiondisks$Setlabels { + export interface Params$Resource$Regiondisks$Setlabels extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -57433,7 +58010,8 @@ export namespace compute_beta { */ requestBody?: Schema$RegionSetLabelsRequest; } - export interface Params$Resource$Regiondisks$Testiampermissions { + export interface Params$Resource$Regiondisks$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -57448,7 +58026,7 @@ export namespace compute_beta { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -57613,7 +58191,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Regiondisktypes$Get { + export interface Params$Resource$Regiondisktypes$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -57632,7 +58211,8 @@ export namespace compute_beta { */ region?: string; } - export interface Params$Resource$Regiondisktypes$List { + export interface Params$Resource$Regiondisktypes$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -57706,7 +58286,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.abandonInstances - * @desc Schedules a group action to remove the specified instances from the + * @desc Flags the specified instances to be immediately removed from the * managed instance group. Abandoning an instance does not delete the * instance, but it does remove the instance from any target pools that are * applied by the managed instance group. This method reduces the targetSize @@ -57986,17 +58566,18 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.deleteInstances - * @desc Schedules a group action to delete the specified instances in the - * managed instance group. The instances are also removed from any target - * pools of which they were a member. This method reduces the targetSize of - * the managed instance group by the number of instances that you delete. - * This operation is marked as DONE when the action is scheduled even if the - * instances are still being deleted. You must separately verify the status - * of the deleting action with the listmanagedinstances method. If the - * group is part of a backend service that has enabled connection draining, - * it can take up to 60 seconds after the connection draining duration has - * elapsed before the VM instance is removed or deleted. You can specify a - * maximum of 1000 instances with this method per request. + * @desc Flags the specified instances in the managed instance group to be + * immediately deleted. The instances are also removed from any target pools + * of which they were a member. This method reduces the targetSize of the + * managed instance group by the number of instances that you delete. The + * deleteInstances operation is marked DONE if the deleteInstances request + * is successful. The underlying actions take additional time. You must + * separately verify the status of the deleting action with the + * listmanagedinstances method. If the group is part of a backend service + * that has enabled connection draining, it can take up to 60 seconds after + * the connection draining duration has elapsed before the VM instance is + * removed or deleted. You can specify a maximum of 1000 instances with + * this method per request. * @example * * // BEFORE RUNNING: * // --------------- @@ -58261,13 +58842,12 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.insert * @desc Creates a managed instance group using the information that you - * specify in the request. After the group is created, it schedules an - * action to create instances in the group using the specified instance - * template. This operation is marked as DONE when the group is created even - * if the instances in the group have not yet been created. You must - * separately verify the status of the individual instances with the - * listmanagedinstances method. A regional managed instance group can - * contain up to 2000 instances. + * specify in the request. After the group is created, instances in the + * group are created using the specified instance template. This operation + * is marked as DONE when the group is created even if the instances in the + * group have not yet been created. You must separately verify the status of + * the individual instances with the listmanagedinstances method. A + * regional managed instance group can contain up to 2000 instances. * @example * * // BEFORE RUNNING: * // --------------- @@ -58861,16 +59441,16 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.recreateInstances - * @desc Schedules a group action to recreate the specified instances in the - * managed instance group. The instances are deleted and recreated using the + * @desc Flags the specified instances in the managed instance group to be + * immediately recreated. The instances are deleted and recreated using the * current instance template for the managed instance group. This operation - * is marked as DONE when the action is scheduled even if the instances have - * not yet been recreated. You must separately verify the status of the - * recreating action with the listmanagedinstances method. If the group is - * part of a backend service that has enabled connection draining, it can - * take up to 60 seconds after the connection draining duration has elapsed - * before the VM instance is removed or deleted. You can specify a maximum - * of 1000 instances with this method per request. + * is marked as DONE when the flag is set even if the instances have not yet + * been recreated. You must separately verify the status of the recreating + * action with the listmanagedinstances method. If the group is part of a + * backend service that has enabled connection draining, it can take up to + * 60 seconds after the connection draining duration has elapsed before the + * VM instance is removed or deleted. You can specify a maximum of 1000 + * instances with this method per request. * @example * * // BEFORE RUNNING: * // --------------- @@ -59007,17 +59587,16 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.resize - * @desc Changes the intended size for the managed instance group. If you - * increase the size, the group schedules actions to create new instances - * using the current instance template. If you decrease the size, the group - * schedules delete actions on one or more instances. The resize operation - * is marked DONE when the resize actions are scheduled even if the group - * has not yet added or deleted any instances. You must separately verify - * the status of the creating or deleting actions with the - * listmanagedinstances method. If the group is part of a backend service - * that has enabled connection draining, it can take up to 60 seconds after - * the connection draining duration has elapsed before the VM instance is - * removed or deleted. + * @desc Changes the intended size of the managed instance group. If you + * increase the size, the group creates new instances using the current + * instance template. If you decrease the size, the group deletes one or + * more instances. The resize operation is marked DONE if the resize + * request is successful. The underlying actions take additional time. You + * must separately verify the status of the creating or deleting actions + * with the listmanagedinstances method. If the group is part of a backend + * service that has enabled connection draining, it can take up to 60 + * seconds after the connection draining duration has elapsed before the VM + * instance is removed or deleted. * @example * * // BEFORE RUNNING: * // --------------- @@ -59638,7 +60217,7 @@ export namespace compute_beta { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -59846,7 +60425,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Regioninstancegroupmanagers$Abandoninstances { + export interface Params$Resource$Regioninstancegroupmanagers$Abandoninstances + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -59883,7 +60463,8 @@ export namespace compute_beta { */ requestBody?: Schema$RegionInstanceGroupManagersAbandonInstancesRequest; } - export interface Params$Resource$Regioninstancegroupmanagers$Delete { + export interface Params$Resource$Regioninstancegroupmanagers$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -59915,7 +60496,8 @@ export namespace compute_beta { */ requestId?: string; } - export interface Params$Resource$Regioninstancegroupmanagers$Deleteinstances { + export interface Params$Resource$Regioninstancegroupmanagers$Deleteinstances + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -59952,7 +60534,8 @@ export namespace compute_beta { */ requestBody?: Schema$RegionInstanceGroupManagersDeleteInstancesRequest; } - export interface Params$Resource$Regioninstancegroupmanagers$Get { + export interface Params$Resource$Regioninstancegroupmanagers$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -59971,7 +60554,8 @@ export namespace compute_beta { */ region?: string; } - export interface Params$Resource$Regioninstancegroupmanagers$Insert { + export interface Params$Resource$Regioninstancegroupmanagers$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -60004,7 +60588,8 @@ export namespace compute_beta { */ requestBody?: Schema$InstanceGroupManager; } - export interface Params$Resource$Regioninstancegroupmanagers$List { + export interface Params$Resource$Regioninstancegroupmanagers$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -60062,7 +60647,8 @@ export namespace compute_beta { */ region?: string; } - export interface Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances { + export interface Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -60124,7 +60710,8 @@ export namespace compute_beta { */ region?: string; } - export interface Params$Resource$Regioninstancegroupmanagers$Patch { + export interface Params$Resource$Regioninstancegroupmanagers$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -60161,7 +60748,8 @@ export namespace compute_beta { */ requestBody?: Schema$InstanceGroupManager; } - export interface Params$Resource$Regioninstancegroupmanagers$Recreateinstances { + export interface Params$Resource$Regioninstancegroupmanagers$Recreateinstances + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -60198,7 +60786,8 @@ export namespace compute_beta { */ requestBody?: Schema$RegionInstanceGroupManagersRecreateRequest; } - export interface Params$Resource$Regioninstancegroupmanagers$Resize { + export interface Params$Resource$Regioninstancegroupmanagers$Resize extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -60234,7 +60823,8 @@ export namespace compute_beta { */ size?: number; } - export interface Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies { + export interface Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -60271,7 +60861,8 @@ export namespace compute_beta { */ requestBody?: Schema$RegionInstanceGroupManagersSetAutoHealingRequest; } - export interface Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate { + export interface Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -60308,7 +60899,8 @@ export namespace compute_beta { */ requestBody?: Schema$RegionInstanceGroupManagersSetTemplateRequest; } - export interface Params$Resource$Regioninstancegroupmanagers$Settargetpools { + export interface Params$Resource$Regioninstancegroupmanagers$Settargetpools + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -60345,7 +60937,8 @@ export namespace compute_beta { */ requestBody?: Schema$RegionInstanceGroupManagersSetTargetPoolsRequest; } - export interface Params$Resource$Regioninstancegroupmanagers$Testiampermissions { + export interface Params$Resource$Regioninstancegroupmanagers$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -60360,7 +60953,7 @@ export namespace compute_beta { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -60369,7 +60962,8 @@ export namespace compute_beta { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Regioninstancegroupmanagers$Update { + export interface Params$Resource$Regioninstancegroupmanagers$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -61065,7 +61659,7 @@ export namespace compute_beta { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -61131,7 +61725,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Regioninstancegroups$Get { + export interface Params$Resource$Regioninstancegroups$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -61150,7 +61745,8 @@ export namespace compute_beta { */ region?: string; } - export interface Params$Resource$Regioninstancegroups$List { + export interface Params$Resource$Regioninstancegroups$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -61208,7 +61804,8 @@ export namespace compute_beta { */ region?: string; } - export interface Params$Resource$Regioninstancegroups$Listinstances { + export interface Params$Resource$Regioninstancegroups$Listinstances extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -61276,7 +61873,8 @@ export namespace compute_beta { */ requestBody?: Schema$RegionInstanceGroupsListInstancesRequest; } - export interface Params$Resource$Regioninstancegroups$Setnamedports { + export interface Params$Resource$Regioninstancegroups$Setnamedports extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -61314,7 +61912,8 @@ export namespace compute_beta { */ requestBody?: Schema$RegionInstanceGroupsSetNamedPortsRequest; } - export interface Params$Resource$Regioninstancegroups$Testiampermissions { + export interface Params$Resource$Regioninstancegroups$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -61329,7 +61928,7 @@ export namespace compute_beta { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -61747,7 +62346,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Regionoperations$Delete { + export interface Params$Resource$Regionoperations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -61766,7 +62366,8 @@ export namespace compute_beta { */ region?: string; } - export interface Params$Resource$Regionoperations$Get { + export interface Params$Resource$Regionoperations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -61785,7 +62386,8 @@ export namespace compute_beta { */ region?: string; } - export interface Params$Resource$Regionoperations$List { + export interface Params$Resource$Regionoperations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -62113,7 +62715,7 @@ export namespace compute_beta { } } - export interface Params$Resource$Regions$Get { + export interface Params$Resource$Regions$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -62128,7 +62730,7 @@ export namespace compute_beta { */ region?: string; } - export interface Params$Resource$Regions$List { + export interface Params$Resource$Regions$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -62572,7 +63174,7 @@ export namespace compute_beta { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -62637,7 +63239,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Resourcepolicies$Aggregatedlist { + export interface Params$Resource$Resourcepolicies$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -62691,7 +63294,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Resourcepolicies$Delete { + export interface Params$Resource$Resourcepolicies$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -62723,7 +63327,8 @@ export namespace compute_beta { */ resourcePolicy?: string; } - export interface Params$Resource$Resourcepolicies$Get { + export interface Params$Resource$Resourcepolicies$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -62742,7 +63347,8 @@ export namespace compute_beta { */ resourcePolicy?: string; } - export interface Params$Resource$Resourcepolicies$Insert { + export interface Params$Resource$Resourcepolicies$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -62775,7 +63381,8 @@ export namespace compute_beta { */ requestBody?: Schema$ResourcePolicy; } - export interface Params$Resource$Resourcepolicies$List { + export interface Params$Resource$Resourcepolicies$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -62833,7 +63440,8 @@ export namespace compute_beta { */ region?: string; } - export interface Params$Resource$Resourcepolicies$Testiampermissions { + export interface Params$Resource$Resourcepolicies$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -62848,7 +63456,7 @@ export namespace compute_beta { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -64094,7 +64702,7 @@ export namespace compute_beta { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -64296,7 +64904,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Routers$Aggregatedlist { + export interface Params$Resource$Routers$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -64350,7 +64959,7 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Routers$Delete { + export interface Params$Resource$Routers$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -64382,7 +64991,7 @@ export namespace compute_beta { */ router?: string; } - export interface Params$Resource$Routers$Get { + export interface Params$Resource$Routers$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -64401,7 +65010,8 @@ export namespace compute_beta { */ router?: string; } - export interface Params$Resource$Routers$Getnatmappinginfo { + export interface Params$Resource$Routers$Getnatmappinginfo extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -64464,7 +65074,8 @@ export namespace compute_beta { */ router?: string; } - export interface Params$Resource$Routers$Getrouterstatus { + export interface Params$Resource$Routers$Getrouterstatus extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -64483,7 +65094,7 @@ export namespace compute_beta { */ router?: string; } - export interface Params$Resource$Routers$Insert { + export interface Params$Resource$Routers$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -64516,7 +65127,7 @@ export namespace compute_beta { */ requestBody?: Schema$Router; } - export interface Params$Resource$Routers$List { + export interface Params$Resource$Routers$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -64574,7 +65185,7 @@ export namespace compute_beta { */ region?: string; } - export interface Params$Resource$Routers$Patch { + export interface Params$Resource$Routers$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -64611,7 +65222,7 @@ export namespace compute_beta { */ requestBody?: Schema$Router; } - export interface Params$Resource$Routers$Preview { + export interface Params$Resource$Routers$Preview extends StandardParameters { /** * Auth client or API Key for the request */ @@ -64635,7 +65246,8 @@ export namespace compute_beta { */ requestBody?: Schema$Router; } - export interface Params$Resource$Routers$Testiampermissions { + export interface Params$Resource$Routers$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -64650,7 +65262,7 @@ export namespace compute_beta { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -64659,7 +65271,7 @@ export namespace compute_beta { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Routers$Update { + export interface Params$Resource$Routers$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -65283,7 +65895,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -65348,7 +65960,7 @@ export namespace compute_beta { } } - export interface Params$Resource$Routes$Delete { + export interface Params$Resource$Routes$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -65376,7 +65988,7 @@ export namespace compute_beta { */ route?: string; } - export interface Params$Resource$Routes$Get { + export interface Params$Resource$Routes$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -65391,7 +66003,7 @@ export namespace compute_beta { */ route?: string; } - export interface Params$Resource$Routes$Insert { + export interface Params$Resource$Routes$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -65420,7 +66032,7 @@ export namespace compute_beta { */ requestBody?: Schema$Route; } - export interface Params$Resource$Routes$List { + export interface Params$Resource$Routes$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -65474,7 +66086,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Routes$Testiampermissions { + export interface Params$Resource$Routes$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -65485,7 +66098,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -66683,7 +67296,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -66748,7 +67361,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Securitypolicies$Addrule { + export interface Params$Resource$Securitypolicies$Addrule extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -66772,7 +67386,8 @@ export namespace compute_beta { */ requestBody?: Schema$SecurityPolicyRule; } - export interface Params$Resource$Securitypolicies$Delete { + export interface Params$Resource$Securitypolicies$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -66800,7 +67415,8 @@ export namespace compute_beta { */ securityPolicy?: string; } - export interface Params$Resource$Securitypolicies$Get { + export interface Params$Resource$Securitypolicies$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -66815,7 +67431,8 @@ export namespace compute_beta { */ securityPolicy?: string; } - export interface Params$Resource$Securitypolicies$Getrule { + export interface Params$Resource$Securitypolicies$Getrule extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -66834,7 +67451,8 @@ export namespace compute_beta { */ securityPolicy?: string; } - export interface Params$Resource$Securitypolicies$Insert { + export interface Params$Resource$Securitypolicies$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -66867,7 +67485,8 @@ export namespace compute_beta { */ requestBody?: Schema$SecurityPolicy; } - export interface Params$Resource$Securitypolicies$List { + export interface Params$Resource$Securitypolicies$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -66921,7 +67540,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Securitypolicies$Listpreconfiguredexpressionsets { + export interface Params$Resource$Securitypolicies$Listpreconfiguredexpressionsets + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -66975,7 +67595,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Securitypolicies$Patch { + export interface Params$Resource$Securitypolicies$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -67008,7 +67629,8 @@ export namespace compute_beta { */ requestBody?: Schema$SecurityPolicy; } - export interface Params$Resource$Securitypolicies$Patchrule { + export interface Params$Resource$Securitypolicies$Patchrule extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -67036,7 +67658,8 @@ export namespace compute_beta { */ requestBody?: Schema$SecurityPolicyRule; } - export interface Params$Resource$Securitypolicies$Removerule { + export interface Params$Resource$Securitypolicies$Removerule extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -67055,7 +67678,8 @@ export namespace compute_beta { */ securityPolicy?: string; } - export interface Params$Resource$Securitypolicies$Setlabels { + export interface Params$Resource$Securitypolicies$Setlabels extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -67075,7 +67699,8 @@ export namespace compute_beta { */ requestBody?: Schema$GlobalSetLabelsRequest; } - export interface Params$Resource$Securitypolicies$Testiampermissions { + export interface Params$Resource$Securitypolicies$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -67086,7 +67711,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -67368,7 +67993,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for 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 @@ -67575,7 +68200,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().GlobalSetPolicyRequest} 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. @@ -67837,7 +68462,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -67902,7 +68527,7 @@ export namespace compute_beta { } } - export interface Params$Resource$Snapshots$Delete { + export interface Params$Resource$Snapshots$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -67930,7 +68555,7 @@ export namespace compute_beta { */ snapshot?: string; } - export interface Params$Resource$Snapshots$Get { + export interface Params$Resource$Snapshots$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -67945,7 +68570,8 @@ export namespace compute_beta { */ snapshot?: string; } - export interface Params$Resource$Snapshots$Getiampolicy { + export interface Params$Resource$Snapshots$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -67956,11 +68582,11 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; } - export interface Params$Resource$Snapshots$List { + export interface Params$Resource$Snapshots$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -68014,7 +68640,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Snapshots$Setiampolicy { + export interface Params$Resource$Snapshots$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -68025,7 +68652,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -68034,7 +68661,8 @@ export namespace compute_beta { */ requestBody?: Schema$GlobalSetPolicyRequest; } - export interface Params$Resource$Snapshots$Setlabels { + export interface Params$Resource$Snapshots$Setlabels extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -68054,7 +68682,8 @@ export namespace compute_beta { */ requestBody?: Schema$GlobalSetLabelsRequest; } - export interface Params$Resource$Snapshots$Testiampermissions { + export interface Params$Resource$Snapshots$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -68065,7 +68694,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -68673,7 +69302,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -68738,7 +69367,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Sslcertificates$Delete { + export interface Params$Resource$Sslcertificates$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -68766,7 +69396,8 @@ export namespace compute_beta { */ sslCertificate?: string; } - export interface Params$Resource$Sslcertificates$Get { + export interface Params$Resource$Sslcertificates$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -68781,7 +69412,8 @@ export namespace compute_beta { */ sslCertificate?: string; } - export interface Params$Resource$Sslcertificates$Insert { + export interface Params$Resource$Sslcertificates$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -68810,7 +69442,8 @@ export namespace compute_beta { */ requestBody?: Schema$SslCertificate; } - export interface Params$Resource$Sslcertificates$List { + export interface Params$Resource$Sslcertificates$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -68864,7 +69497,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Sslcertificates$Testiampermissions { + export interface Params$Resource$Sslcertificates$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -68875,7 +69509,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -69342,7 +69976,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -69407,7 +70041,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Sslpolicies$Delete { + export interface Params$Resource$Sslpolicies$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -69436,7 +70071,7 @@ export namespace compute_beta { */ sslPolicy?: string; } - export interface Params$Resource$Sslpolicies$Get { + export interface Params$Resource$Sslpolicies$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -69452,7 +70087,8 @@ export namespace compute_beta { */ sslPolicy?: string; } - export interface Params$Resource$Sslpolicies$Insert { + export interface Params$Resource$Sslpolicies$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -69481,7 +70117,7 @@ export namespace compute_beta { */ requestBody?: Schema$SslPolicy; } - export interface Params$Resource$Sslpolicies$List { + export interface Params$Resource$Sslpolicies$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -69535,7 +70171,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Sslpolicies$Listavailablefeatures { + export interface Params$Resource$Sslpolicies$Listavailablefeatures extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -69589,7 +70226,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Sslpolicies$Patch { + export interface Params$Resource$Sslpolicies$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -69623,7 +70261,8 @@ export namespace compute_beta { */ requestBody?: Schema$SslPolicy; } - export interface Params$Resource$Sslpolicies$Testiampermissions { + export interface Params$Resource$Sslpolicies$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -69634,7 +70273,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -70258,7 +70897,7 @@ export namespace compute_beta { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for 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 @@ -70889,7 +71528,7 @@ export namespace compute_beta { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().RegionSetPolicyRequest} 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. @@ -71157,7 +71796,7 @@ export namespace compute_beta { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -71222,7 +71861,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Subnetworks$Aggregatedlist { + export interface Params$Resource$Subnetworks$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -71276,7 +71916,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Subnetworks$Delete { + export interface Params$Resource$Subnetworks$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -71308,7 +71949,8 @@ export namespace compute_beta { */ subnetwork?: string; } - export interface Params$Resource$Subnetworks$Expandipcidrrange { + export interface Params$Resource$Subnetworks$Expandipcidrrange extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -71345,7 +71987,7 @@ export namespace compute_beta { */ requestBody?: Schema$SubnetworksExpandIpCidrRangeRequest; } - export interface Params$Resource$Subnetworks$Get { + export interface Params$Resource$Subnetworks$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -71364,7 +72006,8 @@ export namespace compute_beta { */ subnetwork?: string; } - export interface Params$Resource$Subnetworks$Getiampolicy { + export interface Params$Resource$Subnetworks$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -71379,11 +72022,12 @@ export namespace compute_beta { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; } - export interface Params$Resource$Subnetworks$Insert { + export interface Params$Resource$Subnetworks$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -71416,7 +72060,7 @@ export namespace compute_beta { */ requestBody?: Schema$Subnetwork; } - export interface Params$Resource$Subnetworks$List { + export interface Params$Resource$Subnetworks$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -71474,7 +72118,8 @@ export namespace compute_beta { */ region?: string; } - export interface Params$Resource$Subnetworks$Listusable { + export interface Params$Resource$Subnetworks$Listusable extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -71528,7 +72173,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Subnetworks$Patch { + export interface Params$Resource$Subnetworks$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -71565,7 +72211,8 @@ export namespace compute_beta { */ requestBody?: Schema$Subnetwork; } - export interface Params$Resource$Subnetworks$Setiampolicy { + export interface Params$Resource$Subnetworks$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -71580,7 +72227,7 @@ export namespace compute_beta { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -71589,7 +72236,8 @@ export namespace compute_beta { */ requestBody?: Schema$RegionSetPolicyRequest; } - export interface Params$Resource$Subnetworks$Setprivateipgoogleaccess { + export interface Params$Resource$Subnetworks$Setprivateipgoogleaccess extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -71626,7 +72274,8 @@ export namespace compute_beta { */ requestBody?: Schema$SubnetworksSetPrivateIpGoogleAccessRequest; } - export interface Params$Resource$Subnetworks$Testiampermissions { + export interface Params$Resource$Subnetworks$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -71641,7 +72290,7 @@ export namespace compute_beta { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -72382,7 +73031,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -72447,7 +73096,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Targethttpproxies$Delete { + export interface Params$Resource$Targethttpproxies$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -72475,7 +73125,8 @@ export namespace compute_beta { */ targetHttpProxy?: string; } - export interface Params$Resource$Targethttpproxies$Get { + export interface Params$Resource$Targethttpproxies$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -72490,7 +73141,8 @@ export namespace compute_beta { */ targetHttpProxy?: string; } - export interface Params$Resource$Targethttpproxies$Insert { + export interface Params$Resource$Targethttpproxies$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -72519,7 +73171,8 @@ export namespace compute_beta { */ requestBody?: Schema$TargetHttpProxy; } - export interface Params$Resource$Targethttpproxies$List { + export interface Params$Resource$Targethttpproxies$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -72573,7 +73226,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Targethttpproxies$Seturlmap { + export interface Params$Resource$Targethttpproxies$Seturlmap extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -72606,7 +73260,8 @@ export namespace compute_beta { */ requestBody?: Schema$UrlMapReference; } - export interface Params$Resource$Targethttpproxies$Testiampermissions { + export interface Params$Resource$Targethttpproxies$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -72617,7 +73272,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -73640,7 +74295,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -73706,7 +74361,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Targethttpsproxies$Delete { + export interface Params$Resource$Targethttpsproxies$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -73734,7 +74390,8 @@ export namespace compute_beta { */ targetHttpsProxy?: string; } - export interface Params$Resource$Targethttpsproxies$Get { + export interface Params$Resource$Targethttpsproxies$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -73749,7 +74406,8 @@ export namespace compute_beta { */ targetHttpsProxy?: string; } - export interface Params$Resource$Targethttpsproxies$Insert { + export interface Params$Resource$Targethttpsproxies$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -73778,7 +74436,8 @@ export namespace compute_beta { */ requestBody?: Schema$TargetHttpsProxy; } - export interface Params$Resource$Targethttpsproxies$List { + export interface Params$Resource$Targethttpsproxies$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -73832,7 +74491,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Targethttpsproxies$Setquicoverride { + export interface Params$Resource$Targethttpsproxies$Setquicoverride extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -73866,7 +74526,8 @@ export namespace compute_beta { */ requestBody?: Schema$TargetHttpsProxiesSetQuicOverrideRequest; } - export interface Params$Resource$Targethttpsproxies$Setsslcertificates { + export interface Params$Resource$Targethttpsproxies$Setsslcertificates extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -73900,7 +74561,8 @@ export namespace compute_beta { */ requestBody?: Schema$TargetHttpsProxiesSetSslCertificatesRequest; } - export interface Params$Resource$Targethttpsproxies$Setsslpolicy { + export interface Params$Resource$Targethttpsproxies$Setsslpolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -73934,7 +74596,8 @@ export namespace compute_beta { */ requestBody?: Schema$SslPolicyReference; } - export interface Params$Resource$Targethttpsproxies$Seturlmap { + export interface Params$Resource$Targethttpsproxies$Seturlmap extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -73967,7 +74630,8 @@ export namespace compute_beta { */ requestBody?: Schema$UrlMapReference; } - export interface Params$Resource$Targethttpsproxies$Testiampermissions { + export interface Params$Resource$Targethttpsproxies$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -73978,7 +74642,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -74755,7 +75419,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {string} params.zone The name of the zone for this request. * @param {().TestPermissionsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -74821,7 +75485,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Targetinstances$Aggregatedlist { + export interface Params$Resource$Targetinstances$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -74875,7 +75540,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Targetinstances$Delete { + export interface Params$Resource$Targetinstances$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -74907,7 +75573,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Targetinstances$Get { + export interface Params$Resource$Targetinstances$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -74926,7 +75593,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Targetinstances$Insert { + export interface Params$Resource$Targetinstances$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -74959,7 +75627,8 @@ export namespace compute_beta { */ requestBody?: Schema$TargetInstance; } - export interface Params$Resource$Targetinstances$List { + export interface Params$Resource$Targetinstances$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -75017,7 +75686,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Targetinstances$Testiampermissions { + export interface Params$Resource$Targetinstances$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -75028,7 +75698,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; /** @@ -76616,7 +77286,7 @@ export namespace compute_beta { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -76681,7 +77351,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Targetpools$Addhealthcheck { + export interface Params$Resource$Targetpools$Addhealthcheck extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -76718,7 +77389,8 @@ export namespace compute_beta { */ requestBody?: Schema$TargetPoolsAddHealthCheckRequest; } - export interface Params$Resource$Targetpools$Addinstance { + export interface Params$Resource$Targetpools$Addinstance extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -76755,7 +77427,8 @@ export namespace compute_beta { */ requestBody?: Schema$TargetPoolsAddInstanceRequest; } - export interface Params$Resource$Targetpools$Aggregatedlist { + export interface Params$Resource$Targetpools$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -76809,7 +77482,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Targetpools$Delete { + export interface Params$Resource$Targetpools$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -76841,7 +77515,7 @@ export namespace compute_beta { */ targetPool?: string; } - export interface Params$Resource$Targetpools$Get { + export interface Params$Resource$Targetpools$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -76860,7 +77534,8 @@ export namespace compute_beta { */ targetPool?: string; } - export interface Params$Resource$Targetpools$Gethealth { + export interface Params$Resource$Targetpools$Gethealth extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -76884,7 +77559,8 @@ export namespace compute_beta { */ requestBody?: Schema$InstanceReference; } - export interface Params$Resource$Targetpools$Insert { + export interface Params$Resource$Targetpools$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -76917,7 +77593,7 @@ export namespace compute_beta { */ requestBody?: Schema$TargetPool; } - export interface Params$Resource$Targetpools$List { + export interface Params$Resource$Targetpools$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -76975,7 +77651,8 @@ export namespace compute_beta { */ region?: string; } - export interface Params$Resource$Targetpools$Removehealthcheck { + export interface Params$Resource$Targetpools$Removehealthcheck extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -77012,7 +77689,8 @@ export namespace compute_beta { */ requestBody?: Schema$TargetPoolsRemoveHealthCheckRequest; } - export interface Params$Resource$Targetpools$Removeinstance { + export interface Params$Resource$Targetpools$Removeinstance extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -77049,7 +77727,8 @@ export namespace compute_beta { */ requestBody?: Schema$TargetPoolsRemoveInstanceRequest; } - export interface Params$Resource$Targetpools$Setbackup { + export interface Params$Resource$Targetpools$Setbackup extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -77090,7 +77769,8 @@ export namespace compute_beta { */ requestBody?: Schema$TargetReference; } - export interface Params$Resource$Targetpools$Testiampermissions { + export interface Params$Resource$Targetpools$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -77105,7 +77785,7 @@ export namespace compute_beta { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -78181,7 +78861,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -78246,7 +78926,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Targetsslproxies$Delete { + export interface Params$Resource$Targetsslproxies$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -78274,7 +78955,8 @@ export namespace compute_beta { */ targetSslProxy?: string; } - export interface Params$Resource$Targetsslproxies$Get { + export interface Params$Resource$Targetsslproxies$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -78289,7 +78971,8 @@ export namespace compute_beta { */ targetSslProxy?: string; } - export interface Params$Resource$Targetsslproxies$Insert { + export interface Params$Resource$Targetsslproxies$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -78318,7 +79001,8 @@ export namespace compute_beta { */ requestBody?: Schema$TargetSslProxy; } - export interface Params$Resource$Targetsslproxies$List { + export interface Params$Resource$Targetsslproxies$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -78372,7 +79056,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Targetsslproxies$Setbackendservice { + export interface Params$Resource$Targetsslproxies$Setbackendservice extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -78406,7 +79091,8 @@ export namespace compute_beta { */ requestBody?: Schema$TargetSslProxiesSetBackendServiceRequest; } - export interface Params$Resource$Targetsslproxies$Setproxyheader { + export interface Params$Resource$Targetsslproxies$Setproxyheader extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -78439,7 +79125,8 @@ export namespace compute_beta { */ requestBody?: Schema$TargetSslProxiesSetProxyHeaderRequest; } - export interface Params$Resource$Targetsslproxies$Setsslcertificates { + export interface Params$Resource$Targetsslproxies$Setsslcertificates extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -78473,7 +79160,8 @@ export namespace compute_beta { */ requestBody?: Schema$TargetSslProxiesSetSslCertificatesRequest; } - export interface Params$Resource$Targetsslproxies$Setsslpolicy { + export interface Params$Resource$Targetsslproxies$Setsslpolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -78507,7 +79195,8 @@ export namespace compute_beta { */ requestBody?: Schema$SslPolicyReference; } - export interface Params$Resource$Targetsslproxies$Testiampermissions { + export interface Params$Resource$Targetsslproxies$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -78518,7 +79207,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -79322,7 +80011,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Targettcpproxies$Delete { + export interface Params$Resource$Targettcpproxies$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -79350,7 +80040,8 @@ export namespace compute_beta { */ targetTcpProxy?: string; } - export interface Params$Resource$Targettcpproxies$Get { + export interface Params$Resource$Targettcpproxies$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -79365,7 +80056,8 @@ export namespace compute_beta { */ targetTcpProxy?: string; } - export interface Params$Resource$Targettcpproxies$Insert { + export interface Params$Resource$Targettcpproxies$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -79394,7 +80086,8 @@ export namespace compute_beta { */ requestBody?: Schema$TargetTcpProxy; } - export interface Params$Resource$Targettcpproxies$List { + export interface Params$Resource$Targettcpproxies$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -79448,7 +80141,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Targettcpproxies$Setbackendservice { + export interface Params$Resource$Targettcpproxies$Setbackendservice extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -79482,7 +80176,8 @@ export namespace compute_beta { */ requestBody?: Schema$TargetTcpProxiesSetBackendServiceRequest; } - export interface Params$Resource$Targettcpproxies$Setproxyheader { + export interface Params$Resource$Targettcpproxies$Setproxyheader extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -80359,7 +81054,7 @@ export namespace compute_beta { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -80424,7 +81119,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Targetvpngateways$Aggregatedlist { + export interface Params$Resource$Targetvpngateways$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -80478,7 +81174,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Targetvpngateways$Delete { + export interface Params$Resource$Targetvpngateways$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -80510,7 +81207,8 @@ export namespace compute_beta { */ targetVpnGateway?: string; } - export interface Params$Resource$Targetvpngateways$Get { + export interface Params$Resource$Targetvpngateways$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -80529,7 +81227,8 @@ export namespace compute_beta { */ targetVpnGateway?: string; } - export interface Params$Resource$Targetvpngateways$Insert { + export interface Params$Resource$Targetvpngateways$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -80562,7 +81261,8 @@ export namespace compute_beta { */ requestBody?: Schema$TargetVpnGateway; } - export interface Params$Resource$Targetvpngateways$List { + export interface Params$Resource$Targetvpngateways$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -80620,7 +81320,8 @@ export namespace compute_beta { */ region?: string; } - export interface Params$Resource$Targetvpngateways$Setlabels { + export interface Params$Resource$Targetvpngateways$Setlabels extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -80657,7 +81358,8 @@ export namespace compute_beta { */ requestBody?: Schema$RegionSetLabelsRequest; } - export interface Params$Resource$Targetvpngateways$Testiampermissions { + export interface Params$Resource$Targetvpngateways$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -80672,7 +81374,7 @@ export namespace compute_beta { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -81534,7 +82236,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -81865,7 +82567,7 @@ export namespace compute_beta { } } - export interface Params$Resource$Urlmaps$Delete { + export interface Params$Resource$Urlmaps$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -81893,7 +82595,7 @@ export namespace compute_beta { */ urlMap?: string; } - export interface Params$Resource$Urlmaps$Get { + export interface Params$Resource$Urlmaps$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -81908,7 +82610,7 @@ export namespace compute_beta { */ urlMap?: string; } - export interface Params$Resource$Urlmaps$Insert { + export interface Params$Resource$Urlmaps$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -81937,7 +82639,8 @@ export namespace compute_beta { */ requestBody?: Schema$UrlMap; } - export interface Params$Resource$Urlmaps$Invalidatecache { + export interface Params$Resource$Urlmaps$Invalidatecache extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -81970,7 +82673,7 @@ export namespace compute_beta { */ requestBody?: Schema$CacheInvalidationRule; } - export interface Params$Resource$Urlmaps$List { + export interface Params$Resource$Urlmaps$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -82024,7 +82727,7 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Urlmaps$Patch { + export interface Params$Resource$Urlmaps$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -82057,7 +82760,8 @@ export namespace compute_beta { */ requestBody?: Schema$UrlMap; } - export interface Params$Resource$Urlmaps$Testiampermissions { + export interface Params$Resource$Urlmaps$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -82068,7 +82772,7 @@ export namespace compute_beta { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -82077,7 +82781,7 @@ export namespace compute_beta { */ requestBody?: Schema$TestPermissionsRequest; } - export interface Params$Resource$Urlmaps$Update { + export interface Params$Resource$Urlmaps$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -82110,7 +82814,7 @@ export namespace compute_beta { */ requestBody?: Schema$UrlMap; } - export interface Params$Resource$Urlmaps$Validate { + export interface Params$Resource$Urlmaps$Validate extends StandardParameters { /** * Auth client or API Key for the request */ @@ -82959,7 +83663,7 @@ export namespace compute_beta { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -83024,7 +83728,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Vpntunnels$Aggregatedlist { + export interface Params$Resource$Vpntunnels$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -83078,7 +83783,8 @@ export namespace compute_beta { */ project?: string; } - export interface Params$Resource$Vpntunnels$Delete { + export interface Params$Resource$Vpntunnels$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -83110,7 +83816,7 @@ export namespace compute_beta { */ vpnTunnel?: string; } - export interface Params$Resource$Vpntunnels$Get { + export interface Params$Resource$Vpntunnels$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -83129,7 +83835,8 @@ export namespace compute_beta { */ vpnTunnel?: string; } - export interface Params$Resource$Vpntunnels$Insert { + export interface Params$Resource$Vpntunnels$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -83162,7 +83869,7 @@ export namespace compute_beta { */ requestBody?: Schema$VpnTunnel; } - export interface Params$Resource$Vpntunnels$List { + export interface Params$Resource$Vpntunnels$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -83220,7 +83927,8 @@ export namespace compute_beta { */ region?: string; } - export interface Params$Resource$Vpntunnels$Setlabels { + export interface Params$Resource$Vpntunnels$Setlabels extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -83257,7 +83965,8 @@ export namespace compute_beta { */ requestBody?: Schema$RegionSetLabelsRequest; } - export interface Params$Resource$Vpntunnels$Testiampermissions { + export interface Params$Resource$Vpntunnels$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -83272,7 +83981,7 @@ export namespace compute_beta { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -83688,7 +84397,8 @@ export namespace compute_beta { } } - export interface Params$Resource$Zoneoperations$Delete { + export interface Params$Resource$Zoneoperations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -83707,7 +84417,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Zoneoperations$Get { + export interface Params$Resource$Zoneoperations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -83726,7 +84437,8 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Zoneoperations$List { + export interface Params$Resource$Zoneoperations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -84052,7 +84764,7 @@ export namespace compute_beta { } } - export interface Params$Resource$Zones$Get { + export interface Params$Resource$Zones$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -84067,7 +84779,7 @@ export namespace compute_beta { */ zone?: string; } - export interface Params$Resource$Zones$List { + export interface Params$Resource$Zones$List extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/compute/v1.ts b/src/apis/compute/v1.ts index adcf4602e6..faf19ea85e 100644 --- a/src/apis/compute/v1.ts +++ b/src/apis/compute/v1.ts @@ -29,6 +29,40 @@ export namespace compute_v1 { version: 'v1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Compute Engine API * @@ -999,14 +1033,21 @@ export namespace compute_v1 { */ description?: string; /** - * The fully-qualified URL of a Instance Group resource. This instance group - * defines the list of instances that serve traffic. Member virtual machine - * instances from each instance group must live in the same zone as the - * instance group itself. No two backends in a backend service are allowed - * to use same Instance Group resource. Note that you must specify an - * Instance Group resource using the fully-qualified URL, rather than a + * The fully-qualified URL of an Instance Group or Network Endpoint Group + * resource. In case of instance group this defines the list of instances + * that serve traffic. Member virtual machine instances from each instance + * group must live in the same zone as the instance group itself. No two + * backends in a backend service are allowed to use same Instance Group + * resource. For Network Endpoint Groups this defines list of endpoints. + * All endpoints of Network Endpoint Group must be hosted on instances + * located in the same zone as the Network Endpoint Group. Backend service + * can not contain mix of Instance Group and Network Endpoint Group + * backends. Note that you must specify an Instance Group or Network + * Endpoint Group resource using the fully-qualified URL, rather than a * partial URL. When the BackendService has load balancing scheme INTERNAL, * the instance group must be within the same region as the BackendService. + * Network Endpoint Groups are not supported for INTERNAL load balancing + * scheme. */ group?: string; /** @@ -1335,6 +1376,10 @@ export namespace compute_v1 { signedUrlKeyNames?: string[]; } export interface Schema$BackendServiceGroupHealth { + /** + * Health state of the backend instances or endpoints in requested instance + * or network endpoint group, determined based on configured health checks. + */ healthStatus?: Schema$HealthStatus[]; /** * [Output Only] Type of resource. Always compute#backendServiceGroupHealth @@ -3700,6 +3745,12 @@ export namespace compute_v1 { * are scheduled to be restarted or are currently being restarted. */ restarting?: number; + /** + * [Output Only] The number of instances in the managed instance group that + * are being verified. See the managedInstances[].currentAction property in + * the listManagedInstances method documentation. + */ + verifying?: number; } export interface Schema$InstanceGroupManagerAggregatedList { /** @@ -4645,6 +4696,77 @@ export namespace compute_v1 { */ googleDemarcId?: string; } + /** + * Diagnostics information about interconnect, contains detailed and current + * technical information about Google?s side of the connection. + */ + export interface Schema$InterconnectDiagnostics { + /** + * A list of InterconnectDiagnostics.ARPEntry objects, describing individual + * neighbors currently seen by the Google router in the ARP cache for the + * Interconnect. This will be empty when the Interconnect is not bundled. + */ + arpCaches?: Schema$InterconnectDiagnosticsARPEntry[]; + /** + * A list of InterconnectDiagnostics.LinkStatus objects, describing the + * status for each link on the Interconnect. + */ + links?: Schema$InterconnectDiagnosticsLinkStatus[]; + /** + * The MAC address of the Interconnect's bundle interface. + */ + macAddress?: string; + } + /** + * Describing the ARP neighbor entries seen on this link + */ + export interface Schema$InterconnectDiagnosticsARPEntry { + /** + * The IP address of this ARP neighbor. + */ + ipAddress?: string; + /** + * The MAC address of this ARP neighbor. + */ + macAddress?: string; + } + export interface Schema$InterconnectDiagnosticsLinkLACPStatus { + /** + * System ID of the port on Google?s side of the LACP exchange. + */ + googleSystemId?: string; + /** + * System ID of the port on the neighbor?s side of the LACP exchange. + */ + neighborSystemId?: string; + state?: string; + } + export interface Schema$InterconnectDiagnosticsLinkOpticalPower { + state?: string; + /** + * Value of the current optical power, read in dBm. + */ + value?: number; + } + export interface Schema$InterconnectDiagnosticsLinkStatus { + /** + * A list of InterconnectDiagnostics.ARPEntry objects, describing the ARP + * neighbor entries seen on this link. This will be empty if the link is + * bundled + */ + arpCaches?: Schema$InterconnectDiagnosticsARPEntry[]; + /** + * The unique ID for this link assigned during turn up by Google. + */ + circuitId?: string; + /** + * The Demarc address assigned by Google and provided in the LoA. + */ + googleDemarc?: string; + lacpStatus?: Schema$InterconnectDiagnosticsLinkLACPStatus; + receivingOpticalPower?: Schema$InterconnectDiagnosticsLinkOpticalPower; + transmittingOpticalPower?: Schema$InterconnectDiagnosticsLinkOpticalPower; + } /** * Response to the list request, and contains a list of interconnects. */ @@ -4852,6 +4974,12 @@ export namespace compute_v1 { */ state?: string; } + /** + * Response for the InterconnectsGetDiagnosticsRequest. + */ + export interface Schema$InterconnectsGetDiagnosticsResponse { + result?: Schema$InterconnectDiagnostics; + } /** * A license resource. */ @@ -5700,7 +5828,7 @@ export namespace compute_v1 { * with RFC1035. Specifically, the name must be 1-63 characters long and * match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the * first character must be a lowercase letter, and all following characters - * must be a dash, lowercase letter, or digit, except the last charaicter, + * must be a dash, lowercase letter, or digit, except the last character, * which cannot be a dash. */ name?: string; @@ -6170,12 +6298,19 @@ export namespace compute_v1 { export interface Schema$PathMatcher { /** * The full or partial URL to the BackendService resource. This will be used - * if none of the pathRules defined by this PathMatcher is matched by the - * URL's path portion. For example, the following are all valid URLs to - * a BackendService resource: - + * if none of the pathRules or routeRules defined by this PathMatcher are + * matched. For example, the following are all valid URLs to a + * BackendService resource: - * https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService * - compute/v1/projects/project/global/backendServices/backendService - - * global/backendServices/backendService + * global/backendServices/backendService Use defaultService instead of + * defaultRouteAction when simple routing to a backend service is desired + * and other advanced capabilities like traffic splitting and URL rewrites + * are not required. Only one of defaultService, defaultRouteAction or + * defaultUrlRedirect must be set. Authorization requires one or more of the + * following Google IAM permissions on the specified resource + * default_service: - compute.backendBuckets.use - + * compute.backendServices.use */ defaultService?: string; /** @@ -6188,7 +6323,13 @@ export namespace compute_v1 { */ name?: string; /** - * The list of path rules. + * The list of path rules. Use this list instead of routeRules when routing + * based on simple path matching is all that's required. The order by + * which path rules are specified does not matter. Matches are always done + * on the longest-path-first basis. For example: a pathRule with a path + * /a/b/c/* will match before /a/b/* irrespective of the order in which + * those paths appear in this list. Only one of pathRules or routeRules must + * be set. */ pathRules?: Schema$PathRule[]; } @@ -6205,7 +6346,11 @@ export namespace compute_v1 { */ paths?: string[]; /** - * The URL of the BackendService resource if this rule is matched. + * The URL of the backend service resource if this rule is matched. Use + * service instead of routeAction when simple routing to a backend service + * is desired and other advanced capabilities like traffic splitting and + * rewrites are not required. Only one of service, routeAction or + * urlRedirect should must be set. */ service?: string; } @@ -6724,8 +6869,8 @@ export namespace compute_v1 { } export interface Schema$ResourceGroupReference { /** - * A URI referencing one of the instance groups listed in the backend - * service. + * A URI referencing one of the instance groups or network endpoint groups + * listed in the backend service. */ group?: string; } @@ -6917,6 +7062,10 @@ export namespace compute_v1 { * dash. */ name?: string; + /** + * A list of Nat services created in this router. + */ + nats?: Schema$RouterNat[]; /** * URI of the network to which this router belongs. */ @@ -7135,6 +7284,92 @@ export namespace compute_v1 { */ warning?: any; } + /** + * Represents a Nat resource. It enables the VMs within the specified + * subnetworks to access Internet without external IP addresses. It specifies + * a list of subnetworks (and the ranges within) that want to use NAT. + * Customers can also provide the external IPs that would be used for NAT. GCP + * would auto-allocate ephemeral IPs if no external IPs are provided. + */ + export interface Schema$RouterNat { + /** + * Timeout (in seconds) for ICMP connections. Defaults to 30s if not set. + */ + icmpIdleTimeoutSec?: number; + /** + * Minimum number of ports allocated to a VM from this NAT config. If not + * set, a default number of ports is allocated to a VM. This gets rounded up + * to the nearest power of 2. Eg. if the value of this field is 50, at least + * 64 ports will be allocated to a VM. + */ + minPortsPerVm?: number; + /** + * Unique name of this Nat service. The name must be 1-63 characters long + * and comply with RFC1035. + */ + name?: string; + /** + * Specify the NatIpAllocateOption. If it is AUTO_ONLY, then nat_ip should + * be empty. + */ + natIpAllocateOption?: string; + /** + * A list of URLs of the IP resources used for this Nat service. These IPs + * must be valid static external IP addresses assigned to the project. + * max_length is subject to change post alpha. + */ + natIps?: string[]; + /** + * Specify the Nat option. If this field contains + * ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, + * then there should not be any other Router.Nat section in any Router for + * this network in this region. + */ + sourceSubnetworkIpRangesToNat?: string; + /** + * A list of Subnetwork resources whose traffic should be translated by NAT + * Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the + * SubnetworkIpRangeToNatOption above. + */ + subnetworks?: Schema$RouterNatSubnetworkToNat[]; + /** + * Timeout (in seconds) for TCP established connections. Defaults to 1200s + * if not set. + */ + tcpEstablishedIdleTimeoutSec?: number; + /** + * Timeout (in seconds) for TCP transitory connections. Defaults to 30s if + * not set. + */ + tcpTransitoryIdleTimeoutSec?: number; + /** + * Timeout (in seconds) for UDP connections. Defaults to 30s if not set. + */ + udpIdleTimeoutSec?: number; + } + /** + * Defines the IP ranges that want to use NAT for a subnetwork. + */ + export interface Schema$RouterNatSubnetworkToNat { + /** + * URL for the subnetwork resource to use NAT. + */ + name?: string; + /** + * A list of the secondary ranges of the Subnetwork that are allowed to use + * NAT. This can be populated only if + * "LIST_OF_SECONDARY_IP_RANGES" is one of the values in + * source_ip_ranges_to_nat. + */ + secondaryIpRangeNames?: string[]; + /** + * Specify the options for NAT ranges in the Subnetwork. All usages of + * single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only + * valid option with multiple values is: ["PRIMARY_IP_RANGE", + * "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES] + */ + sourceIpRangesToNat?: string[]; + } export interface Schema$RoutersPreviewResponse { /** * Preview of given router. @@ -7162,6 +7397,7 @@ export namespace compute_v1 { */ bestRoutesForRouter?: Schema$Route[]; bgpPeerStatus?: Schema$RouterStatusBgpPeerStatus[]; + natStatus?: Schema$RouterStatusNatStatus[]; /** * URI of the network to which this router belongs. */ @@ -7210,6 +7446,40 @@ export namespace compute_v1 { */ uptimeSeconds?: string; } + /** + * Status of a NAT contained in this router. + */ + export interface Schema$RouterStatusNatStatus { + /** + * A list of IPs auto-allocated for NAT. Example: ["1.1.1.1", + * "129.2.16.89"] + */ + autoAllocatedNatIps?: string[]; + /** + * The number of extra IPs to allocate. This will be greater than 0 only if + * user-specified IPs are NOT enough to allow all configured VMs to use NAT. + * This value is meaningful only when auto-allocation of NAT IPs is *not* + * used. + */ + minExtraNatIpsNeeded?: number; + /** + * Unique name of this NAT. + */ + name?: string; + /** + * Number of VM endpoints (i.e., Nics) that can use NAT. + */ + numVmEndpointsWithNatMappings?: number; + /** + * A list of fully qualified URLs of reserved IP address resources. + */ + userAllocatedNatIpResources?: string[]; + /** + * A list of IPs user-allocated for NAT. They will be raw IP strings like + * "179.12.26.133". + */ + userAllocatedNatIps?: string[]; + } export interface Schema$RouterStatusResponse { /** * Type of resource. @@ -8230,8 +8500,9 @@ export namespace compute_v1 { selfLink?: string; /** * URLs to SslCertificate resources that are used to authenticate - * connections between users and the load balancer. Currently, exactly one - * SSL certificate must be specified. + * connections between users and the load balancer. At least one SSL + * certificate must be specified. Currently, you may specify up to 15 SSL + * certificates. */ sslCertificates?: string[]; /** @@ -8504,7 +8775,7 @@ export namespace compute_v1 { */ selfLink?: string; /** - * Sesssion affinity option, must be one of the following values: NONE: + * Session affinity option, must be one of the following values: NONE: * Connections from the same client IP may go to any instance in the pool. * CLIENT_IP: Connections from the same client IP will go to the same * instance in the pool while that instance remains healthy. @@ -8703,8 +8974,8 @@ export namespace compute_v1 { service?: string; /** * URLs to SslCertificate resources that are used to authenticate - * connections to Backends. Currently exactly one SSL certificate must be - * specified. + * connections to Backends. At least one SSL certificate must be specified. + * Currently, you may specify up to 15 SSL certificates. */ sslCertificates?: string[]; /** @@ -9046,7 +9317,11 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * The URL of the BackendService resource if none of the hostRules match. + * The URL of the backendService resource if none of the hostRules match. + * Use defaultService instead of defaultRouteAction when simple routing to a + * backendService is desired and other advanced capabilities like traffic + * splitting and rewrites are not required. Only one of defaultService, + * defaultRouteAction or defaultUrlRedirect should must be set. */ defaultService?: string; /** @@ -9277,6 +9552,78 @@ export namespace compute_v1 { */ reportNamePrefix?: string; } + /** + * Contain information of Nat mapping for a VM endpoint (i.e., NIC). + */ + export interface Schema$VmEndpointNatMappings { + /** + * Name of the VM instance which the endpoint belongs to + */ + instanceName?: string; + interfaceNatMappings?: Schema$VmEndpointNatMappingsInterfaceNatMappings[]; + } + /** + * Contain information of Nat mapping for an interface of this endpoint. + */ + export interface Schema$VmEndpointNatMappingsInterfaceNatMappings { + /** + * A list of all IP:port-range mappings assigned to this interface. These + * ranges are inclusive, that is, both the first and the last ports can be + * used for NAT. Example: ["2.2.2.2:12345-12355", + * "1.1.1.1:2234-2234"]. + */ + natIpPortRanges?: string[]; + /** + * Total number of ports across all NAT IPs allocated to this interface. It + * equals to the aggregated port number in the field nat_ip_port_ranges. + */ + numTotalNatPorts?: number; + /** + * Alias IP range for this interface endpoint. It will be a private (RFC + * 1918) IP range. Examples: "10.33.4.55/32", or + * "192.168.5.0/24". + */ + sourceAliasIpRange?: string; + /** + * Primary IP of the VM for this NIC. + */ + sourceVirtualIp?: string; + } + /** + * Contains a list of VmEndpointNatMappings. + */ + export interface Schema$VmEndpointNatMappingsList { + /** + * [Output Only] The unique identifier for the resource. This identifier is + * defined by the server. + */ + id?: string; + /** + * [Output Only] Type of resource. Always compute#vmEndpointNatMappingsList + * for lists of Nat mappings of VM endpoints. + */ + kind?: string; + /** + * [Output Only] This token allows you to get the next page of results for + * list requests. If the number of results is larger than maxResults, use + * the nextPageToken as a value for the query parameter pageToken in the + * next list request. Subsequent list requests will have their own + * nextPageToken to continue paging through the results. + */ + nextPageToken?: string; + /** + * [Output Only] A list of Nat mapping information of VM endpoints. + */ + result?: Schema$VmEndpointNatMappings[]; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string; + /** + * [Output Only] Informational warning message. + */ + warning?: any; + } /** * VPN tunnel resource. (== resource_for beta.vpnTunnels ==) (== resource_for * v1.vpnTunnels ==) @@ -10017,7 +10364,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Acceleratortypes$Aggregatedlist { + export interface Params$Resource$Acceleratortypes$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10071,7 +10419,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Acceleratortypes$Get { + export interface Params$Resource$Acceleratortypes$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10090,7 +10439,8 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Acceleratortypes$List { + export interface Params$Resource$Acceleratortypes$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10827,7 +11177,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Addresses$Aggregatedlist { + export interface Params$Resource$Addresses$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10881,7 +11232,7 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Addresses$Delete { + export interface Params$Resource$Addresses$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -10913,7 +11264,7 @@ export namespace compute_v1 { */ requestId?: string; } - export interface Params$Resource$Addresses$Get { + export interface Params$Resource$Addresses$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -10932,7 +11283,7 @@ export namespace compute_v1 { */ region?: string; } - export interface Params$Resource$Addresses$Insert { + export interface Params$Resource$Addresses$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -10965,7 +11316,7 @@ export namespace compute_v1 { */ requestBody?: Schema$Address; } - export interface Params$Resource$Addresses$List { + export interface Params$Resource$Addresses$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11978,7 +12329,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Autoscalers$Aggregatedlist { + export interface Params$Resource$Autoscalers$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12032,7 +12384,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Autoscalers$Delete { + export interface Params$Resource$Autoscalers$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12064,7 +12417,7 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Autoscalers$Get { + export interface Params$Resource$Autoscalers$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -12083,7 +12436,8 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Autoscalers$Insert { + export interface Params$Resource$Autoscalers$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12116,7 +12470,7 @@ export namespace compute_v1 { */ requestBody?: Schema$Autoscaler; } - export interface Params$Resource$Autoscalers$List { + export interface Params$Resource$Autoscalers$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -12174,7 +12528,8 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Autoscalers$Patch { + export interface Params$Resource$Autoscalers$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12211,7 +12566,8 @@ export namespace compute_v1 { */ requestBody?: Schema$Autoscaler; } - export interface Params$Resource$Autoscalers$Update { + export interface Params$Resource$Autoscalers$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13199,7 +13555,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Backendbuckets$Addsignedurlkey { + export interface Params$Resource$Backendbuckets$Addsignedurlkey extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13233,7 +13590,8 @@ export namespace compute_v1 { */ requestBody?: Schema$SignedUrlKey; } - export interface Params$Resource$Backendbuckets$Delete { + export interface Params$Resource$Backendbuckets$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13261,7 +13619,8 @@ export namespace compute_v1 { */ requestId?: string; } - export interface Params$Resource$Backendbuckets$Deletesignedurlkey { + export interface Params$Resource$Backendbuckets$Deletesignedurlkey extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13294,7 +13653,8 @@ export namespace compute_v1 { */ requestId?: string; } - export interface Params$Resource$Backendbuckets$Get { + export interface Params$Resource$Backendbuckets$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13309,7 +13669,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Backendbuckets$Insert { + export interface Params$Resource$Backendbuckets$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13338,7 +13699,8 @@ export namespace compute_v1 { */ requestBody?: Schema$BackendBucket; } - export interface Params$Resource$Backendbuckets$List { + export interface Params$Resource$Backendbuckets$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13392,7 +13754,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Backendbuckets$Patch { + export interface Params$Resource$Backendbuckets$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13425,7 +13788,8 @@ export namespace compute_v1 { */ requestBody?: Schema$BackendBucket; } - export interface Params$Resource$Backendbuckets$Update { + export interface Params$Resource$Backendbuckets$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14771,7 +15135,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Backendservices$Addsignedurlkey { + export interface Params$Resource$Backendservices$Addsignedurlkey extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14805,7 +15170,8 @@ export namespace compute_v1 { */ requestBody?: Schema$SignedUrlKey; } - export interface Params$Resource$Backendservices$Aggregatedlist { + export interface Params$Resource$Backendservices$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14859,7 +15225,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Backendservices$Delete { + export interface Params$Resource$Backendservices$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14887,7 +15254,8 @@ export namespace compute_v1 { */ requestId?: string; } - export interface Params$Resource$Backendservices$Deletesignedurlkey { + export interface Params$Resource$Backendservices$Deletesignedurlkey extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14920,7 +15288,8 @@ export namespace compute_v1 { */ requestId?: string; } - export interface Params$Resource$Backendservices$Get { + export interface Params$Resource$Backendservices$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14935,7 +15304,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Backendservices$Gethealth { + export interface Params$Resource$Backendservices$Gethealth extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14956,7 +15326,8 @@ export namespace compute_v1 { */ requestBody?: Schema$ResourceGroupReference; } - export interface Params$Resource$Backendservices$Insert { + export interface Params$Resource$Backendservices$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14985,7 +15356,8 @@ export namespace compute_v1 { */ requestBody?: Schema$BackendService; } - export interface Params$Resource$Backendservices$List { + export interface Params$Resource$Backendservices$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15039,7 +15411,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Backendservices$Patch { + export interface Params$Resource$Backendservices$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15072,7 +15445,8 @@ export namespace compute_v1 { */ requestBody?: Schema$BackendService; } - export interface Params$Resource$Backendservices$Setsecuritypolicy { + export interface Params$Resource$Backendservices$Setsecuritypolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15106,7 +15480,8 @@ export namespace compute_v1 { */ requestBody?: Schema$SecurityPolicyReference; } - export interface Params$Resource$Backendservices$Update { + export interface Params$Resource$Backendservices$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -16229,7 +16604,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Disks$Aggregatedlist { + export interface Params$Resource$Disks$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -16283,7 +16659,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Disks$Createsnapshot { + export interface Params$Resource$Disks$Createsnapshot extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -16324,7 +16701,7 @@ export namespace compute_v1 { */ requestBody?: Schema$Snapshot; } - export interface Params$Resource$Disks$Delete { + export interface Params$Resource$Disks$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -16356,7 +16733,7 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Disks$Get { + export interface Params$Resource$Disks$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -16375,7 +16752,7 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Disks$Insert { + export interface Params$Resource$Disks$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -16412,7 +16789,7 @@ export namespace compute_v1 { */ requestBody?: Schema$Disk; } - export interface Params$Resource$Disks$List { + export interface Params$Resource$Disks$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -16470,7 +16847,7 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Disks$Resize { + export interface Params$Resource$Disks$Resize extends StandardParameters { /** * Auth client or API Key for the request */ @@ -16507,7 +16884,7 @@ export namespace compute_v1 { */ requestBody?: Schema$DisksResizeRequest; } - export interface Params$Resource$Disks$Setlabels { + export interface Params$Resource$Disks$Setlabels extends StandardParameters { /** * Auth client or API Key for the request */ @@ -16964,7 +17341,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Disktypes$Aggregatedlist { + export interface Params$Resource$Disktypes$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17018,7 +17396,7 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Disktypes$Get { + export interface Params$Resource$Disktypes$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -17037,7 +17415,7 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Disktypes$List { + export interface Params$Resource$Disktypes$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -17883,7 +18261,7 @@ export namespace compute_v1 { } } - export interface Params$Resource$Firewalls$Delete { + export interface Params$Resource$Firewalls$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -17911,7 +18289,7 @@ export namespace compute_v1 { */ requestId?: string; } - export interface Params$Resource$Firewalls$Get { + export interface Params$Resource$Firewalls$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -17926,7 +18304,7 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Firewalls$Insert { + export interface Params$Resource$Firewalls$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -17955,7 +18333,7 @@ export namespace compute_v1 { */ requestBody?: Schema$Firewall; } - export interface Params$Resource$Firewalls$List { + export interface Params$Resource$Firewalls$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -18009,7 +18387,7 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Firewalls$Patch { + export interface Params$Resource$Firewalls$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -18042,7 +18420,7 @@ export namespace compute_v1 { */ requestBody?: Schema$Firewall; } - export interface Params$Resource$Firewalls$Update { + export interface Params$Resource$Firewalls$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -18910,7 +19288,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Forwardingrules$Aggregatedlist { + export interface Params$Resource$Forwardingrules$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18964,7 +19343,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Forwardingrules$Delete { + export interface Params$Resource$Forwardingrules$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18996,7 +19376,8 @@ export namespace compute_v1 { */ requestId?: string; } - export interface Params$Resource$Forwardingrules$Get { + export interface Params$Resource$Forwardingrules$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19015,7 +19396,8 @@ export namespace compute_v1 { */ region?: string; } - export interface Params$Resource$Forwardingrules$Insert { + export interface Params$Resource$Forwardingrules$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19048,7 +19430,8 @@ export namespace compute_v1 { */ requestBody?: Schema$ForwardingRule; } - export interface Params$Resource$Forwardingrules$List { + export interface Params$Resource$Forwardingrules$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19106,7 +19489,8 @@ export namespace compute_v1 { */ region?: string; } - export interface Params$Resource$Forwardingrules$Settarget { + export interface Params$Resource$Forwardingrules$Settarget extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19668,7 +20052,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Globaladdresses$Delete { + export interface Params$Resource$Globaladdresses$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19696,7 +20081,8 @@ export namespace compute_v1 { */ requestId?: string; } - export interface Params$Resource$Globaladdresses$Get { + export interface Params$Resource$Globaladdresses$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19711,7 +20097,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Globaladdresses$Insert { + export interface Params$Resource$Globaladdresses$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19740,7 +20127,8 @@ export namespace compute_v1 { */ requestBody?: Schema$Address; } - export interface Params$Resource$Globaladdresses$List { + export interface Params$Resource$Globaladdresses$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -20459,7 +20847,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Globalforwardingrules$Delete { + export interface Params$Resource$Globalforwardingrules$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -20487,7 +20876,8 @@ export namespace compute_v1 { */ requestId?: string; } - export interface Params$Resource$Globalforwardingrules$Get { + export interface Params$Resource$Globalforwardingrules$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -20502,7 +20892,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Globalforwardingrules$Insert { + export interface Params$Resource$Globalforwardingrules$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -20531,7 +20922,8 @@ export namespace compute_v1 { */ requestBody?: Schema$ForwardingRule; } - export interface Params$Resource$Globalforwardingrules$List { + export interface Params$Resource$Globalforwardingrules$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -20585,7 +20977,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Globalforwardingrules$Settarget { + export interface Params$Resource$Globalforwardingrules$Settarget extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -21156,7 +21549,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Globaloperations$Aggregatedlist { + export interface Params$Resource$Globaloperations$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -21210,7 +21604,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Globaloperations$Delete { + export interface Params$Resource$Globaloperations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -21225,7 +21620,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Globaloperations$Get { + export interface Params$Resource$Globaloperations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -21240,7 +21636,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Globaloperations$List { + export interface Params$Resource$Globaloperations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22093,7 +22490,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Healthchecks$Delete { + export interface Params$Resource$Healthchecks$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22121,7 +22519,7 @@ export namespace compute_v1 { */ requestId?: string; } - export interface Params$Resource$Healthchecks$Get { + export interface Params$Resource$Healthchecks$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -22136,7 +22534,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Healthchecks$Insert { + export interface Params$Resource$Healthchecks$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22165,7 +22564,8 @@ export namespace compute_v1 { */ requestBody?: Schema$HealthCheck; } - export interface Params$Resource$Healthchecks$List { + export interface Params$Resource$Healthchecks$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22219,7 +22619,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Healthchecks$Patch { + export interface Params$Resource$Healthchecks$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22252,7 +22653,8 @@ export namespace compute_v1 { */ requestBody?: Schema$HealthCheck; } - export interface Params$Resource$Healthchecks$Update { + export interface Params$Resource$Healthchecks$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23091,7 +23493,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Httphealthchecks$Delete { + export interface Params$Resource$Httphealthchecks$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23119,7 +23522,8 @@ export namespace compute_v1 { */ requestId?: string; } - export interface Params$Resource$Httphealthchecks$Get { + export interface Params$Resource$Httphealthchecks$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23134,7 +23538,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Httphealthchecks$Insert { + export interface Params$Resource$Httphealthchecks$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23163,7 +23568,8 @@ export namespace compute_v1 { */ requestBody?: Schema$HttpHealthCheck; } - export interface Params$Resource$Httphealthchecks$List { + export interface Params$Resource$Httphealthchecks$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23217,7 +23623,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Httphealthchecks$Patch { + export interface Params$Resource$Httphealthchecks$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23250,7 +23657,8 @@ export namespace compute_v1 { */ requestBody?: Schema$HttpHealthCheck; } - export interface Params$Resource$Httphealthchecks$Update { + export interface Params$Resource$Httphealthchecks$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -24090,7 +24498,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Httpshealthchecks$Delete { + export interface Params$Resource$Httpshealthchecks$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -24118,7 +24527,8 @@ export namespace compute_v1 { */ requestId?: string; } - export interface Params$Resource$Httpshealthchecks$Get { + export interface Params$Resource$Httpshealthchecks$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -24133,7 +24543,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Httpshealthchecks$Insert { + export interface Params$Resource$Httpshealthchecks$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -24162,7 +24573,8 @@ export namespace compute_v1 { */ requestBody?: Schema$HttpsHealthCheck; } - export interface Params$Resource$Httpshealthchecks$List { + export interface Params$Resource$Httpshealthchecks$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -24216,7 +24628,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Httpshealthchecks$Patch { + export interface Params$Resource$Httpshealthchecks$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -24249,7 +24662,8 @@ export namespace compute_v1 { */ requestBody?: Schema$HttpsHealthCheck; } - export interface Params$Resource$Httpshealthchecks$Update { + export interface Params$Resource$Httpshealthchecks$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -25195,7 +25609,7 @@ export namespace compute_v1 { } } - export interface Params$Resource$Images$Delete { + export interface Params$Resource$Images$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -25223,7 +25637,7 @@ export namespace compute_v1 { */ requestId?: string; } - export interface Params$Resource$Images$Deprecate { + export interface Params$Resource$Images$Deprecate extends StandardParameters { /** * Auth client or API Key for the request */ @@ -25256,7 +25670,7 @@ export namespace compute_v1 { */ requestBody?: Schema$DeprecationStatus; } - export interface Params$Resource$Images$Get { + export interface Params$Resource$Images$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -25271,7 +25685,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Images$Getfromfamily { + export interface Params$Resource$Images$Getfromfamily extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -25286,7 +25701,7 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Images$Insert { + export interface Params$Resource$Images$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -25319,7 +25734,7 @@ export namespace compute_v1 { */ requestBody?: Schema$Image; } - export interface Params$Resource$Images$List { + export interface Params$Resource$Images$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -25373,7 +25788,7 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Images$Setlabels { + export interface Params$Resource$Images$Setlabels extends StandardParameters { /** * Auth client or API Key for the request */ @@ -25409,19 +25824,19 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.abandonInstances - * @desc Schedules a group action to remove the specified instances from the - * managed instance group. Abandoning an instance does not delete the - * instance, but it does remove the instance from any target pools that are - * applied by the managed instance group. This method reduces the targetSize - * of the managed instance group by the number of instances that you - * abandon. This operation is marked as DONE when the action is scheduled - * even if the instances have not yet been removed from the group. You must - * separately verify the status of the abandoning action with the - * listmanagedinstances method. If the group is part of a backend service - * that has enabled connection draining, it can take up to 60 seconds after - * the connection draining duration has elapsed before the VM instance is - * removed or deleted. You can specify a maximum of 1000 instances with - * this method per request. + * @desc Flags the specified instances to be removed from the managed + * instance group. Abandoning an instance does not delete the instance, but + * it does remove the instance from any target pools that are applied by the + * managed instance group. This method reduces the targetSize of the managed + * instance group by the number of instances that you abandon. This + * operation is marked as DONE when the action is scheduled even if the + * instances have not yet been removed from the group. You must separately + * verify the status of the abandoning action with the listmanagedinstances + * method. If the group is part of a backend service that has enabled + * connection draining, it can take up to 60 seconds after the connection + * draining duration has elapsed before the VM instance is removed or + * deleted. You can specify a maximum of 1000 instances with this method + * per request. * @example * * // BEFORE RUNNING: * // --------------- @@ -25844,11 +26259,11 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.deleteInstances - * @desc Schedules a group action to delete the specified instances in the - * managed instance group. The instances are also removed from any target - * pools of which they were a member. This method reduces the targetSize of - * the managed instance group by the number of instances that you delete. - * This operation is marked as DONE when the action is scheduled even if the + * @desc Flags the specified instances in the managed instance group for + * immediate deletion. The instances are also removed from any target pools + * of which they were a member. This method reduces the targetSize of the + * managed instance group by the number of instances that you delete. This + * operation is marked as DONE when the action is scheduled even if the * instances are still being deleted. You must separately verify the status * of the deleting action with the listmanagedinstances method. If the * group is part of a backend service that has enabled connection draining, @@ -26121,14 +26536,13 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.insert * @desc Creates a managed instance group using the information that you - * specify in the request. After the group is created, it schedules an - * action to create instances in the group using the specified instance - * template. This operation is marked as DONE when the group is created even - * if the instances in the group have not yet been created. You must - * separately verify the status of the individual instances with the - * listmanagedinstances method. A managed instance group can have up to - * 1000 VM instances per group. Please contact Cloud Support if you need an - * increase in this limit. + * specify in the request. After the group is created, instances in the + * group are created using the specified instance template. This operation + * is marked as DONE when the group is created even if the instances in the + * group have not yet been created. You must separately verify the status of + * the individual instances with the listmanagedinstances method. A managed + * instance group can have up to 1000 VM instances per group. Please contact + * Cloud Support if you need an increase in this limit. * @example * * // BEFORE RUNNING: * // --------------- @@ -26557,16 +26971,16 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.recreateInstances - * @desc Schedules a group action to recreate the specified instances in the - * managed instance group. The instances are deleted and recreated using the + * @desc Flags the specified instances in the managed instance group to be + * immediately recreated. The instances are deleted and recreated using the * current instance template for the managed instance group. This operation - * is marked as DONE when the action is scheduled even if the instances have - * not yet been recreated. You must separately verify the status of the - * recreating action with the listmanagedinstances method. If the group is - * part of a backend service that has enabled connection draining, it can - * take up to 60 seconds after the connection draining duration has elapsed - * before the VM instance is removed or deleted. You can specify a maximum - * of 1000 instances with this method per request. + * is marked as DONE when the flag is set even if the instances have not yet + * been recreated. You must separately verify the status of the recreating + * action with the listmanagedinstances method. If the group is part of a + * backend service that has enabled connection draining, it can take up to + * 60 seconds after the connection draining duration has elapsed before the + * VM instance is removed or deleted. You can specify a maximum of 1000 + * instances with this method per request. * @example * * // BEFORE RUNNING: * // --------------- @@ -26708,10 +27122,15 @@ export namespace compute_v1 { * marked DONE when the resize actions are scheduled even if the group has * not yet added or deleted any instances. You must separately verify the * status of the creating or deleting actions with the listmanagedinstances - * method. If the group is part of a backend service that has enabled - * connection draining, it can take up to 60 seconds after the connection - * draining duration has elapsed before the VM instance is removed or - * deleted. + * method. When resizing down, the instance group arbitrarily chooses the + * order in which VMs are deleted. The group takes into account some VM + * attributes when making the selection including: + The status of the VM + * instance. + The health of the VM instance. + The instance template + * version the VM is based on. + For regional managed instance groups, the + * location of the VM instance. This list is subject to change. If the + * group is part of a backend service that has enabled connection draining, + * it can take up to 60 seconds after the connection draining duration has + * elapsed before the VM instance is removed or deleted. * @example * * // BEFORE RUNNING: * // --------------- @@ -27128,7 +27547,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Instancegroupmanagers$Abandoninstances { + export interface Params$Resource$Instancegroupmanagers$Abandoninstances + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -27165,7 +27585,8 @@ export namespace compute_v1 { */ requestBody?: Schema$InstanceGroupManagersAbandonInstancesRequest; } - export interface Params$Resource$Instancegroupmanagers$Aggregatedlist { + export interface Params$Resource$Instancegroupmanagers$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -27219,7 +27640,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Instancegroupmanagers$Delete { + export interface Params$Resource$Instancegroupmanagers$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -27251,7 +27673,8 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Instancegroupmanagers$Deleteinstances { + export interface Params$Resource$Instancegroupmanagers$Deleteinstances extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -27288,7 +27711,8 @@ export namespace compute_v1 { */ requestBody?: Schema$InstanceGroupManagersDeleteInstancesRequest; } - export interface Params$Resource$Instancegroupmanagers$Get { + export interface Params$Resource$Instancegroupmanagers$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -27307,7 +27731,8 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Instancegroupmanagers$Insert { + export interface Params$Resource$Instancegroupmanagers$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -27340,7 +27765,8 @@ export namespace compute_v1 { */ requestBody?: Schema$InstanceGroupManager; } - export interface Params$Resource$Instancegroupmanagers$List { + export interface Params$Resource$Instancegroupmanagers$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -27398,7 +27824,8 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Instancegroupmanagers$Listmanagedinstances { + export interface Params$Resource$Instancegroupmanagers$Listmanagedinstances + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -27460,7 +27887,8 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Instancegroupmanagers$Recreateinstances { + export interface Params$Resource$Instancegroupmanagers$Recreateinstances + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -27497,7 +27925,8 @@ export namespace compute_v1 { */ requestBody?: Schema$InstanceGroupManagersRecreateInstancesRequest; } - export interface Params$Resource$Instancegroupmanagers$Resize { + export interface Params$Resource$Instancegroupmanagers$Resize extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -27536,7 +27965,8 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Instancegroupmanagers$Setinstancetemplate { + export interface Params$Resource$Instancegroupmanagers$Setinstancetemplate + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -27573,7 +28003,8 @@ export namespace compute_v1 { */ requestBody?: Schema$InstanceGroupManagersSetInstanceTemplateRequest; } - export interface Params$Resource$Instancegroupmanagers$Settargetpools { + export interface Params$Resource$Instancegroupmanagers$Settargetpools extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -28883,7 +29314,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Instancegroups$Addinstances { + export interface Params$Resource$Instancegroups$Addinstances extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -28920,7 +29352,8 @@ export namespace compute_v1 { */ requestBody?: Schema$InstanceGroupsAddInstancesRequest; } - export interface Params$Resource$Instancegroups$Aggregatedlist { + export interface Params$Resource$Instancegroups$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -28974,7 +29407,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Instancegroups$Delete { + export interface Params$Resource$Instancegroups$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -29006,7 +29440,8 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Instancegroups$Get { + export interface Params$Resource$Instancegroups$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -29025,7 +29460,8 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Instancegroups$Insert { + export interface Params$Resource$Instancegroups$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -29058,7 +29494,8 @@ export namespace compute_v1 { */ requestBody?: Schema$InstanceGroup; } - export interface Params$Resource$Instancegroups$List { + export interface Params$Resource$Instancegroups$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -29116,7 +29553,8 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Instancegroups$Listinstances { + export interface Params$Resource$Instancegroups$Listinstances extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -29184,7 +29622,8 @@ export namespace compute_v1 { */ requestBody?: Schema$InstanceGroupsListInstancesRequest; } - export interface Params$Resource$Instancegroups$Removeinstances { + export interface Params$Resource$Instancegroups$Removeinstances extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -29222,7 +29661,8 @@ export namespace compute_v1 { */ requestBody?: Schema$InstanceGroupsRemoveInstancesRequest; } - export interface Params$Resource$Instancegroups$Setnamedports { + export interface Params$Resource$Instancegroups$Setnamedports extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -30632,7 +31072,8 @@ export namespace compute_v1 { /** * compute.instances.listReferrers * @desc Retrieves the list of referrers to instances contained within the - * specified zone. + * specified zone. For more information, read Viewing Referrers to VM + * Instances. * @alias compute.instances.listReferrers * @memberOf! () * @@ -32067,8 +32508,8 @@ export namespace compute_v1 { /** * compute.instances.setTags - * @desc Sets tags for the specified instance to the data included in the - * request. + * @desc Sets network tags for the specified instance to the data included + * in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -32827,7 +33268,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Instances$Addaccessconfig { + export interface Params$Resource$Instances$Addaccessconfig extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -32868,7 +33310,8 @@ export namespace compute_v1 { */ requestBody?: Schema$AccessConfig; } - export interface Params$Resource$Instances$Aggregatedlist { + export interface Params$Resource$Instances$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -32922,7 +33365,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Instances$Attachdisk { + export interface Params$Resource$Instances$Attachdisk extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -32964,7 +33408,7 @@ export namespace compute_v1 { */ requestBody?: Schema$AttachedDisk; } - export interface Params$Resource$Instances$Delete { + export interface Params$Resource$Instances$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -32996,7 +33440,8 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Instances$Deleteaccessconfig { + export interface Params$Resource$Instances$Deleteaccessconfig extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -33036,7 +33481,8 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Instances$Detachdisk { + export interface Params$Resource$Instances$Detachdisk extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -33072,7 +33518,7 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Instances$Get { + export interface Params$Resource$Instances$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -33091,7 +33537,8 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Instances$Getserialportoutput { + export interface Params$Resource$Instances$Getserialportoutput extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -33122,7 +33569,7 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Instances$Insert { + export interface Params$Resource$Instances$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -33164,7 +33611,7 @@ export namespace compute_v1 { */ requestBody?: Schema$Instance; } - export interface Params$Resource$Instances$List { + export interface Params$Resource$Instances$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -33222,7 +33669,8 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Instances$Listreferrers { + export interface Params$Resource$Instances$Listreferrers extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -33285,7 +33733,7 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Instances$Reset { + export interface Params$Resource$Instances$Reset extends StandardParameters { /** * Auth client or API Key for the request */ @@ -33317,7 +33765,8 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Instances$Setdeletionprotection { + export interface Params$Resource$Instances$Setdeletionprotection extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -33353,7 +33802,8 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Instances$Setdiskautodelete { + export interface Params$Resource$Instances$Setdiskautodelete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -33393,7 +33843,8 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Instances$Setlabels { + export interface Params$Resource$Instances$Setlabels extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -33430,7 +33881,8 @@ export namespace compute_v1 { */ requestBody?: Schema$InstancesSetLabelsRequest; } - export interface Params$Resource$Instances$Setmachineresources { + export interface Params$Resource$Instances$Setmachineresources extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -33467,7 +33919,8 @@ export namespace compute_v1 { */ requestBody?: Schema$InstancesSetMachineResourcesRequest; } - export interface Params$Resource$Instances$Setmachinetype { + export interface Params$Resource$Instances$Setmachinetype extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -33504,7 +33957,8 @@ export namespace compute_v1 { */ requestBody?: Schema$InstancesSetMachineTypeRequest; } - export interface Params$Resource$Instances$Setmetadata { + export interface Params$Resource$Instances$Setmetadata extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -33541,7 +33995,8 @@ export namespace compute_v1 { */ requestBody?: Schema$Metadata; } - export interface Params$Resource$Instances$Setmincpuplatform { + export interface Params$Resource$Instances$Setmincpuplatform extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -33578,7 +34033,8 @@ export namespace compute_v1 { */ requestBody?: Schema$InstancesSetMinCpuPlatformRequest; } - export interface Params$Resource$Instances$Setscheduling { + export interface Params$Resource$Instances$Setscheduling extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -33615,7 +34071,8 @@ export namespace compute_v1 { */ requestBody?: Schema$Scheduling; } - export interface Params$Resource$Instances$Setserviceaccount { + export interface Params$Resource$Instances$Setserviceaccount extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -33652,7 +34109,8 @@ export namespace compute_v1 { */ requestBody?: Schema$InstancesSetServiceAccountRequest; } - export interface Params$Resource$Instances$Settags { + export interface Params$Resource$Instances$Settags extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -33689,7 +34147,8 @@ export namespace compute_v1 { */ requestBody?: Schema$Tags; } - export interface Params$Resource$Instances$Simulatemaintenanceevent { + export interface Params$Resource$Instances$Simulatemaintenanceevent extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -33708,7 +34167,7 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Instances$Start { + export interface Params$Resource$Instances$Start extends StandardParameters { /** * Auth client or API Key for the request */ @@ -33740,7 +34199,8 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Instances$Startwithencryptionkey { + export interface Params$Resource$Instances$Startwithencryptionkey extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -33777,7 +34237,7 @@ export namespace compute_v1 { */ requestBody?: Schema$InstancesStartWithEncryptionKeyRequest; } - export interface Params$Resource$Instances$Stop { + export interface Params$Resource$Instances$Stop extends StandardParameters { /** * Auth client or API Key for the request */ @@ -33809,7 +34269,8 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Instances$Updateaccessconfig { + export interface Params$Resource$Instances$Updateaccessconfig extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -33850,7 +34311,8 @@ export namespace compute_v1 { */ requestBody?: Schema$AccessConfig; } - export interface Params$Resource$Instances$Updatenetworkinterface { + export interface Params$Resource$Instances$Updatenetworkinterface extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -34430,7 +34892,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Instancetemplates$Delete { + export interface Params$Resource$Instancetemplates$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -34458,7 +34921,8 @@ export namespace compute_v1 { */ requestId?: string; } - export interface Params$Resource$Instancetemplates$Get { + export interface Params$Resource$Instancetemplates$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -34473,7 +34937,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Instancetemplates$Insert { + export interface Params$Resource$Instancetemplates$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -34502,7 +34967,8 @@ export namespace compute_v1 { */ requestBody?: Schema$InstanceTemplate; } - export interface Params$Resource$Instancetemplates$List { + export interface Params$Resource$Instancetemplates$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -35338,7 +35804,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Interconnectattachments$Aggregatedlist { + export interface Params$Resource$Interconnectattachments$Aggregatedlist + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -35392,7 +35859,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Interconnectattachments$Delete { + export interface Params$Resource$Interconnectattachments$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -35424,7 +35892,8 @@ export namespace compute_v1 { */ requestId?: string; } - export interface Params$Resource$Interconnectattachments$Get { + export interface Params$Resource$Interconnectattachments$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -35443,7 +35912,8 @@ export namespace compute_v1 { */ region?: string; } - export interface Params$Resource$Interconnectattachments$Insert { + export interface Params$Resource$Interconnectattachments$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -35476,7 +35946,8 @@ export namespace compute_v1 { */ requestBody?: Schema$InterconnectAttachment; } - export interface Params$Resource$Interconnectattachments$List { + export interface Params$Resource$Interconnectattachments$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -35534,7 +36005,8 @@ export namespace compute_v1 { */ region?: string; } - export interface Params$Resource$Interconnectattachments$Patch { + export interface Params$Resource$Interconnectattachments$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -35851,7 +36323,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Interconnectlocations$Get { + export interface Params$Resource$Interconnectlocations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -35866,7 +36339,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Interconnectlocations$List { + export interface Params$Resource$Interconnectlocations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -36184,6 +36658,88 @@ export namespace compute_v1 { } + /** + * compute.interconnects.getDiagnostics + * @desc Returns the interconnectDiagnostics for the specified interconnect. + * @alias compute.interconnects.getDiagnostics + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.interconnect Name of the interconnect resource to query. + * @param {string} params.project Project ID for 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 + */ + getDiagnostics( + params?: Params$Resource$Interconnects$Getdiagnostics, + options?: MethodOptions): + AxiosPromise; + getDiagnostics( + params: Params$Resource$Interconnects$Getdiagnostics, + options: MethodOptions| + BodyResponseCallback, + callback: + BodyResponseCallback): + void; + getDiagnostics( + params: Params$Resource$Interconnects$Getdiagnostics, + callback: + BodyResponseCallback): + void; + getDiagnostics( + callback: + BodyResponseCallback): + void; + getDiagnostics( + paramsOrCallback?: Params$Resource$Interconnects$Getdiagnostics| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: + BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Interconnects$Getdiagnostics; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Interconnects$Getdiagnostics; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/v1/projects/{project}/global/interconnects/{interconnect}/getDiagnostics') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'interconnect'], + pathParams: ['interconnect', 'project'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + + /** * compute.interconnects.insert * @desc Creates a Interconnect in the specified project using the data @@ -36586,7 +37142,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Interconnects$Delete { + export interface Params$Resource$Interconnects$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -36614,7 +37171,8 @@ export namespace compute_v1 { */ requestId?: string; } - export interface Params$Resource$Interconnects$Get { + export interface Params$Resource$Interconnects$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -36629,7 +37187,24 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Interconnects$Insert { + export interface Params$Resource$Interconnects$Getdiagnostics extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the interconnect resource to query. + */ + interconnect?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Interconnects$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -36658,7 +37233,8 @@ export namespace compute_v1 { */ requestBody?: Schema$Interconnect; } - export interface Params$Resource$Interconnects$List { + export interface Params$Resource$Interconnects$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -36712,7 +37288,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Interconnects$Patch { + export interface Params$Resource$Interconnects$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -36833,7 +37410,7 @@ export namespace compute_v1 { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -36898,7 +37475,7 @@ export namespace compute_v1 { } } - export interface Params$Resource$Licensecodes$Get { + export interface Params$Resource$Licensecodes$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -36913,7 +37490,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Licensecodes$Testiampermissions { + export interface Params$Resource$Licensecodes$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -36924,7 +37502,7 @@ export namespace compute_v1 { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -37284,7 +37862,7 @@ export namespace compute_v1 { * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -37349,7 +37927,7 @@ export namespace compute_v1 { } } - export interface Params$Resource$Licenses$Delete { + export interface Params$Resource$Licenses$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -37377,7 +37955,7 @@ export namespace compute_v1 { */ requestId?: string; } - export interface Params$Resource$Licenses$Get { + export interface Params$Resource$Licenses$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -37392,7 +37970,7 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Licenses$Insert { + export interface Params$Resource$Licenses$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -37421,7 +37999,7 @@ export namespace compute_v1 { */ requestBody?: Schema$License; } - export interface Params$Resource$Licenses$List { + export interface Params$Resource$Licenses$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -37475,7 +38053,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Licenses$Testiampermissions { + export interface Params$Resource$Licenses$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -37486,7 +38065,7 @@ export namespace compute_v1 { */ project?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -37920,7 +38499,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Machinetypes$Aggregatedlist { + export interface Params$Resource$Machinetypes$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -37974,7 +38554,7 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Machinetypes$Get { + export interface Params$Resource$Machinetypes$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -37993,7 +38573,8 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Machinetypes$List { + export interface Params$Resource$Machinetypes$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -39094,7 +39675,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Networks$Addpeering { + export interface Params$Resource$Networks$Addpeering extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -39127,7 +39709,7 @@ export namespace compute_v1 { */ requestBody?: Schema$NetworksAddPeeringRequest; } - export interface Params$Resource$Networks$Delete { + export interface Params$Resource$Networks$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -39155,7 +39737,7 @@ export namespace compute_v1 { */ requestId?: string; } - export interface Params$Resource$Networks$Get { + export interface Params$Resource$Networks$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -39170,7 +39752,7 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Networks$Insert { + export interface Params$Resource$Networks$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -39199,7 +39781,7 @@ export namespace compute_v1 { */ requestBody?: Schema$Network; } - export interface Params$Resource$Networks$List { + export interface Params$Resource$Networks$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -39253,7 +39835,7 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Networks$Patch { + export interface Params$Resource$Networks$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -39286,7 +39868,8 @@ export namespace compute_v1 { */ requestBody?: Schema$Network; } - export interface Params$Resource$Networks$Removepeering { + export interface Params$Resource$Networks$Removepeering extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -39319,7 +39902,8 @@ export namespace compute_v1 { */ requestBody?: Schema$NetworksRemovePeeringRequest; } - export interface Params$Resource$Networks$Switchtocustommode { + export interface Params$Resource$Networks$Switchtocustommode extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40013,7 +40597,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Nodegroups$Addnodes { + export interface Params$Resource$Nodegroups$Addnodes extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40050,7 +40635,8 @@ export namespace compute_v1 { */ requestBody?: Schema$NodeGroupsAddNodesRequest; } - export interface Params$Resource$Nodegroups$Aggregatedlist { + export interface Params$Resource$Nodegroups$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40104,7 +40690,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Nodegroups$Delete { + export interface Params$Resource$Nodegroups$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40136,7 +40723,8 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Nodegroups$Deletenodes { + export interface Params$Resource$Nodegroups$Deletenodes extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40173,7 +40761,7 @@ export namespace compute_v1 { */ requestBody?: Schema$NodeGroupsDeleteNodesRequest; } - export interface Params$Resource$Nodegroups$Get { + export interface Params$Resource$Nodegroups$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -40192,7 +40780,8 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Nodegroups$Insert { + export interface Params$Resource$Nodegroups$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40229,7 +40818,7 @@ export namespace compute_v1 { */ requestBody?: Schema$NodeGroup; } - export interface Params$Resource$Nodegroups$List { + export interface Params$Resource$Nodegroups$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -40287,7 +40876,8 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Nodegroups$Listnodes { + export interface Params$Resource$Nodegroups$Listnodes extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40349,7 +40939,8 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Nodegroups$Setnodetemplate { + export interface Params$Resource$Nodegroups$Setnodetemplate extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40766,7 +41357,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Nodetemplates$Aggregatedlist { + export interface Params$Resource$Nodetemplates$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40820,7 +41412,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Nodetemplates$Delete { + export interface Params$Resource$Nodetemplates$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40852,7 +41445,8 @@ export namespace compute_v1 { */ requestId?: string; } - export interface Params$Resource$Nodetemplates$Get { + export interface Params$Resource$Nodetemplates$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40871,7 +41465,8 @@ export namespace compute_v1 { */ region?: string; } - export interface Params$Resource$Nodetemplates$Insert { + export interface Params$Resource$Nodetemplates$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -40904,7 +41499,8 @@ export namespace compute_v1 { */ requestBody?: Schema$NodeTemplate; } - export interface Params$Resource$Nodetemplates$List { + export interface Params$Resource$Nodetemplates$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -41187,7 +41783,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Nodetypes$Aggregatedlist { + export interface Params$Resource$Nodetypes$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -41241,7 +41838,7 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Nodetypes$Get { + export interface Params$Resource$Nodetypes$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -41260,7 +41857,7 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Nodetypes$List { + export interface Params$Resource$Nodetypes$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -42929,7 +43526,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Projects$Disablexpnhost { + export interface Params$Resource$Projects$Disablexpnhost extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -42953,7 +43551,8 @@ export namespace compute_v1 { */ requestId?: string; } - export interface Params$Resource$Projects$Disablexpnresource { + export interface Params$Resource$Projects$Disablexpnresource extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -42982,7 +43581,8 @@ export namespace compute_v1 { */ requestBody?: Schema$ProjectsDisableXpnResourceRequest; } - export interface Params$Resource$Projects$Enablexpnhost { + export interface Params$Resource$Projects$Enablexpnhost extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -43006,7 +43606,8 @@ export namespace compute_v1 { */ requestId?: string; } - export interface Params$Resource$Projects$Enablexpnresource { + export interface Params$Resource$Projects$Enablexpnresource extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -43035,7 +43636,7 @@ export namespace compute_v1 { */ requestBody?: Schema$ProjectsEnableXpnResourceRequest; } - export interface Params$Resource$Projects$Get { + export interface Params$Resource$Projects$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -43046,7 +43647,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Projects$Getxpnhost { + export interface Params$Resource$Projects$Getxpnhost extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -43057,7 +43659,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Projects$Getxpnresources { + export interface Params$Resource$Projects$Getxpnresources extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -43111,7 +43714,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Projects$Listxpnhosts { + export interface Params$Resource$Projects$Listxpnhosts extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -43170,7 +43774,8 @@ export namespace compute_v1 { */ requestBody?: Schema$ProjectsListXpnHostsRequest; } - export interface Params$Resource$Projects$Movedisk { + export interface Params$Resource$Projects$Movedisk extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -43199,7 +43804,8 @@ export namespace compute_v1 { */ requestBody?: Schema$DiskMoveRequest; } - export interface Params$Resource$Projects$Moveinstance { + export interface Params$Resource$Projects$Moveinstance extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -43228,7 +43834,8 @@ export namespace compute_v1 { */ requestBody?: Schema$InstanceMoveRequest; } - export interface Params$Resource$Projects$Setcommoninstancemetadata { + export interface Params$Resource$Projects$Setcommoninstancemetadata extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -43257,7 +43864,8 @@ export namespace compute_v1 { */ requestBody?: Schema$Metadata; } - export interface Params$Resource$Projects$Setdefaultnetworktier { + export interface Params$Resource$Projects$Setdefaultnetworktier extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -43286,7 +43894,8 @@ export namespace compute_v1 { */ requestBody?: Schema$ProjectsSetDefaultNetworkTierRequest; } - export interface Params$Resource$Projects$Setusageexportbucket { + export interface Params$Resource$Projects$Setusageexportbucket extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -44137,7 +44746,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Regionautoscalers$Delete { + export interface Params$Resource$Regionautoscalers$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -44169,7 +44779,8 @@ export namespace compute_v1 { */ requestId?: string; } - export interface Params$Resource$Regionautoscalers$Get { + export interface Params$Resource$Regionautoscalers$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -44188,7 +44799,8 @@ export namespace compute_v1 { */ region?: string; } - export interface Params$Resource$Regionautoscalers$Insert { + export interface Params$Resource$Regionautoscalers$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -44221,7 +44833,8 @@ export namespace compute_v1 { */ requestBody?: Schema$Autoscaler; } - export interface Params$Resource$Regionautoscalers$List { + export interface Params$Resource$Regionautoscalers$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -44279,7 +44892,8 @@ export namespace compute_v1 { */ region?: string; } - export interface Params$Resource$Regionautoscalers$Patch { + export interface Params$Resource$Regionautoscalers$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -44316,7 +44930,8 @@ export namespace compute_v1 { */ requestBody?: Schema$Autoscaler; } - export interface Params$Resource$Regionautoscalers$Update { + export interface Params$Resource$Regionautoscalers$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -45329,7 +45944,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Regionbackendservices$Delete { + export interface Params$Resource$Regionbackendservices$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -45361,7 +45977,8 @@ export namespace compute_v1 { */ requestId?: string; } - export interface Params$Resource$Regionbackendservices$Get { + export interface Params$Resource$Regionbackendservices$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -45380,7 +45997,8 @@ export namespace compute_v1 { */ region?: string; } - export interface Params$Resource$Regionbackendservices$Gethealth { + export interface Params$Resource$Regionbackendservices$Gethealth extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -45404,7 +46022,8 @@ export namespace compute_v1 { */ requestBody?: Schema$ResourceGroupReference; } - export interface Params$Resource$Regionbackendservices$Insert { + export interface Params$Resource$Regionbackendservices$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -45437,7 +46056,8 @@ export namespace compute_v1 { */ requestBody?: Schema$BackendService; } - export interface Params$Resource$Regionbackendservices$List { + export interface Params$Resource$Regionbackendservices$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -45495,7 +46115,8 @@ export namespace compute_v1 { */ region?: string; } - export interface Params$Resource$Regionbackendservices$Patch { + export interface Params$Resource$Regionbackendservices$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -45532,7 +46153,8 @@ export namespace compute_v1 { */ requestBody?: Schema$BackendService; } - export interface Params$Resource$Regionbackendservices$Update { + export interface Params$Resource$Regionbackendservices$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -46128,7 +46750,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Regioncommitments$Aggregatedlist { + export interface Params$Resource$Regioncommitments$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -46182,7 +46805,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Regioncommitments$Get { + export interface Params$Resource$Regioncommitments$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -46201,7 +46825,8 @@ export namespace compute_v1 { */ region?: string; } - export interface Params$Resource$Regioncommitments$Insert { + export interface Params$Resource$Regioncommitments$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -46234,7 +46859,8 @@ export namespace compute_v1 { */ requestBody?: Schema$Commitment; } - export interface Params$Resource$Regioncommitments$List { + export interface Params$Resource$Regioncommitments$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -46818,7 +47444,7 @@ export namespace compute_v1 { * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.resource_ Name or id of the resource for this request. * @param {().TestPermissionsRequest} 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. @@ -46883,7 +47509,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Regiondisks$Createsnapshot { + export interface Params$Resource$Regiondisks$Createsnapshot extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -46920,7 +47547,8 @@ export namespace compute_v1 { */ requestBody?: Schema$Snapshot; } - export interface Params$Resource$Regiondisks$Delete { + export interface Params$Resource$Regiondisks$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -46952,7 +47580,7 @@ export namespace compute_v1 { */ requestId?: string; } - export interface Params$Resource$Regiondisks$Get { + export interface Params$Resource$Regiondisks$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -46971,7 +47599,8 @@ export namespace compute_v1 { */ region?: string; } - export interface Params$Resource$Regiondisks$Insert { + export interface Params$Resource$Regiondisks$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -47008,7 +47637,7 @@ export namespace compute_v1 { */ requestBody?: Schema$Disk; } - export interface Params$Resource$Regiondisks$List { + export interface Params$Resource$Regiondisks$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -47066,7 +47695,8 @@ export namespace compute_v1 { */ region?: string; } - export interface Params$Resource$Regiondisks$Resize { + export interface Params$Resource$Regiondisks$Resize extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -47103,7 +47733,8 @@ export namespace compute_v1 { */ requestBody?: Schema$RegionDisksResizeRequest; } - export interface Params$Resource$Regiondisks$Setlabels { + export interface Params$Resource$Regiondisks$Setlabels extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -47140,7 +47771,8 @@ export namespace compute_v1 { */ requestBody?: Schema$RegionSetLabelsRequest; } - export interface Params$Resource$Regiondisks$Testiampermissions { + export interface Params$Resource$Regiondisks$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -47155,7 +47787,7 @@ export namespace compute_v1 { */ region?: string; /** - * Name of the resource for this request. + * Name or id of the resource for this request. */ resource?: string; @@ -47319,7 +47951,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Regiondisktypes$Get { + export interface Params$Resource$Regiondisktypes$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -47338,7 +47971,8 @@ export namespace compute_v1 { */ region?: string; } - export interface Params$Resource$Regiondisktypes$List { + export interface Params$Resource$Regiondisktypes$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -47412,7 +48046,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.abandonInstances - * @desc Schedules a group action to remove the specified instances from the + * @desc Flags the specified instances to be immediately removed from the * managed instance group. Abandoning an instance does not delete the * instance, but it does remove the instance from any target pools that are * applied by the managed instance group. This method reduces the targetSize @@ -47692,17 +48326,18 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.deleteInstances - * @desc Schedules a group action to delete the specified instances in the - * managed instance group. The instances are also removed from any target - * pools of which they were a member. This method reduces the targetSize of - * the managed instance group by the number of instances that you delete. - * This operation is marked as DONE when the action is scheduled even if the - * instances are still being deleted. You must separately verify the status - * of the deleting action with the listmanagedinstances method. If the - * group is part of a backend service that has enabled connection draining, - * it can take up to 60 seconds after the connection draining duration has - * elapsed before the VM instance is removed or deleted. You can specify a - * maximum of 1000 instances with this method per request. + * @desc Flags the specified instances in the managed instance group to be + * immediately deleted. The instances are also removed from any target pools + * of which they were a member. This method reduces the targetSize of the + * managed instance group by the number of instances that you delete. The + * deleteInstances operation is marked DONE if the deleteInstances request + * is successful. The underlying actions take additional time. You must + * separately verify the status of the deleting action with the + * listmanagedinstances method. If the group is part of a backend service + * that has enabled connection draining, it can take up to 60 seconds after + * the connection draining duration has elapsed before the VM instance is + * removed or deleted. You can specify a maximum of 1000 instances with + * this method per request. * @example * * // BEFORE RUNNING: * // --------------- @@ -47967,13 +48602,12 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.insert * @desc Creates a managed instance group using the information that you - * specify in the request. After the group is created, it schedules an - * action to create instances in the group using the specified instance - * template. This operation is marked as DONE when the group is created even - * if the instances in the group have not yet been created. You must - * separately verify the status of the individual instances with the - * listmanagedinstances method. A regional managed instance group can - * contain up to 2000 instances. + * specify in the request. After the group is created, instances in the + * group are created using the specified instance template. This operation + * is marked as DONE when the group is created even if the instances in the + * group have not yet been created. You must separately verify the status of + * the individual instances with the listmanagedinstances method. A + * regional managed instance group can contain up to 2000 instances. * @example * * // BEFORE RUNNING: * // --------------- @@ -48406,16 +49040,16 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.recreateInstances - * @desc Schedules a group action to recreate the specified instances in the - * managed instance group. The instances are deleted and recreated using the + * @desc Flags the specified instances in the managed instance group to be + * immediately recreated. The instances are deleted and recreated using the * current instance template for the managed instance group. This operation - * is marked as DONE when the action is scheduled even if the instances have - * not yet been recreated. You must separately verify the status of the - * recreating action with the listmanagedinstances method. If the group is - * part of a backend service that has enabled connection draining, it can - * take up to 60 seconds after the connection draining duration has elapsed - * before the VM instance is removed or deleted. You can specify a maximum - * of 1000 instances with this method per request. + * is marked as DONE when the flag is set even if the instances have not yet + * been recreated. You must separately verify the status of the recreating + * action with the listmanagedinstances method. If the group is part of a + * backend service that has enabled connection draining, it can take up to + * 60 seconds after the connection draining duration has elapsed before the + * VM instance is removed or deleted. You can specify a maximum of 1000 + * instances with this method per request. * @example * * // BEFORE RUNNING: * // --------------- @@ -48552,17 +49186,16 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.resize - * @desc Changes the intended size for the managed instance group. If you - * increase the size, the group schedules actions to create new instances - * using the current instance template. If you decrease the size, the group - * schedules delete actions on one or more instances. The resize operation - * is marked DONE when the resize actions are scheduled even if the group - * has not yet added or deleted any instances. You must separately verify - * the status of the creating or deleting actions with the - * listmanagedinstances method. If the group is part of a backend service - * that has enabled connection draining, it can take up to 60 seconds after - * the connection draining duration has elapsed before the VM instance is - * removed or deleted. + * @desc Changes the intended size of the managed instance group. If you + * increase the size, the group creates new instances using the current + * instance template. If you decrease the size, the group deletes one or + * more instances. The resize operation is marked DONE if the resize + * request is successful. The underlying actions take additional time. You + * must separately verify the status of the creating or deleting actions + * with the listmanagedinstances method. If the group is part of a backend + * service that has enabled connection draining, it can take up to 60 + * seconds after the connection draining duration has elapsed before the VM + * instance is removed or deleted. * @example * * // BEFORE RUNNING: * // --------------- @@ -48971,7 +49604,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Regioninstancegroupmanagers$Abandoninstances { + export interface Params$Resource$Regioninstancegroupmanagers$Abandoninstances + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -49008,7 +49642,8 @@ export namespace compute_v1 { */ requestBody?: Schema$RegionInstanceGroupManagersAbandonInstancesRequest; } - export interface Params$Resource$Regioninstancegroupmanagers$Delete { + export interface Params$Resource$Regioninstancegroupmanagers$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -49040,7 +49675,8 @@ export namespace compute_v1 { */ requestId?: string; } - export interface Params$Resource$Regioninstancegroupmanagers$Deleteinstances { + export interface Params$Resource$Regioninstancegroupmanagers$Deleteinstances + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -49077,7 +49713,8 @@ export namespace compute_v1 { */ requestBody?: Schema$RegionInstanceGroupManagersDeleteInstancesRequest; } - export interface Params$Resource$Regioninstancegroupmanagers$Get { + export interface Params$Resource$Regioninstancegroupmanagers$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -49096,7 +49733,8 @@ export namespace compute_v1 { */ region?: string; } - export interface Params$Resource$Regioninstancegroupmanagers$Insert { + export interface Params$Resource$Regioninstancegroupmanagers$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -49129,7 +49767,8 @@ export namespace compute_v1 { */ requestBody?: Schema$InstanceGroupManager; } - export interface Params$Resource$Regioninstancegroupmanagers$List { + export interface Params$Resource$Regioninstancegroupmanagers$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -49187,7 +49826,8 @@ export namespace compute_v1 { */ region?: string; } - export interface Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances { + export interface Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -49249,7 +49889,8 @@ export namespace compute_v1 { */ region?: string; } - export interface Params$Resource$Regioninstancegroupmanagers$Recreateinstances { + export interface Params$Resource$Regioninstancegroupmanagers$Recreateinstances + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -49286,7 +49927,8 @@ export namespace compute_v1 { */ requestBody?: Schema$RegionInstanceGroupManagersRecreateRequest; } - export interface Params$Resource$Regioninstancegroupmanagers$Resize { + export interface Params$Resource$Regioninstancegroupmanagers$Resize extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -49322,7 +49964,8 @@ export namespace compute_v1 { */ size?: number; } - export interface Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate { + export interface Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -49359,7 +50002,8 @@ export namespace compute_v1 { */ requestBody?: Schema$RegionInstanceGroupManagersSetTemplateRequest; } - export interface Params$Resource$Regioninstancegroupmanagers$Settargetpools { + export interface Params$Resource$Regioninstancegroupmanagers$Settargetpools + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -49985,7 +50629,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Regioninstancegroups$Get { + export interface Params$Resource$Regioninstancegroups$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -50004,7 +50649,8 @@ export namespace compute_v1 { */ region?: string; } - export interface Params$Resource$Regioninstancegroups$List { + export interface Params$Resource$Regioninstancegroups$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -50062,7 +50708,8 @@ export namespace compute_v1 { */ region?: string; } - export interface Params$Resource$Regioninstancegroups$Listinstances { + export interface Params$Resource$Regioninstancegroups$Listinstances extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -50130,7 +50777,8 @@ export namespace compute_v1 { */ requestBody?: Schema$RegionInstanceGroupsListInstancesRequest; } - export interface Params$Resource$Regioninstancegroups$Setnamedports { + export interface Params$Resource$Regioninstancegroups$Setnamedports extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -50577,7 +51225,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Regionoperations$Delete { + export interface Params$Resource$Regionoperations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -50596,7 +51245,8 @@ export namespace compute_v1 { */ region?: string; } - export interface Params$Resource$Regionoperations$Get { + export interface Params$Resource$Regionoperations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -50615,7 +51265,8 @@ export namespace compute_v1 { */ region?: string; } - export interface Params$Resource$Regionoperations$List { + export interface Params$Resource$Regionoperations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -50942,7 +51593,7 @@ export namespace compute_v1 { } } - export interface Params$Resource$Regions$Get { + export interface Params$Resource$Regions$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -50957,7 +51608,7 @@ export namespace compute_v1 { */ region?: string; } - export interface Params$Resource$Regions$List { + export interface Params$Resource$Regions$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -51420,6 +52071,85 @@ export namespace compute_v1 { } + /** + * compute.routers.getNatMappingInfo + * @desc Retrieves runtime Nat mapping information of VM endpoints. + * @alias compute.routers.getNatMappingInfo + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string} params.router Name of the Router resource to query for Nat Mapping information of VM endpoints. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getNatMappingInfo( + params?: Params$Resource$Routers$Getnatmappinginfo, + options?: MethodOptions): + AxiosPromise; + getNatMappingInfo( + params: Params$Resource$Routers$Getnatmappinginfo, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + getNatMappingInfo( + params: Params$Resource$Routers$Getnatmappinginfo, + callback: BodyResponseCallback): void; + getNatMappingInfo( + callback: BodyResponseCallback): void; + getNatMappingInfo( + paramsOrCallback?: Params$Resource$Routers$Getnatmappinginfo| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Routers$Getnatmappinginfo; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Routers$Getnatmappinginfo; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/v1/projects/{project}/regions/{region}/routers/{router}/getNatMappingInfo') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'region', 'router'], + pathParams: ['project', 'region', 'router'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.routers.getRouterStatus * @desc Retrieves runtime information of the specified router. @@ -52234,7 +52964,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Routers$Aggregatedlist { + export interface Params$Resource$Routers$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -52288,7 +53019,7 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Routers$Delete { + export interface Params$Resource$Routers$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -52320,7 +53051,7 @@ export namespace compute_v1 { */ router?: string; } - export interface Params$Resource$Routers$Get { + export interface Params$Resource$Routers$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -52339,7 +53070,72 @@ export namespace compute_v1 { */ router?: string; } - export interface Params$Resource$Routers$Getrouterstatus { + export interface Params$Resource$Routers$Getnatmappinginfo extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * Name of the Router resource to query for Nat Mapping information of VM + * endpoints. + */ + router?: string; + } + export interface Params$Resource$Routers$Getrouterstatus extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -52358,7 +53154,7 @@ export namespace compute_v1 { */ router?: string; } - export interface Params$Resource$Routers$Insert { + export interface Params$Resource$Routers$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -52391,7 +53187,7 @@ export namespace compute_v1 { */ requestBody?: Schema$Router; } - export interface Params$Resource$Routers$List { + export interface Params$Resource$Routers$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -52449,7 +53245,7 @@ export namespace compute_v1 { */ region?: string; } - export interface Params$Resource$Routers$Patch { + export interface Params$Resource$Routers$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -52486,7 +53282,7 @@ export namespace compute_v1 { */ requestBody?: Schema$Router; } - export interface Params$Resource$Routers$Preview { + export interface Params$Resource$Routers$Preview extends StandardParameters { /** * Auth client or API Key for the request */ @@ -52510,7 +53306,7 @@ export namespace compute_v1 { */ requestBody?: Schema$Router; } - export interface Params$Resource$Routers$Update { + export interface Params$Resource$Routers$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -53066,7 +53862,7 @@ export namespace compute_v1 { } } - export interface Params$Resource$Routes$Delete { + export interface Params$Resource$Routes$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -53094,7 +53890,7 @@ export namespace compute_v1 { */ route?: string; } - export interface Params$Resource$Routes$Get { + export interface Params$Resource$Routes$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -53109,7 +53905,7 @@ export namespace compute_v1 { */ route?: string; } - export interface Params$Resource$Routes$Insert { + export interface Params$Resource$Routes$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -53138,7 +53934,7 @@ export namespace compute_v1 { */ requestBody?: Schema$Route; } - export interface Params$Resource$Routes$List { + export interface Params$Resource$Routes$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -53844,7 +54640,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Securitypolicies$Addrule { + export interface Params$Resource$Securitypolicies$Addrule extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -53864,7 +54661,8 @@ export namespace compute_v1 { */ requestBody?: Schema$SecurityPolicyRule; } - export interface Params$Resource$Securitypolicies$Delete { + export interface Params$Resource$Securitypolicies$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -53892,7 +54690,8 @@ export namespace compute_v1 { */ securityPolicy?: string; } - export interface Params$Resource$Securitypolicies$Get { + export interface Params$Resource$Securitypolicies$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -53907,7 +54706,8 @@ export namespace compute_v1 { */ securityPolicy?: string; } - export interface Params$Resource$Securitypolicies$Getrule { + export interface Params$Resource$Securitypolicies$Getrule extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -53926,7 +54726,8 @@ export namespace compute_v1 { */ securityPolicy?: string; } - export interface Params$Resource$Securitypolicies$Insert { + export interface Params$Resource$Securitypolicies$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -53955,7 +54756,8 @@ export namespace compute_v1 { */ requestBody?: Schema$SecurityPolicy; } - export interface Params$Resource$Securitypolicies$List { + export interface Params$Resource$Securitypolicies$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -54009,7 +54811,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Securitypolicies$Patch { + export interface Params$Resource$Securitypolicies$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -54042,7 +54845,8 @@ export namespace compute_v1 { */ requestBody?: Schema$SecurityPolicy; } - export interface Params$Resource$Securitypolicies$Patchrule { + export interface Params$Resource$Securitypolicies$Patchrule extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -54066,7 +54870,8 @@ export namespace compute_v1 { */ requestBody?: Schema$SecurityPolicyRule; } - export interface Params$Resource$Securitypolicies$Removerule { + export interface Params$Resource$Securitypolicies$Removerule extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -54617,7 +55422,7 @@ export namespace compute_v1 { } } - export interface Params$Resource$Snapshots$Delete { + export interface Params$Resource$Snapshots$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -54645,7 +55450,7 @@ export namespace compute_v1 { */ snapshot?: string; } - export interface Params$Resource$Snapshots$Get { + export interface Params$Resource$Snapshots$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -54660,7 +55465,7 @@ export namespace compute_v1 { */ snapshot?: string; } - export interface Params$Resource$Snapshots$List { + export interface Params$Resource$Snapshots$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -54714,7 +55519,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Snapshots$Setlabels { + export interface Params$Resource$Snapshots$Setlabels extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -55267,7 +56073,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Sslcertificates$Delete { + export interface Params$Resource$Sslcertificates$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -55295,7 +56102,8 @@ export namespace compute_v1 { */ sslCertificate?: string; } - export interface Params$Resource$Sslcertificates$Get { + export interface Params$Resource$Sslcertificates$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -55310,7 +56118,8 @@ export namespace compute_v1 { */ sslCertificate?: string; } - export interface Params$Resource$Sslcertificates$Insert { + export interface Params$Resource$Sslcertificates$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -55339,7 +56148,8 @@ export namespace compute_v1 { */ requestBody?: Schema$SslCertificate; } - export interface Params$Resource$Sslcertificates$List { + export interface Params$Resource$Sslcertificates$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -55843,7 +56653,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Sslpolicies$Delete { + export interface Params$Resource$Sslpolicies$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -55872,7 +56683,7 @@ export namespace compute_v1 { */ sslPolicy?: string; } - export interface Params$Resource$Sslpolicies$Get { + export interface Params$Resource$Sslpolicies$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -55888,7 +56699,8 @@ export namespace compute_v1 { */ sslPolicy?: string; } - export interface Params$Resource$Sslpolicies$Insert { + export interface Params$Resource$Sslpolicies$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -55917,7 +56729,7 @@ export namespace compute_v1 { */ requestBody?: Schema$SslPolicy; } - export interface Params$Resource$Sslpolicies$List { + export interface Params$Resource$Sslpolicies$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -55971,7 +56783,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Sslpolicies$Listavailablefeatures { + export interface Params$Resource$Sslpolicies$Listavailablefeatures extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -56025,7 +56838,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Sslpolicies$Patch { + export interface Params$Resource$Sslpolicies$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -57173,7 +57987,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Subnetworks$Aggregatedlist { + export interface Params$Resource$Subnetworks$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -57227,7 +58042,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Subnetworks$Delete { + export interface Params$Resource$Subnetworks$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -57259,7 +58075,8 @@ export namespace compute_v1 { */ subnetwork?: string; } - export interface Params$Resource$Subnetworks$Expandipcidrrange { + export interface Params$Resource$Subnetworks$Expandipcidrrange extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -57296,7 +58113,7 @@ export namespace compute_v1 { */ requestBody?: Schema$SubnetworksExpandIpCidrRangeRequest; } - export interface Params$Resource$Subnetworks$Get { + export interface Params$Resource$Subnetworks$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -57315,7 +58132,8 @@ export namespace compute_v1 { */ subnetwork?: string; } - export interface Params$Resource$Subnetworks$Insert { + export interface Params$Resource$Subnetworks$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -57348,7 +58166,7 @@ export namespace compute_v1 { */ requestBody?: Schema$Subnetwork; } - export interface Params$Resource$Subnetworks$List { + export interface Params$Resource$Subnetworks$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -57406,7 +58224,8 @@ export namespace compute_v1 { */ region?: string; } - export interface Params$Resource$Subnetworks$Listusable { + export interface Params$Resource$Subnetworks$Listusable extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -57460,7 +58279,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Subnetworks$Patch { + export interface Params$Resource$Subnetworks$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -57497,7 +58317,8 @@ export namespace compute_v1 { */ requestBody?: Schema$Subnetwork; } - export interface Params$Resource$Subnetworks$Setprivateipgoogleaccess { + export interface Params$Resource$Subnetworks$Setprivateipgoogleaccess extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -58200,7 +59021,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Targethttpproxies$Delete { + export interface Params$Resource$Targethttpproxies$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -58228,7 +59050,8 @@ export namespace compute_v1 { */ targetHttpProxy?: string; } - export interface Params$Resource$Targethttpproxies$Get { + export interface Params$Resource$Targethttpproxies$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -58243,7 +59066,8 @@ export namespace compute_v1 { */ targetHttpProxy?: string; } - export interface Params$Resource$Targethttpproxies$Insert { + export interface Params$Resource$Targethttpproxies$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -58272,7 +59096,8 @@ export namespace compute_v1 { */ requestBody?: Schema$TargetHttpProxy; } - export interface Params$Resource$Targethttpproxies$List { + export interface Params$Resource$Targethttpproxies$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -58326,7 +59151,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Targethttpproxies$Seturlmap { + export interface Params$Resource$Targethttpproxies$Seturlmap extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -59305,7 +60131,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Targethttpsproxies$Delete { + export interface Params$Resource$Targethttpsproxies$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -59333,7 +60160,8 @@ export namespace compute_v1 { */ targetHttpsProxy?: string; } - export interface Params$Resource$Targethttpsproxies$Get { + export interface Params$Resource$Targethttpsproxies$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -59348,7 +60176,8 @@ export namespace compute_v1 { */ targetHttpsProxy?: string; } - export interface Params$Resource$Targethttpsproxies$Insert { + export interface Params$Resource$Targethttpsproxies$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -59377,7 +60206,8 @@ export namespace compute_v1 { */ requestBody?: Schema$TargetHttpsProxy; } - export interface Params$Resource$Targethttpsproxies$List { + export interface Params$Resource$Targethttpsproxies$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -59431,7 +60261,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Targethttpsproxies$Setquicoverride { + export interface Params$Resource$Targethttpsproxies$Setquicoverride extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -59465,7 +60296,8 @@ export namespace compute_v1 { */ requestBody?: Schema$TargetHttpsProxiesSetQuicOverrideRequest; } - export interface Params$Resource$Targethttpsproxies$Setsslcertificates { + export interface Params$Resource$Targethttpsproxies$Setsslcertificates extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -59499,7 +60331,8 @@ export namespace compute_v1 { */ requestBody?: Schema$TargetHttpsProxiesSetSslCertificatesRequest; } - export interface Params$Resource$Targethttpsproxies$Setsslpolicy { + export interface Params$Resource$Targethttpsproxies$Setsslpolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -59533,7 +60366,8 @@ export namespace compute_v1 { */ requestBody?: Schema$SslPolicyReference; } - export interface Params$Resource$Targethttpsproxies$Seturlmap { + export interface Params$Resource$Targethttpsproxies$Seturlmap extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -60264,7 +61098,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Targetinstances$Aggregatedlist { + export interface Params$Resource$Targetinstances$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -60318,7 +61153,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Targetinstances$Delete { + export interface Params$Resource$Targetinstances$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -60350,7 +61186,8 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Targetinstances$Get { + export interface Params$Resource$Targetinstances$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -60369,7 +61206,8 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Targetinstances$Insert { + export interface Params$Resource$Targetinstances$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -60402,7 +61240,8 @@ export namespace compute_v1 { */ requestBody?: Schema$TargetInstance; } - export interface Params$Resource$Targetinstances$List { + export interface Params$Resource$Targetinstances$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -61965,7 +62804,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Targetpools$Addhealthcheck { + export interface Params$Resource$Targetpools$Addhealthcheck extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -62002,7 +62842,8 @@ export namespace compute_v1 { */ requestBody?: Schema$TargetPoolsAddHealthCheckRequest; } - export interface Params$Resource$Targetpools$Addinstance { + export interface Params$Resource$Targetpools$Addinstance extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -62039,7 +62880,8 @@ export namespace compute_v1 { */ requestBody?: Schema$TargetPoolsAddInstanceRequest; } - export interface Params$Resource$Targetpools$Aggregatedlist { + export interface Params$Resource$Targetpools$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -62093,7 +62935,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Targetpools$Delete { + export interface Params$Resource$Targetpools$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -62125,7 +62968,7 @@ export namespace compute_v1 { */ targetPool?: string; } - export interface Params$Resource$Targetpools$Get { + export interface Params$Resource$Targetpools$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -62144,7 +62987,8 @@ export namespace compute_v1 { */ targetPool?: string; } - export interface Params$Resource$Targetpools$Gethealth { + export interface Params$Resource$Targetpools$Gethealth extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -62168,7 +63012,8 @@ export namespace compute_v1 { */ requestBody?: Schema$InstanceReference; } - export interface Params$Resource$Targetpools$Insert { + export interface Params$Resource$Targetpools$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -62201,7 +63046,7 @@ export namespace compute_v1 { */ requestBody?: Schema$TargetPool; } - export interface Params$Resource$Targetpools$List { + export interface Params$Resource$Targetpools$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -62259,7 +63104,8 @@ export namespace compute_v1 { */ region?: string; } - export interface Params$Resource$Targetpools$Removehealthcheck { + export interface Params$Resource$Targetpools$Removehealthcheck extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -62296,7 +63142,8 @@ export namespace compute_v1 { */ requestBody?: Schema$TargetPoolsRemoveHealthCheckRequest; } - export interface Params$Resource$Targetpools$Removeinstance { + export interface Params$Resource$Targetpools$Removeinstance extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -62333,7 +63180,8 @@ export namespace compute_v1 { */ requestBody?: Schema$TargetPoolsRemoveInstanceRequest; } - export interface Params$Resource$Targetpools$Setbackup { + export interface Params$Resource$Targetpools$Setbackup extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -63375,7 +64223,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Targetsslproxies$Delete { + export interface Params$Resource$Targetsslproxies$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -63403,7 +64252,8 @@ export namespace compute_v1 { */ targetSslProxy?: string; } - export interface Params$Resource$Targetsslproxies$Get { + export interface Params$Resource$Targetsslproxies$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -63418,7 +64268,8 @@ export namespace compute_v1 { */ targetSslProxy?: string; } - export interface Params$Resource$Targetsslproxies$Insert { + export interface Params$Resource$Targetsslproxies$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -63447,7 +64298,8 @@ export namespace compute_v1 { */ requestBody?: Schema$TargetSslProxy; } - export interface Params$Resource$Targetsslproxies$List { + export interface Params$Resource$Targetsslproxies$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -63501,7 +64353,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Targetsslproxies$Setbackendservice { + export interface Params$Resource$Targetsslproxies$Setbackendservice extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -63535,7 +64388,8 @@ export namespace compute_v1 { */ requestBody?: Schema$TargetSslProxiesSetBackendServiceRequest; } - export interface Params$Resource$Targetsslproxies$Setproxyheader { + export interface Params$Resource$Targetsslproxies$Setproxyheader extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -63568,7 +64422,8 @@ export namespace compute_v1 { */ requestBody?: Schema$TargetSslProxiesSetProxyHeaderRequest; } - export interface Params$Resource$Targetsslproxies$Setsslcertificates { + export interface Params$Resource$Targetsslproxies$Setsslcertificates extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -63602,7 +64457,8 @@ export namespace compute_v1 { */ requestBody?: Schema$TargetSslProxiesSetSslCertificatesRequest; } - export interface Params$Resource$Targetsslproxies$Setsslpolicy { + export interface Params$Resource$Targetsslproxies$Setsslpolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -64431,7 +65287,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Targettcpproxies$Delete { + export interface Params$Resource$Targettcpproxies$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -64459,7 +65316,8 @@ export namespace compute_v1 { */ targetTcpProxy?: string; } - export interface Params$Resource$Targettcpproxies$Get { + export interface Params$Resource$Targettcpproxies$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -64474,7 +65332,8 @@ export namespace compute_v1 { */ targetTcpProxy?: string; } - export interface Params$Resource$Targettcpproxies$Insert { + export interface Params$Resource$Targettcpproxies$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -64503,7 +65362,8 @@ export namespace compute_v1 { */ requestBody?: Schema$TargetTcpProxy; } - export interface Params$Resource$Targettcpproxies$List { + export interface Params$Resource$Targettcpproxies$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -64557,7 +65417,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Targettcpproxies$Setbackendservice { + export interface Params$Resource$Targettcpproxies$Setbackendservice extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -64591,7 +65452,8 @@ export namespace compute_v1 { */ requestBody?: Schema$TargetTcpProxiesSetBackendServiceRequest; } - export interface Params$Resource$Targettcpproxies$Setproxyheader { + export interface Params$Resource$Targettcpproxies$Setproxyheader extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -65324,7 +66186,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Targetvpngateways$Aggregatedlist { + export interface Params$Resource$Targetvpngateways$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -65378,7 +66241,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Targetvpngateways$Delete { + export interface Params$Resource$Targetvpngateways$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -65410,7 +66274,8 @@ export namespace compute_v1 { */ targetVpnGateway?: string; } - export interface Params$Resource$Targetvpngateways$Get { + export interface Params$Resource$Targetvpngateways$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -65429,7 +66294,8 @@ export namespace compute_v1 { */ targetVpnGateway?: string; } - export interface Params$Resource$Targetvpngateways$Insert { + export interface Params$Resource$Targetvpngateways$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -65462,7 +66328,8 @@ export namespace compute_v1 { */ requestBody?: Schema$TargetVpnGateway; } - export interface Params$Resource$Targetvpngateways$List { + export interface Params$Resource$Targetvpngateways$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -66571,7 +67438,7 @@ export namespace compute_v1 { } } - export interface Params$Resource$Urlmaps$Delete { + export interface Params$Resource$Urlmaps$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -66599,7 +67466,7 @@ export namespace compute_v1 { */ urlMap?: string; } - export interface Params$Resource$Urlmaps$Get { + export interface Params$Resource$Urlmaps$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -66614,7 +67481,7 @@ export namespace compute_v1 { */ urlMap?: string; } - export interface Params$Resource$Urlmaps$Insert { + export interface Params$Resource$Urlmaps$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -66643,7 +67510,8 @@ export namespace compute_v1 { */ requestBody?: Schema$UrlMap; } - export interface Params$Resource$Urlmaps$Invalidatecache { + export interface Params$Resource$Urlmaps$Invalidatecache extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -66676,7 +67544,7 @@ export namespace compute_v1 { */ requestBody?: Schema$CacheInvalidationRule; } - export interface Params$Resource$Urlmaps$List { + export interface Params$Resource$Urlmaps$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -66730,7 +67598,7 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Urlmaps$Patch { + export interface Params$Resource$Urlmaps$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -66763,7 +67631,7 @@ export namespace compute_v1 { */ requestBody?: Schema$UrlMap; } - export interface Params$Resource$Urlmaps$Update { + export interface Params$Resource$Urlmaps$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -66796,7 +67664,7 @@ export namespace compute_v1 { */ requestBody?: Schema$UrlMap; } - export interface Params$Resource$Urlmaps$Validate { + export interface Params$Resource$Urlmaps$Validate extends StandardParameters { /** * Auth client or API Key for the request */ @@ -67501,7 +68369,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Vpntunnels$Aggregatedlist { + export interface Params$Resource$Vpntunnels$Aggregatedlist extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -67555,7 +68424,8 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Vpntunnels$Delete { + export interface Params$Resource$Vpntunnels$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -67587,7 +68457,7 @@ export namespace compute_v1 { */ vpnTunnel?: string; } - export interface Params$Resource$Vpntunnels$Get { + export interface Params$Resource$Vpntunnels$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -67606,7 +68476,8 @@ export namespace compute_v1 { */ vpnTunnel?: string; } - export interface Params$Resource$Vpntunnels$Insert { + export interface Params$Resource$Vpntunnels$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -67639,7 +68510,7 @@ export namespace compute_v1 { */ requestBody?: Schema$VpnTunnel; } - export interface Params$Resource$Vpntunnels$List { + export interface Params$Resource$Vpntunnels$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -68104,7 +68975,8 @@ export namespace compute_v1 { } } - export interface Params$Resource$Zoneoperations$Delete { + export interface Params$Resource$Zoneoperations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -68123,7 +68995,8 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Zoneoperations$Get { + export interface Params$Resource$Zoneoperations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -68142,7 +69015,8 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Zoneoperations$List { + export interface Params$Resource$Zoneoperations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -68468,7 +69342,7 @@ export namespace compute_v1 { } } - export interface Params$Resource$Zones$Get { + export interface Params$Resource$Zones$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -68483,7 +69357,7 @@ export namespace compute_v1 { */ zone?: string; } - export interface Params$Resource$Zones$List { + export interface Params$Resource$Zones$List extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/container/README.md b/src/apis/container/README.md index 4e5e0c68ef..3add5c94c3 100644 --- a/src/apis/container/README.md +++ b/src/apis/container/README.md @@ -2,7 +2,7 @@ # @google/container -> The Google Kubernetes Engine API is used for building and managing container based applications, powered by the open source Kubernetes technology. +> Builds and manages container-based applications, powered by the open source Kubernetes technology. ## Installation diff --git a/src/apis/container/v1.ts b/src/apis/container/v1.ts index d89e5866ec..00a390645d 100644 --- a/src/apis/container/v1.ts +++ b/src/apis/container/v1.ts @@ -29,6 +29,57 @@ export namespace container_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Kubernetes Engine API * @@ -1916,7 +1967,8 @@ export namespace container_v1 { } } - export interface Params$Resource$Projects$Locations$Getserverconfig { + export interface Params$Resource$Projects$Locations$Getserverconfig extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3148,7 +3200,8 @@ export namespace container_v1 { } } - export interface Params$Resource$Projects$Locations$Clusters$Completeiprotation { + export interface Params$Resource$Projects$Locations$Clusters$Completeiprotation + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3165,7 +3218,8 @@ export namespace container_v1 { */ requestBody?: Schema$CompleteIPRotationRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Create { + export interface Params$Resource$Projects$Locations$Clusters$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3182,7 +3236,8 @@ export namespace container_v1 { */ requestBody?: Schema$CreateClusterRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Delete { + export interface Params$Resource$Projects$Locations$Clusters$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3211,7 +3266,8 @@ export namespace container_v1 { */ zone?: string; } - export interface Params$Resource$Projects$Locations$Clusters$Get { + export interface Params$Resource$Projects$Locations$Clusters$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3240,7 +3296,8 @@ export namespace container_v1 { */ zone?: string; } - export interface Params$Resource$Projects$Locations$Clusters$List { + export interface Params$Resource$Projects$Locations$Clusters$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3266,7 +3323,8 @@ export namespace container_v1 { */ zone?: string; } - export interface Params$Resource$Projects$Locations$Clusters$Setaddons { + export interface Params$Resource$Projects$Locations$Clusters$Setaddons extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3283,7 +3341,8 @@ export namespace container_v1 { */ requestBody?: Schema$SetAddonsConfigRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Setlegacyabac { + export interface Params$Resource$Projects$Locations$Clusters$Setlegacyabac + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3300,7 +3359,8 @@ export namespace container_v1 { */ requestBody?: Schema$SetLegacyAbacRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Setlocations { + export interface Params$Resource$Projects$Locations$Clusters$Setlocations + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3317,7 +3377,8 @@ export namespace container_v1 { */ requestBody?: Schema$SetLocationsRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Setlogging { + export interface Params$Resource$Projects$Locations$Clusters$Setlogging + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3334,7 +3395,8 @@ export namespace container_v1 { */ requestBody?: Schema$SetLoggingServiceRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Setmaintenancepolicy { + export interface Params$Resource$Projects$Locations$Clusters$Setmaintenancepolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3352,7 +3414,8 @@ export namespace container_v1 { */ requestBody?: Schema$SetMaintenancePolicyRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Setmasterauth { + export interface Params$Resource$Projects$Locations$Clusters$Setmasterauth + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3369,7 +3432,8 @@ export namespace container_v1 { */ requestBody?: Schema$SetMasterAuthRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Setmonitoring { + export interface Params$Resource$Projects$Locations$Clusters$Setmonitoring + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3386,7 +3450,8 @@ export namespace container_v1 { */ requestBody?: Schema$SetMonitoringServiceRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Setnetworkpolicy { + export interface Params$Resource$Projects$Locations$Clusters$Setnetworkpolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3403,7 +3468,8 @@ export namespace container_v1 { */ requestBody?: Schema$SetNetworkPolicyRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Setresourcelabels { + export interface Params$Resource$Projects$Locations$Clusters$Setresourcelabels + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3420,7 +3486,8 @@ export namespace container_v1 { */ requestBody?: Schema$SetLabelsRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Startiprotation { + export interface Params$Resource$Projects$Locations$Clusters$Startiprotation + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3437,7 +3504,8 @@ export namespace container_v1 { */ requestBody?: Schema$StartIPRotationRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Update { + export interface Params$Resource$Projects$Locations$Clusters$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3454,7 +3522,8 @@ export namespace container_v1 { */ requestBody?: Schema$UpdateClusterRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Updatemaster { + export interface Params$Resource$Projects$Locations$Clusters$Updatemaster + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4122,7 +4191,8 @@ export namespace container_v1 { } } - export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Create { + export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4139,7 +4209,8 @@ export namespace container_v1 { */ requestBody?: Schema$CreateNodePoolRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Delete { + export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4174,7 +4245,8 @@ export namespace container_v1 { */ zone?: string; } - export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Get { + export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4209,7 +4281,8 @@ export namespace container_v1 { */ zone?: string; } - export interface Params$Resource$Projects$Locations$Clusters$Nodepools$List { + export interface Params$Resource$Projects$Locations$Clusters$Nodepools$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4238,7 +4311,8 @@ export namespace container_v1 { */ zone?: string; } - export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Rollback { + export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Rollback + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4256,7 +4330,8 @@ export namespace container_v1 { */ requestBody?: Schema$RollbackNodePoolUpgradeRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Setautoscaling { + export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Setautoscaling + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4274,7 +4349,8 @@ export namespace container_v1 { */ requestBody?: Schema$SetNodePoolAutoscalingRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Setmanagement { + export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Setmanagement + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4292,7 +4368,8 @@ export namespace container_v1 { */ requestBody?: Schema$SetNodePoolManagementRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Setsize { + export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Setsize + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4310,7 +4387,8 @@ export namespace container_v1 { */ requestBody?: Schema$SetNodePoolSizeRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Update { + export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Update + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4545,7 +4623,8 @@ export namespace container_v1 { } } - export interface Params$Resource$Projects$Locations$Operations$Cancel { + export interface Params$Resource$Projects$Locations$Operations$Cancel extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4562,7 +4641,8 @@ export namespace container_v1 { */ requestBody?: Schema$CancelOperationRequest; } - export interface Params$Resource$Projects$Locations$Operations$Get { + export interface Params$Resource$Projects$Locations$Operations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4591,7 +4671,8 @@ export namespace container_v1 { */ zone?: string; } - export interface Params$Resource$Projects$Locations$Operations$List { + export interface Params$Resource$Projects$Locations$Operations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4763,7 +4844,8 @@ export namespace container_v1 { } } - export interface Params$Resource$Projects$Zones$Getserverconfig { + export interface Params$Resource$Projects$Zones$Getserverconfig extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7116,7 +7198,8 @@ export namespace container_v1 { } } - export interface Params$Resource$Projects$Zones$Clusters$Addons { + export interface Params$Resource$Projects$Zones$Clusters$Addons extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7145,7 +7228,8 @@ export namespace container_v1 { */ requestBody?: Schema$SetAddonsConfigRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Completeiprotation { + export interface Params$Resource$Projects$Zones$Clusters$Completeiprotation + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7174,7 +7258,8 @@ export namespace container_v1 { */ requestBody?: Schema$CompleteIPRotationRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Create { + export interface Params$Resource$Projects$Zones$Clusters$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7198,7 +7283,8 @@ export namespace container_v1 { */ requestBody?: Schema$CreateClusterRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Delete { + export interface Params$Resource$Projects$Zones$Clusters$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7227,7 +7313,8 @@ export namespace container_v1 { */ zone?: string; } - export interface Params$Resource$Projects$Zones$Clusters$Get { + export interface Params$Resource$Projects$Zones$Clusters$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7256,7 +7343,8 @@ export namespace container_v1 { */ zone?: string; } - export interface Params$Resource$Projects$Zones$Clusters$Legacyabac { + export interface Params$Resource$Projects$Zones$Clusters$Legacyabac extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7285,7 +7373,8 @@ export namespace container_v1 { */ requestBody?: Schema$SetLegacyAbacRequest; } - export interface Params$Resource$Projects$Zones$Clusters$List { + export interface Params$Resource$Projects$Zones$Clusters$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7311,7 +7400,8 @@ export namespace container_v1 { */ zone?: string; } - export interface Params$Resource$Projects$Zones$Clusters$Locations { + export interface Params$Resource$Projects$Zones$Clusters$Locations extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7340,7 +7430,8 @@ export namespace container_v1 { */ requestBody?: Schema$SetLocationsRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Logging { + export interface Params$Resource$Projects$Zones$Clusters$Logging extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7369,7 +7460,8 @@ export namespace container_v1 { */ requestBody?: Schema$SetLoggingServiceRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Master { + export interface Params$Resource$Projects$Zones$Clusters$Master extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7398,7 +7490,8 @@ export namespace container_v1 { */ requestBody?: Schema$UpdateMasterRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Monitoring { + export interface Params$Resource$Projects$Zones$Clusters$Monitoring extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7427,7 +7520,8 @@ export namespace container_v1 { */ requestBody?: Schema$SetMonitoringServiceRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Resourcelabels { + export interface Params$Resource$Projects$Zones$Clusters$Resourcelabels + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7456,7 +7550,8 @@ export namespace container_v1 { */ requestBody?: Schema$SetLabelsRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Setmaintenancepolicy { + export interface Params$Resource$Projects$Zones$Clusters$Setmaintenancepolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7482,7 +7577,8 @@ export namespace container_v1 { */ requestBody?: Schema$SetMaintenancePolicyRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Setmasterauth { + export interface Params$Resource$Projects$Zones$Clusters$Setmasterauth extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7511,7 +7607,8 @@ export namespace container_v1 { */ requestBody?: Schema$SetMasterAuthRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Setnetworkpolicy { + export interface Params$Resource$Projects$Zones$Clusters$Setnetworkpolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7540,7 +7637,8 @@ export namespace container_v1 { */ requestBody?: Schema$SetNetworkPolicyRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Startiprotation { + export interface Params$Resource$Projects$Zones$Clusters$Startiprotation + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7569,7 +7667,8 @@ export namespace container_v1 { */ requestBody?: Schema$StartIPRotationRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Update { + export interface Params$Resource$Projects$Zones$Clusters$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8866,7 +8965,8 @@ export namespace container_v1 { } } - export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Autoscaling { + export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Autoscaling + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8900,7 +9000,8 @@ export namespace container_v1 { */ requestBody?: Schema$SetNodePoolAutoscalingRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Create { + export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8929,7 +9030,8 @@ export namespace container_v1 { */ requestBody?: Schema$CreateNodePoolRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Delete { + export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8964,7 +9066,8 @@ export namespace container_v1 { */ zone?: string; } - export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Get { + export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8999,7 +9102,8 @@ export namespace container_v1 { */ zone?: string; } - export interface Params$Resource$Projects$Zones$Clusters$Nodepools$List { + export interface Params$Resource$Projects$Zones$Clusters$Nodepools$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9028,7 +9132,8 @@ export namespace container_v1 { */ zone?: string; } - export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Rollback { + export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Rollback + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9062,7 +9167,8 @@ export namespace container_v1 { */ requestBody?: Schema$RollbackNodePoolUpgradeRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Setmanagement { + export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Setmanagement + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9096,7 +9202,8 @@ export namespace container_v1 { */ requestBody?: Schema$SetNodePoolManagementRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Setsize { + export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Setsize + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9130,7 +9237,8 @@ export namespace container_v1 { */ requestBody?: Schema$SetNodePoolSizeRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Update { + export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Update + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9568,7 +9676,8 @@ export namespace container_v1 { } } - export interface Params$Resource$Projects$Zones$Operations$Cancel { + export interface Params$Resource$Projects$Zones$Operations$Cancel extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9597,7 +9706,8 @@ export namespace container_v1 { */ requestBody?: Schema$CancelOperationRequest; } - export interface Params$Resource$Projects$Zones$Operations$Get { + export interface Params$Resource$Projects$Zones$Operations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9626,7 +9736,8 @@ export namespace container_v1 { */ zone?: string; } - export interface Params$Resource$Projects$Zones$Operations$List { + export interface Params$Resource$Projects$Zones$Operations$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/container/v1beta1.ts b/src/apis/container/v1beta1.ts index bbccea9d7e..809414d5d2 100644 --- a/src/apis/container/v1beta1.ts +++ b/src/apis/container/v1beta1.ts @@ -29,6 +29,57 @@ export namespace container_v1beta1 { version: 'v1beta1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Kubernetes Engine API * @@ -2325,7 +2376,8 @@ export namespace container_v1beta1 { } } - export interface Params$Resource$Projects$Aggregated$Usablesubnetworks$List { + export interface Params$Resource$Projects$Aggregated$Usablesubnetworks$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2511,7 +2563,8 @@ export namespace container_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Getserverconfig { + export interface Params$Resource$Projects$Locations$Getserverconfig extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2535,7 +2588,8 @@ export namespace container_v1beta1 { */ zone?: string; } - export interface Params$Resource$Projects$Locations$List { + export interface Params$Resource$Projects$Locations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3756,7 +3810,8 @@ export namespace container_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Clusters$Completeiprotation { + export interface Params$Resource$Projects$Locations$Clusters$Completeiprotation + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3773,7 +3828,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$CompleteIPRotationRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Create { + export interface Params$Resource$Projects$Locations$Clusters$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3790,7 +3846,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$CreateClusterRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Delete { + export interface Params$Resource$Projects$Locations$Clusters$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3819,7 +3876,8 @@ export namespace container_v1beta1 { */ zone?: string; } - export interface Params$Resource$Projects$Locations$Clusters$Get { + export interface Params$Resource$Projects$Locations$Clusters$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3848,7 +3906,8 @@ export namespace container_v1beta1 { */ zone?: string; } - export interface Params$Resource$Projects$Locations$Clusters$List { + export interface Params$Resource$Projects$Locations$Clusters$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3874,7 +3933,8 @@ export namespace container_v1beta1 { */ zone?: string; } - export interface Params$Resource$Projects$Locations$Clusters$Setaddons { + export interface Params$Resource$Projects$Locations$Clusters$Setaddons extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3891,7 +3951,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$SetAddonsConfigRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Setlegacyabac { + export interface Params$Resource$Projects$Locations$Clusters$Setlegacyabac + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3908,7 +3969,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$SetLegacyAbacRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Setlocations { + export interface Params$Resource$Projects$Locations$Clusters$Setlocations + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3925,7 +3987,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$SetLocationsRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Setlogging { + export interface Params$Resource$Projects$Locations$Clusters$Setlogging + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3942,7 +4005,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$SetLoggingServiceRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Setmaintenancepolicy { + export interface Params$Resource$Projects$Locations$Clusters$Setmaintenancepolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3960,7 +4024,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$SetMaintenancePolicyRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Setmasterauth { + export interface Params$Resource$Projects$Locations$Clusters$Setmasterauth + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3977,7 +4042,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$SetMasterAuthRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Setmonitoring { + export interface Params$Resource$Projects$Locations$Clusters$Setmonitoring + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3994,7 +4060,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$SetMonitoringServiceRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Setnetworkpolicy { + export interface Params$Resource$Projects$Locations$Clusters$Setnetworkpolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4011,7 +4078,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$SetNetworkPolicyRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Setresourcelabels { + export interface Params$Resource$Projects$Locations$Clusters$Setresourcelabels + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4028,7 +4096,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$SetLabelsRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Startiprotation { + export interface Params$Resource$Projects$Locations$Clusters$Startiprotation + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4045,7 +4114,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$StartIPRotationRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Update { + export interface Params$Resource$Projects$Locations$Clusters$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4062,7 +4132,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$UpdateClusterRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Updatemaster { + export interface Params$Resource$Projects$Locations$Clusters$Updatemaster + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4730,7 +4801,8 @@ export namespace container_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Create { + export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4747,7 +4819,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$CreateNodePoolRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Delete { + export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4782,7 +4855,8 @@ export namespace container_v1beta1 { */ zone?: string; } - export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Get { + export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4817,7 +4891,8 @@ export namespace container_v1beta1 { */ zone?: string; } - export interface Params$Resource$Projects$Locations$Clusters$Nodepools$List { + export interface Params$Resource$Projects$Locations$Clusters$Nodepools$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4846,7 +4921,8 @@ export namespace container_v1beta1 { */ zone?: string; } - export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Rollback { + export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Rollback + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4864,7 +4940,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$RollbackNodePoolUpgradeRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Setautoscaling { + export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Setautoscaling + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4882,7 +4959,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$SetNodePoolAutoscalingRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Setmanagement { + export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Setmanagement + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4900,7 +4978,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$SetNodePoolManagementRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Setsize { + export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Setsize + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4918,7 +4997,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$SetNodePoolSizeRequest; } - export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Update { + export interface Params$Resource$Projects$Locations$Clusters$Nodepools$Update + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5153,7 +5233,8 @@ export namespace container_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Operations$Cancel { + export interface Params$Resource$Projects$Locations$Operations$Cancel extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5170,7 +5251,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$CancelOperationRequest; } - export interface Params$Resource$Projects$Locations$Operations$Get { + export interface Params$Resource$Projects$Locations$Operations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5199,7 +5281,8 @@ export namespace container_v1beta1 { */ zone?: string; } - export interface Params$Resource$Projects$Locations$Operations$List { + export interface Params$Resource$Projects$Locations$Operations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5314,7 +5397,8 @@ export namespace container_v1beta1 { } } - export interface Params$Resource$Projects$Zones$Getserverconfig { + export interface Params$Resource$Projects$Zones$Getserverconfig extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6594,7 +6678,8 @@ export namespace container_v1beta1 { } } - export interface Params$Resource$Projects$Zones$Clusters$Addons { + export interface Params$Resource$Projects$Zones$Clusters$Addons extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6623,7 +6708,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$SetAddonsConfigRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Completeiprotation { + export interface Params$Resource$Projects$Zones$Clusters$Completeiprotation + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6652,7 +6738,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$CompleteIPRotationRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Create { + export interface Params$Resource$Projects$Zones$Clusters$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6676,7 +6763,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$CreateClusterRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Delete { + export interface Params$Resource$Projects$Zones$Clusters$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6705,7 +6793,8 @@ export namespace container_v1beta1 { */ zone?: string; } - export interface Params$Resource$Projects$Zones$Clusters$Get { + export interface Params$Resource$Projects$Zones$Clusters$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6734,7 +6823,8 @@ export namespace container_v1beta1 { */ zone?: string; } - export interface Params$Resource$Projects$Zones$Clusters$Legacyabac { + export interface Params$Resource$Projects$Zones$Clusters$Legacyabac extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6763,7 +6853,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$SetLegacyAbacRequest; } - export interface Params$Resource$Projects$Zones$Clusters$List { + export interface Params$Resource$Projects$Zones$Clusters$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6789,7 +6880,8 @@ export namespace container_v1beta1 { */ zone?: string; } - export interface Params$Resource$Projects$Zones$Clusters$Locations { + export interface Params$Resource$Projects$Zones$Clusters$Locations extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6818,7 +6910,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$SetLocationsRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Logging { + export interface Params$Resource$Projects$Zones$Clusters$Logging extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6847,7 +6940,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$SetLoggingServiceRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Master { + export interface Params$Resource$Projects$Zones$Clusters$Master extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6876,7 +6970,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$UpdateMasterRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Monitoring { + export interface Params$Resource$Projects$Zones$Clusters$Monitoring extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6905,7 +7000,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$SetMonitoringServiceRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Resourcelabels { + export interface Params$Resource$Projects$Zones$Clusters$Resourcelabels + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6934,7 +7030,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$SetLabelsRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Setmaintenancepolicy { + export interface Params$Resource$Projects$Zones$Clusters$Setmaintenancepolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6960,7 +7057,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$SetMaintenancePolicyRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Setmasterauth { + export interface Params$Resource$Projects$Zones$Clusters$Setmasterauth extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6989,7 +7087,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$SetMasterAuthRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Setnetworkpolicy { + export interface Params$Resource$Projects$Zones$Clusters$Setnetworkpolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7018,7 +7117,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$SetNetworkPolicyRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Startiprotation { + export interface Params$Resource$Projects$Zones$Clusters$Startiprotation + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7047,7 +7147,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$StartIPRotationRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Update { + export interface Params$Resource$Projects$Zones$Clusters$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7755,7 +7856,8 @@ export namespace container_v1beta1 { } } - export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Autoscaling { + export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Autoscaling + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7789,7 +7891,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$SetNodePoolAutoscalingRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Create { + export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7818,7 +7921,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$CreateNodePoolRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Delete { + export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7853,7 +7957,8 @@ export namespace container_v1beta1 { */ zone?: string; } - export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Get { + export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7888,7 +7993,8 @@ export namespace container_v1beta1 { */ zone?: string; } - export interface Params$Resource$Projects$Zones$Clusters$Nodepools$List { + export interface Params$Resource$Projects$Zones$Clusters$Nodepools$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7917,7 +8023,8 @@ export namespace container_v1beta1 { */ zone?: string; } - export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Rollback { + export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Rollback + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7951,7 +8058,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$RollbackNodePoolUpgradeRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Setmanagement { + export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Setmanagement + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7985,7 +8093,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$SetNodePoolManagementRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Setsize { + export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Setsize + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8019,7 +8128,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$SetNodePoolSizeRequest; } - export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Update { + export interface Params$Resource$Projects$Zones$Clusters$Nodepools$Update + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8278,7 +8388,8 @@ export namespace container_v1beta1 { } } - export interface Params$Resource$Projects$Zones$Operations$Cancel { + export interface Params$Resource$Projects$Zones$Operations$Cancel extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8307,7 +8418,8 @@ export namespace container_v1beta1 { */ requestBody?: Schema$CancelOperationRequest; } - export interface Params$Resource$Projects$Zones$Operations$Get { + export interface Params$Resource$Projects$Zones$Operations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8336,7 +8448,8 @@ export namespace container_v1beta1 { */ zone?: string; } - export interface Params$Resource$Projects$Zones$Operations$List { + export interface Params$Resource$Projects$Zones$Operations$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/content/index.ts b/src/apis/content/index.ts index 7f9261adba..44c4bff120 100644 --- a/src/apis/content/index.ts +++ b/src/apis/content/index.ts @@ -15,21 +15,14 @@ import {getAPI, GoogleConfigurable} from 'googleapis-common'; import {content_v2} from './v2'; -import {content_v2sandbox} from './v2sandbox'; export const VERSIONS = { 'v2': content_v2.Content, - 'v2sandbox': content_v2sandbox.Content, }; export function content(version: 'v2'): content_v2.Content; export function content(options: content_v2.Options): content_v2.Content; -export function content(version: 'v2sandbox'): content_v2sandbox.Content; -export function content(options: content_v2sandbox.Options): - content_v2sandbox.Content; -export function content( - this: GoogleConfigurable, - versionOrOptions: 'v2'|content_v2.Options|'v2sandbox'| - content_v2sandbox.Options) { +export function content( + this: GoogleConfigurable, versionOrOptions: 'v2'|content_v2.Options) { return getAPI('content', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/content/v2.ts b/src/apis/content/v2.ts index 873a8988be..b83925d628 100644 --- a/src/apis/content/v2.ts +++ b/src/apis/content/v2.ts @@ -29,6 +29,40 @@ export namespace content_v2 { version: 'v2'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Content API for Shopping * @@ -96,7 +130,8 @@ export namespace content_v2 { } /** - * Account data. + * Account data. After the creation of a new account it may take a few minutes + * before it is fully operational. */ export interface Schema$Account { /** @@ -455,6 +490,10 @@ export namespace content_v2 { * Additional details about the issue. */ detail?: string; + /** + * The URL of a web page to help resolving this issue. + */ + documentation?: string; /** * Issue identifier. */ @@ -898,10 +937,41 @@ export namespace content_v2 { */ services?: string[]; } + export interface Schema$CustomAttribute { + /** + * The name of the attribute. Underscores will be replaced by spaces upon + * insertion. + */ + name?: string; + /** + * The type of the attribute. + */ + type?: string; + /** + * Free-form unit of the attribute. Unit can only be used for values of type + * int, float, or price. + */ + unit?: string; + /** + * The value of the attribute. + */ + value?: string; + } export interface Schema$CustomerReturnReason { description?: string; reasonCode?: string; } + export interface Schema$CustomGroup { + /** + * The sub-attributes. + */ + attributes?: Schema$CustomAttribute[]; + /** + * The name of the group. Underscores will be replaced by spaces upon + * insertion. + */ + name?: string; + } export interface Schema$CutoffTime { /** * Hour of the cutoff time until which an order has to be placed to be @@ -1535,10 +1605,39 @@ export namespace content_v2 { * The availability of the product. */ availability?: string; + /** + * Custom label 0 for custom grouping of items in a Shopping campaign. Only + * supported for online products. + */ + customLabel0?: string; + /** + * Custom label 1 for custom grouping of items in a Shopping campaign. Only + * supported for online products. + */ + customLabel1?: string; + /** + * Custom label 2 for custom grouping of items in a Shopping campaign. Only + * supported for online products. + */ + customLabel2?: string; + /** + * Custom label 3 for custom grouping of items in a Shopping campaign. Only + * supported for online products. + */ + customLabel3?: string; + /** + * Custom label 3 for custom grouping of items in a Shopping campaign. Only + * supported for online products. + */ + customLabel4?: string; /** * Number and amount of installments to pay for an item. Brazil only. */ installment?: Schema$Installment; + /** + * The instore product location. Supported only for local products. + */ + instoreProductLocation?: string; /** * Identifies what kind of resource this is. Value: the fixed string * "content#inventory". @@ -1663,10 +1762,39 @@ export namespace content_v2 { * The availability of the product. */ availability?: string; + /** + * Custom label 0 for custom grouping of items in a Shopping campaign. Only + * supported for online products. + */ + customLabel0?: string; + /** + * Custom label 1 for custom grouping of items in a Shopping campaign. Only + * supported for online products. + */ + customLabel1?: string; + /** + * Custom label 2 for custom grouping of items in a Shopping campaign. Only + * supported for online products. + */ + customLabel2?: string; + /** + * Custom label 3 for custom grouping of items in a Shopping campaign. Only + * supported for online products. + */ + customLabel3?: string; + /** + * Custom label 3 for custom grouping of items in a Shopping campaign. Only + * supported for online products. + */ + customLabel4?: string; /** * Number and amount of installments to pay for an item. Brazil only. */ installment?: Schema$Installment; + /** + * The instore product location. Supported only for local products. + */ + instoreProductLocation?: string; /** * Loyalty points that users receive after purchasing the item. Japan only. */ @@ -2413,7 +2541,9 @@ export namespace content_v2 { */ price?: Schema$Price; /** - * Product data from the time of the order placement. + * Product data as seen by customer from the time of the order placement. + * Note that certain attributes values (e.g. title or gtin) might be + * reformatted and no longer match values submitted via product feed. */ product?: Schema$OrderLineItemProduct; /** @@ -2476,6 +2606,10 @@ export namespace content_v2 { * The two-letter ISO 639-1 language code for the item. */ contentLanguage?: string; + /** + * Associated fees at order creation time. + */ + fees?: Schema$OrderLineItemProductFee[]; /** * Global Trade Item Number (GTIN) of the item. */ @@ -2523,6 +2657,16 @@ export namespace content_v2 { */ variantAttributes?: Schema$OrderLineItemProductVariantAttribute[]; } + export interface Schema$OrderLineItemProductFee { + /** + * Amount of the fee. + */ + amount?: Schema$Price; + /** + * Name of the fee. + */ + name?: string; + } export interface Schema$OrderLineItemProductVariantAttribute { /** * The dimension of the variant. @@ -4404,11 +4548,11 @@ export namespace content_v2 { * "text", "value": "regular" }). This is * useful for submitting attributes not explicitly exposed by the API. */ - customAttributes?: Schema$ProductCustomAttribute[]; + customAttributes?: Schema$CustomAttribute[]; /** * A list of custom (merchant-provided) custom attribute groups. */ - customGroups?: Schema$ProductCustomGroup[]; + customGroups?: Schema$CustomGroup[]; /** * Custom label 0 for custom grouping of items in a Shopping campaign. */ @@ -4683,37 +4827,6 @@ export namespace content_v2 { */ intention?: string; } - export interface Schema$ProductCustomAttribute { - /** - * The name of the attribute. Underscores will be replaced by spaces upon - * insertion. - */ - name?: string; - /** - * The type of the attribute. - */ - type?: string; - /** - * Free-form unit of the attribute. Unit can only be used for values of type - * int, float, or price. - */ - unit?: string; - /** - * The value of the attribute. - */ - value?: string; - } - export interface Schema$ProductCustomGroup { - /** - * The sub-attributes. - */ - attributes?: Schema$ProductCustomAttribute[]; - /** - * The name of the group. Underscores will be replaced by spaces upon - * insertion. - */ - name?: string; - } export interface Schema$ProductDestination { /** * The name of the destination. @@ -6370,13 +6483,15 @@ export namespace content_v2 { } } - export interface Params$Resource$Accounts$Authinfo { + export interface Params$Resource$Accounts$Authinfo extends + StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; } - export interface Params$Resource$Accounts$Claimwebsite { + export interface Params$Resource$Accounts$Claimwebsite extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6399,7 +6514,8 @@ export namespace content_v2 { */ overwrite?: boolean; } - export interface Params$Resource$Accounts$Custombatch { + export interface Params$Resource$Accounts$Custombatch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6415,7 +6531,7 @@ export namespace content_v2 { */ requestBody?: Schema$AccountsCustomBatchRequest; } - export interface Params$Resource$Accounts$Delete { + export interface Params$Resource$Accounts$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6439,7 +6555,7 @@ export namespace content_v2 { */ merchantId?: string; } - export interface Params$Resource$Accounts$Get { + export interface Params$Resource$Accounts$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6456,7 +6572,7 @@ export namespace content_v2 { */ merchantId?: string; } - export interface Params$Resource$Accounts$Insert { + export interface Params$Resource$Accounts$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6476,7 +6592,7 @@ export namespace content_v2 { */ requestBody?: Schema$Account; } - export interface Params$Resource$Accounts$Link { + export interface Params$Resource$Accounts$Link extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6498,7 +6614,7 @@ export namespace content_v2 { */ requestBody?: Schema$AccountsLinkRequest; } - export interface Params$Resource$Accounts$List { + export interface Params$Resource$Accounts$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6518,7 +6634,7 @@ export namespace content_v2 { */ pageToken?: string; } - export interface Params$Resource$Accounts$Patch { + export interface Params$Resource$Accounts$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6544,7 +6660,7 @@ export namespace content_v2 { */ requestBody?: Schema$Account; } - export interface Params$Resource$Accounts$Update { + export interface Params$Resource$Accounts$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6805,7 +6921,8 @@ export namespace content_v2 { } } - export interface Params$Resource$Accountstatuses$Custombatch { + export interface Params$Resource$Accountstatuses$Custombatch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6817,7 +6934,8 @@ export namespace content_v2 { */ requestBody?: Schema$AccountstatusesCustomBatchRequest; } - export interface Params$Resource$Accountstatuses$Get { + export interface Params$Resource$Accountstatuses$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6839,7 +6957,8 @@ export namespace content_v2 { */ merchantId?: string; } - export interface Params$Resource$Accountstatuses$List { + export interface Params$Resource$Accountstatuses$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7225,7 +7344,8 @@ export namespace content_v2 { } } - export interface Params$Resource$Accounttax$Custombatch { + export interface Params$Resource$Accounttax$Custombatch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7241,7 +7361,7 @@ export namespace content_v2 { */ requestBody?: Schema$AccounttaxCustomBatchRequest; } - export interface Params$Resource$Accounttax$Get { + export interface Params$Resource$Accounttax$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7258,7 +7378,7 @@ export namespace content_v2 { */ merchantId?: string; } - export interface Params$Resource$Accounttax$List { + export interface Params$Resource$Accounttax$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7278,7 +7398,7 @@ export namespace content_v2 { */ pageToken?: string; } - export interface Params$Resource$Accounttax$Patch { + export interface Params$Resource$Accounttax$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7304,7 +7424,8 @@ export namespace content_v2 { */ requestBody?: Schema$AccountTax; } - export interface Params$Resource$Accounttax$Update { + export interface Params$Resource$Accounttax$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7891,7 +8012,8 @@ export namespace content_v2 { } } - export interface Params$Resource$Datafeeds$Custombatch { + export interface Params$Resource$Datafeeds$Custombatch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7907,7 +8029,7 @@ export namespace content_v2 { */ requestBody?: Schema$DatafeedsCustomBatchRequest; } - export interface Params$Resource$Datafeeds$Delete { + export interface Params$Resource$Datafeeds$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7927,7 +8049,8 @@ export namespace content_v2 { */ merchantId?: string; } - export interface Params$Resource$Datafeeds$Fetchnow { + export interface Params$Resource$Datafeeds$Fetchnow extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7947,7 +8070,7 @@ export namespace content_v2 { */ merchantId?: string; } - export interface Params$Resource$Datafeeds$Get { + export interface Params$Resource$Datafeeds$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7963,7 +8086,7 @@ export namespace content_v2 { */ merchantId?: string; } - export interface Params$Resource$Datafeeds$Insert { + export interface Params$Resource$Datafeeds$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7984,7 +8107,7 @@ export namespace content_v2 { */ requestBody?: Schema$Datafeed; } - export interface Params$Resource$Datafeeds$List { + export interface Params$Resource$Datafeeds$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8005,7 +8128,7 @@ export namespace content_v2 { */ pageToken?: string; } - export interface Params$Resource$Datafeeds$Patch { + export interface Params$Resource$Datafeeds$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8030,7 +8153,7 @@ export namespace content_v2 { */ requestBody?: Schema$Datafeed; } - export interface Params$Resource$Datafeeds$Update { + export interface Params$Resource$Datafeeds$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8292,7 +8415,8 @@ export namespace content_v2 { } } - export interface Params$Resource$Datafeedstatuses$Custombatch { + export interface Params$Resource$Datafeedstatuses$Custombatch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8304,7 +8428,8 @@ export namespace content_v2 { */ requestBody?: Schema$DatafeedstatusesCustomBatchRequest; } - export interface Params$Resource$Datafeedstatuses$Get { + export interface Params$Resource$Datafeedstatuses$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8334,7 +8459,8 @@ export namespace content_v2 { */ merchantId?: string; } - export interface Params$Resource$Datafeedstatuses$List { + export interface Params$Resource$Datafeedstatuses$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8517,7 +8643,8 @@ export namespace content_v2 { } } - export interface Params$Resource$Inventory$Custombatch { + export interface Params$Resource$Inventory$Custombatch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8533,7 +8660,7 @@ export namespace content_v2 { */ requestBody?: Schema$InventoryCustomBatchRequest; } - export interface Params$Resource$Inventory$Set { + export interface Params$Resource$Inventory$Set extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9021,7 +9148,7 @@ export namespace content_v2 { * * @param {object} params Parameters for request * @param {string} params.accountId The ID of the account for which GMB access is requested. - * @param {string=} params.gmbEmail The email of the Google My Business account. + * @param {string} params.gmbEmail The email of the Google My Business account. * @param {string} params.merchantId The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -9082,7 +9209,7 @@ export namespace content_v2 { }, options), params, - requiredParams: ['merchantId', 'accountId'], + requiredParams: ['merchantId', 'accountId', 'gmbEmail'], pathParams: ['accountId', 'merchantId'], context: this.getRoot() }; @@ -9187,10 +9314,10 @@ export namespace content_v2 { * * @param {object} params Parameters for request * @param {string} params.accountId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string=} params.contactEmail The email of the inventory verification contact. - * @param {string=} params.contactName The name of the inventory verification contact. - * @param {string=} params.country The country for which inventory verification is requested. - * @param {string=} params.language The language for which inventory verification is requested. + * @param {string} params.contactEmail The email of the inventory verification contact. + * @param {string} params.contactName The name of the inventory verification contact. + * @param {string} params.country The country for which inventory verification is requested. + * @param {string} params.language The language for which inventory verification is requested. * @param {string} params.merchantId The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -9252,7 +9379,10 @@ export namespace content_v2 { }, options), params, - requiredParams: ['merchantId', 'accountId'], + requiredParams: [ + 'merchantId', 'accountId', 'contactEmail', 'contactName', 'country', + 'language' + ], pathParams: ['accountId', 'merchantId'], context: this.getRoot() }; @@ -9276,7 +9406,7 @@ export namespace content_v2 { * * @param {object} params Parameters for request * @param {string} params.accountId The ID of the account for which to retrieve accessible Google My Business accounts. - * @param {string=} params.country The country for which the POS data provider is selected. + * @param {string} params.country The country for which the POS data provider is selected. * @param {string} params.merchantId The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. * @param {string=} params.posDataProviderId The ID of POS data provider. * @param {string=} params.posExternalAccountId The account ID by which this merchant is known to the POS data provider. @@ -9339,7 +9469,7 @@ export namespace content_v2 { }, options), params, - requiredParams: ['merchantId', 'accountId'], + requiredParams: ['merchantId', 'accountId', 'country'], pathParams: ['accountId', 'merchantId'], context: this.getRoot() }; @@ -9424,7 +9554,8 @@ export namespace content_v2 { } } - export interface Params$Resource$Liasettings$Custombatch { + export interface Params$Resource$Liasettings$Custombatch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9440,7 +9571,7 @@ export namespace content_v2 { */ requestBody?: Schema$LiasettingsCustomBatchRequest; } - export interface Params$Resource$Liasettings$Get { + export interface Params$Resource$Liasettings$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9457,7 +9588,8 @@ export namespace content_v2 { */ merchantId?: string; } - export interface Params$Resource$Liasettings$Getaccessiblegmbaccounts { + export interface Params$Resource$Liasettings$Getaccessiblegmbaccounts extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9475,7 +9607,7 @@ export namespace content_v2 { */ merchantId?: string; } - export interface Params$Resource$Liasettings$List { + export interface Params$Resource$Liasettings$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9495,13 +9627,15 @@ export namespace content_v2 { */ pageToken?: string; } - export interface Params$Resource$Liasettings$Listposdataproviders { + export interface Params$Resource$Liasettings$Listposdataproviders extends + StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; } - export interface Params$Resource$Liasettings$Patch { + export interface Params$Resource$Liasettings$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9527,7 +9661,8 @@ export namespace content_v2 { */ requestBody?: Schema$LiaSettings; } - export interface Params$Resource$Liasettings$Requestgmbaccess { + export interface Params$Resource$Liasettings$Requestgmbaccess extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9548,7 +9683,8 @@ export namespace content_v2 { */ merchantId?: string; } - export interface Params$Resource$Liasettings$Requestinventoryverification { + export interface Params$Resource$Liasettings$Requestinventoryverification + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9570,7 +9706,8 @@ export namespace content_v2 { */ merchantId?: string; } - export interface Params$Resource$Liasettings$Setinventoryverificationcontact { + export interface Params$Resource$Liasettings$Setinventoryverificationcontact + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9604,7 +9741,8 @@ export namespace content_v2 { */ merchantId?: string; } - export interface Params$Resource$Liasettings$Setposdataprovider { + export interface Params$Resource$Liasettings$Setposdataprovider extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9634,7 +9772,8 @@ export namespace content_v2 { */ posExternalAccountId?: string; } - export interface Params$Resource$Liasettings$Update { + export interface Params$Resource$Liasettings$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9837,7 +9976,8 @@ export namespace content_v2 { } } - export interface Params$Resource$Orderinvoices$Createchargeinvoice { + export interface Params$Resource$Orderinvoices$Createchargeinvoice extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9858,7 +9998,8 @@ export namespace content_v2 { */ requestBody?: Schema$OrderinvoicesCreateChargeInvoiceRequest; } - export interface Params$Resource$Orderinvoices$Createrefundinvoice { + export interface Params$Resource$Orderinvoices$Createrefundinvoice extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10218,7 +10359,8 @@ export namespace content_v2 { } } - export interface Params$Resource$Orderpayments$Notifyauthapproved { + export interface Params$Resource$Orderpayments$Notifyauthapproved extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10239,7 +10381,8 @@ export namespace content_v2 { */ requestBody?: Schema$OrderpaymentsNotifyAuthApprovedRequest; } - export interface Params$Resource$Orderpayments$Notifyauthdeclined { + export interface Params$Resource$Orderpayments$Notifyauthdeclined extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10260,7 +10403,8 @@ export namespace content_v2 { */ requestBody?: Schema$OrderpaymentsNotifyAuthDeclinedRequest; } - export interface Params$Resource$Orderpayments$Notifycharge { + export interface Params$Resource$Orderpayments$Notifycharge extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10281,7 +10425,8 @@ export namespace content_v2 { */ requestBody?: Schema$OrderpaymentsNotifyChargeRequest; } - export interface Params$Resource$Orderpayments$Notifyrefund { + export interface Params$Resource$Orderpayments$Notifyrefund extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10403,7 +10548,7 @@ export namespace content_v2 { /** * content.orderreports.listtransactions - * @desc Retrieves a list of transactions for an disbursement from your + * @desc Retrieves a list of transactions for a disbursement from your * Merchant Center account. * @alias content.orderreports.listtransactions * @memberOf! () @@ -10489,7 +10634,8 @@ export namespace content_v2 { } } - export interface Params$Resource$Orderreports$Listdisbursements { + export interface Params$Resource$Orderreports$Listdisbursements extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10519,7 +10665,8 @@ export namespace content_v2 { */ pageToken?: string; } - export interface Params$Resource$Orderreports$Listtransactions { + export interface Params$Resource$Orderreports$Listtransactions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10703,7 +10850,7 @@ export namespace content_v2 { } } - export interface Params$Resource$Orderreturns$Get { + export interface Params$Resource$Orderreturns$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -10719,7 +10866,8 @@ export namespace content_v2 { */ returnId?: string; } - export interface Params$Resource$Orderreturns$List { + export interface Params$Resource$Orderreturns$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12472,7 +12620,8 @@ export namespace content_v2 { } } - export interface Params$Resource$Orders$Acknowledge { + export interface Params$Resource$Orders$Acknowledge extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12493,7 +12642,8 @@ export namespace content_v2 { */ requestBody?: Schema$OrdersAcknowledgeRequest; } - export interface Params$Resource$Orders$Advancetestorder { + export interface Params$Resource$Orders$Advancetestorder extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12509,7 +12659,7 @@ export namespace content_v2 { */ orderId?: string; } - export interface Params$Resource$Orders$Cancel { + export interface Params$Resource$Orders$Cancel extends StandardParameters { /** * Auth client or API Key for the request */ @@ -12530,7 +12680,8 @@ export namespace content_v2 { */ requestBody?: Schema$OrdersCancelRequest; } - export interface Params$Resource$Orders$Cancellineitem { + export interface Params$Resource$Orders$Cancellineitem extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12551,7 +12702,8 @@ export namespace content_v2 { */ requestBody?: Schema$OrdersCancelLineItemRequest; } - export interface Params$Resource$Orders$Canceltestorderbycustomer { + export interface Params$Resource$Orders$Canceltestorderbycustomer extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12572,7 +12724,8 @@ export namespace content_v2 { */ requestBody?: Schema$OrdersCancelTestOrderByCustomerRequest; } - export interface Params$Resource$Orders$Createtestorder { + export interface Params$Resource$Orders$Createtestorder extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12589,7 +12742,8 @@ export namespace content_v2 { */ requestBody?: Schema$OrdersCreateTestOrderRequest; } - export interface Params$Resource$Orders$Createtestreturn { + export interface Params$Resource$Orders$Createtestreturn extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12610,7 +12764,8 @@ export namespace content_v2 { */ requestBody?: Schema$OrdersCreateTestReturnRequest; } - export interface Params$Resource$Orders$Custombatch { + export interface Params$Resource$Orders$Custombatch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12622,7 +12777,7 @@ export namespace content_v2 { */ requestBody?: Schema$OrdersCustomBatchRequest; } - export interface Params$Resource$Orders$Get { + export interface Params$Resource$Orders$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -12638,7 +12793,8 @@ export namespace content_v2 { */ orderId?: string; } - export interface Params$Resource$Orders$Getbymerchantorderid { + export interface Params$Resource$Orders$Getbymerchantorderid extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12654,7 +12810,8 @@ export namespace content_v2 { */ merchantOrderId?: string; } - export interface Params$Resource$Orders$Gettestordertemplate { + export interface Params$Resource$Orders$Gettestordertemplate extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12674,7 +12831,8 @@ export namespace content_v2 { */ templateName?: string; } - export interface Params$Resource$Orders$Instorerefundlineitem { + export interface Params$Resource$Orders$Instorerefundlineitem extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12695,7 +12853,7 @@ export namespace content_v2 { */ requestBody?: Schema$OrdersInStoreRefundLineItemRequest; } - export interface Params$Resource$Orders$List { + export interface Params$Resource$Orders$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -12751,7 +12909,7 @@ export namespace content_v2 { */ statuses?: string; } - export interface Params$Resource$Orders$Refund { + export interface Params$Resource$Orders$Refund extends StandardParameters { /** * Auth client or API Key for the request */ @@ -12772,7 +12930,8 @@ export namespace content_v2 { */ requestBody?: Schema$OrdersRefundRequest; } - export interface Params$Resource$Orders$Rejectreturnlineitem { + export interface Params$Resource$Orders$Rejectreturnlineitem extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12793,7 +12952,8 @@ export namespace content_v2 { */ requestBody?: Schema$OrdersRejectReturnLineItemRequest; } - export interface Params$Resource$Orders$Returnlineitem { + export interface Params$Resource$Orders$Returnlineitem extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12814,7 +12974,8 @@ export namespace content_v2 { */ requestBody?: Schema$OrdersReturnLineItemRequest; } - export interface Params$Resource$Orders$Returnrefundlineitem { + export interface Params$Resource$Orders$Returnrefundlineitem extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12835,7 +12996,8 @@ export namespace content_v2 { */ requestBody?: Schema$OrdersReturnRefundLineItemRequest; } - export interface Params$Resource$Orders$Setlineitemmetadata { + export interface Params$Resource$Orders$Setlineitemmetadata extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12856,7 +13018,8 @@ export namespace content_v2 { */ requestBody?: Schema$OrdersSetLineItemMetadataRequest; } - export interface Params$Resource$Orders$Shiplineitems { + export interface Params$Resource$Orders$Shiplineitems extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12877,7 +13040,8 @@ export namespace content_v2 { */ requestBody?: Schema$OrdersShipLineItemsRequest; } - export interface Params$Resource$Orders$Updatelineitemshippingdetails { + export interface Params$Resource$Orders$Updatelineitemshippingdetails extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12898,7 +13062,8 @@ export namespace content_v2 { */ requestBody?: Schema$OrdersUpdateLineItemShippingDetailsRequest; } - export interface Params$Resource$Orders$Updatemerchantorderid { + export interface Params$Resource$Orders$Updatemerchantorderid extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12919,7 +13084,8 @@ export namespace content_v2 { */ requestBody?: Schema$OrdersUpdateMerchantOrderIdRequest; } - export interface Params$Resource$Orders$Updateshipment { + export interface Params$Resource$Orders$Updateshipment extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13431,7 +13597,7 @@ export namespace content_v2 { } } - export interface Params$Resource$Pos$Custombatch { + export interface Params$Resource$Pos$Custombatch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -13447,7 +13613,7 @@ export namespace content_v2 { */ requestBody?: Schema$PosCustomBatchRequest; } - export interface Params$Resource$Pos$Delete { + export interface Params$Resource$Pos$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -13470,7 +13636,7 @@ export namespace content_v2 { */ targetMerchantId?: string; } - export interface Params$Resource$Pos$Get { + export interface Params$Resource$Pos$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -13489,7 +13655,7 @@ export namespace content_v2 { */ targetMerchantId?: string; } - export interface Params$Resource$Pos$Insert { + export interface Params$Resource$Pos$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -13513,7 +13679,7 @@ export namespace content_v2 { */ requestBody?: Schema$PosStore; } - export interface Params$Resource$Pos$Inventory { + export interface Params$Resource$Pos$Inventory extends StandardParameters { /** * Auth client or API Key for the request */ @@ -13537,7 +13703,7 @@ export namespace content_v2 { */ requestBody?: Schema$PosInventoryRequest; } - export interface Params$Resource$Pos$List { + export interface Params$Resource$Pos$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -13552,7 +13718,7 @@ export namespace content_v2 { */ targetMerchantId?: string; } - export interface Params$Resource$Pos$Sale { + export interface Params$Resource$Pos$Sale extends StandardParameters { /** * Auth client or API Key for the request */ @@ -13929,7 +14095,8 @@ export namespace content_v2 { } } - export interface Params$Resource$Products$Custombatch { + export interface Params$Resource$Products$Custombatch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13945,7 +14112,7 @@ export namespace content_v2 { */ requestBody?: Schema$ProductsCustomBatchRequest; } - export interface Params$Resource$Products$Delete { + export interface Params$Resource$Products$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -13965,7 +14132,7 @@ export namespace content_v2 { */ productId?: string; } - export interface Params$Resource$Products$Get { + export interface Params$Resource$Products$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -13981,7 +14148,7 @@ export namespace content_v2 { */ productId?: string; } - export interface Params$Resource$Products$Insert { + export interface Params$Resource$Products$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -14002,7 +14169,7 @@ export namespace content_v2 { */ requestBody?: Schema$Product; } - export interface Params$Resource$Products$List { + export interface Params$Resource$Products$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -14267,7 +14434,8 @@ export namespace content_v2 { } } - export interface Params$Resource$Productstatuses$Custombatch { + export interface Params$Resource$Productstatuses$Custombatch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14284,7 +14452,8 @@ export namespace content_v2 { */ requestBody?: Schema$ProductstatusesCustomBatchRequest; } - export interface Params$Resource$Productstatuses$Get { + export interface Params$Resource$Productstatuses$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14310,7 +14479,8 @@ export namespace content_v2 { */ productId?: string; } - export interface Params$Resource$Productstatuses$List { + export interface Params$Resource$Productstatuses$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14883,7 +15053,8 @@ export namespace content_v2 { } } - export interface Params$Resource$Shippingsettings$Custombatch { + export interface Params$Resource$Shippingsettings$Custombatch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14899,7 +15070,8 @@ export namespace content_v2 { */ requestBody?: Schema$ShippingsettingsCustomBatchRequest; } - export interface Params$Resource$Shippingsettings$Get { + export interface Params$Resource$Shippingsettings$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14916,7 +15088,8 @@ export namespace content_v2 { */ merchantId?: string; } - export interface Params$Resource$Shippingsettings$Getsupportedcarriers { + export interface Params$Resource$Shippingsettings$Getsupportedcarriers extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14927,7 +15100,8 @@ export namespace content_v2 { */ merchantId?: string; } - export interface Params$Resource$Shippingsettings$Getsupportedholidays { + export interface Params$Resource$Shippingsettings$Getsupportedholidays extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14938,7 +15112,8 @@ export namespace content_v2 { */ merchantId?: string; } - export interface Params$Resource$Shippingsettings$List { + export interface Params$Resource$Shippingsettings$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14958,7 +15133,8 @@ export namespace content_v2 { */ pageToken?: string; } - export interface Params$Resource$Shippingsettings$Patch { + export interface Params$Resource$Shippingsettings$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14984,7 +15160,8 @@ export namespace content_v2 { */ requestBody?: Schema$ShippingSettings; } - export interface Params$Resource$Shippingsettings$Update { + export interface Params$Resource$Shippingsettings$Update extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/content/v2sandbox.ts b/src/apis/content/v2sandbox.ts deleted file mode 100644 index e073d873fc..0000000000 --- a/src/apis/content/v2sandbox.ts +++ /dev/null @@ -1,5283 +0,0 @@ -/** - * 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 content_v2sandbox { - export interface Options extends GlobalOptions { - version: 'v2sandbox'; - } - - /** - * Content API for Shopping - * - * Manages product items, inventory, and Merchant Center accounts for Google - * Shopping. - * - * @example - * const {google} = require('googleapis'); - * const content = google.content('v2sandbox'); - * - * @namespace content - * @type {Function} - * @version v2sandbox - * @variation v2sandbox - * @param {object=} options Options for Content - */ - export class Content { - _options: GlobalOptions; - google?: GoogleConfigurable; - root = this; - - orderinvoices: Resource$Orderinvoices; - orderpayments: Resource$Orderpayments; - orderreturns: Resource$Orderreturns; - orders: Resource$Orders; - - constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this._options = options || {}; - this.google = google; - this.getRoot.bind(this); - - this.orderinvoices = new Resource$Orderinvoices(this); - this.orderpayments = new Resource$Orderpayments(this); - this.orderreturns = new Resource$Orderreturns(this); - this.orders = new Resource$Orders(this); - } - - getRoot() { - return this.root; - } - } - - export interface Schema$Amount { - /** - * [required] Value before taxes. - */ - pretax?: Schema$Price; - /** - * [required] Tax value. - */ - tax?: Schema$Price; - } - export interface Schema$CustomerReturnReason { - description?: string; - reasonCode?: string; - } - /** - * An error returned by the API. - */ - export interface Schema$Error { - /** - * The domain of the error. - */ - domain?: string; - /** - * A description of the error. - */ - message?: string; - /** - * The error code. - */ - reason?: string; - } - /** - * A list of errors returned by a failed batch entry. - */ - export interface Schema$Errors { - /** - * The HTTP status of the first error in errors. - */ - code?: number; - /** - * A list of errors. - */ - errors?: Schema$Error[]; - /** - * The message of the first error in errors. - */ - message?: string; - } - export interface Schema$InvoiceSummary { - /** - * Summary of the total amounts of the additional charges. - */ - additionalChargeSummaries?: Schema$InvoiceSummaryAdditionalChargeSummary[]; - /** - * [required] Customer balance on this invoice. A negative amount means the - * customer is paying, a positive one means the customer is receiving money. - * Note: the sum of merchant_balance, customer_balance and google_balance - * must always be zero. Furthermore the absolute value of this amount is - * expected to be equal to the sum of product amount and additional charges, - * minus promotions. - */ - customerBalance?: Schema$Amount; - /** - * [required] Google balance on this invoice. A negative amount means Google - * is paying, a positive one means Google is receiving money. Note: the sum - * of merchant_balance, customer_balance and google_balance must always be - * zero. - */ - googleBalance?: Schema$Amount; - /** - * [required] Merchant balance on this invoice. A negative amount means the - * merchant is paying, a positive one means the merchant is receiving money. - * Note: the sum of merchant_balance, customer_balance and google_balance - * must always be zero. - */ - merchantBalance?: Schema$Amount; - /** - * [required] Total price for the product. - */ - productTotal?: Schema$Amount; - /** - * Summary for each promotion. - */ - promotionSummaries?: Schema$Promotion[]; - } - export interface Schema$InvoiceSummaryAdditionalChargeSummary { - /** - * [required] Total additional charge for this type. - */ - totalAmount?: Schema$Amount; - /** - * [required] Type of the additional charge. - */ - type?: string; - } - export interface Schema$MerchantOrderReturn { - creationDate?: string; - merchantOrderId?: string; - orderId?: string; - orderReturnId?: string; - returnItems?: Schema$MerchantOrderReturnItem[]; - returnShipments?: Schema$ReturnShipment[]; - } - export interface Schema$MerchantOrderReturnItem { - customerReturnReason?: Schema$CustomerReturnReason; - itemId?: string; - merchantReturnReason?: Schema$RefundReason; - product?: Schema$OrderLineItemProduct; - returnShipmentIds?: string[]; - state?: string; - } - export interface Schema$Order { - /** - * Whether the order was acknowledged. - */ - acknowledged?: boolean; - /** - * The channel type of the order: "purchaseOnGoogle" or - * "googleExpress". - */ - channelType?: string; - /** - * The details of the customer who placed the order. - */ - customer?: Schema$OrderCustomer; - /** - * The details for the delivery. - */ - deliveryDetails?: Schema$OrderDeliveryDetails; - /** - * The REST id of the order. Globally unique. - */ - id?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#order". - */ - kind?: string; - /** - * Line items that are ordered. - */ - lineItems?: Schema$OrderLineItem[]; - merchantId?: string; - /** - * Merchant-provided id of the order. - */ - merchantOrderId?: string; - /** - * The net amount for the order. For example, if an order was originally for - * a grand total of $100 and a refund was issued for $20, the net amount - * will be $80. - */ - netAmount?: Schema$Price; - /** - * The details of the payment method. - */ - paymentMethod?: Schema$OrderPaymentMethod; - /** - * The status of the payment. - */ - paymentStatus?: string; - /** - * The date when the order was placed, in ISO 8601 format. - */ - placedDate?: string; - /** - * Deprecated. The details of the merchant provided promotions applied to - * the order. More details about the program are here. - */ - promotions?: Schema$OrderLegacyPromotion[]; - /** - * Refunds for the order. - */ - refunds?: Schema$OrderRefund[]; - /** - * Shipments of the order. - */ - shipments?: Schema$OrderShipment[]; - /** - * The total cost of shipping for all items. - */ - shippingCost?: Schema$Price; - /** - * The tax for the total shipping cost. - */ - shippingCostTax?: Schema$Price; - /** - * The requested shipping option. - */ - shippingOption?: string; - /** - * The status of the order. - */ - status?: string; - } - export interface Schema$OrderAddress { - /** - * CLDR country code (e.g. "US"). - */ - country?: string; - /** - * Strings representing the lines of the printed label for mailing the - * order, for example: John Smith 1600 Amphitheatre Parkway Mountain View, - * CA, 94043 United States - */ - fullAddress?: string[]; - /** - * Whether the address is a post office box. - */ - isPostOfficeBox?: boolean; - /** - * City, town or commune. May also include dependent localities or - * sublocalities (e.g. neighborhoods or suburbs). - */ - locality?: string; - /** - * Postal Code or ZIP (e.g. "94043"). - */ - postalCode?: string; - /** - * Name of the recipient. - */ - recipientName?: string; - /** - * Top-level administrative subdivision of the country. For example, a state - * like California ("CA") or a province like Quebec - * ("QC"). - */ - region?: string; - /** - * Street-level part of the address. - */ - streetAddress?: string[]; - } - export interface Schema$OrderCancellation { - /** - * The actor that created the cancellation. - */ - actor?: string; - /** - * Date on which the cancellation has been created, in ISO 8601 format. - */ - creationDate?: string; - /** - * The quantity that was canceled. - */ - quantity?: number; - /** - * The reason for the cancellation. Orders that are cancelled with a - * noInventory reason will lead to the removal of the product from Shopping - * Actions until you make an update to that product. This will not affect - * your Shopping ads. - */ - reason?: string; - /** - * The explanation of the reason. - */ - reasonText?: string; - } - export interface Schema$OrderCustomer { - /** - * Deprecated. - */ - email?: string; - /** - * Deprecated. Please use marketingRightsInfo instead. - */ - explicitMarketingPreference?: boolean; - /** - * Full name of the customer. - */ - fullName?: string; - /** - * Customer's marketing preferences. - */ - marketingRightsInfo?: Schema$OrderCustomerMarketingRightsInfo; - } - export interface Schema$OrderCustomerMarketingRightsInfo { - /** - * Last known user selection regarding marketing preferences. In certain - * cases this selection might not be known, so this field would be empty. - */ - explicitMarketingPreference?: string; - /** - * Timestamp when last time marketing preference was updated. Could be - * empty, if user wasn't offered a selection yet. - */ - lastUpdatedTimestamp?: string; - /** - * Email address that can be used for marketing purposes. This field is only - * filled when explicitMarketingPreference is equal to 'granted'. - */ - marketingEmailAddress?: string; - } - export interface Schema$OrderDeliveryDetails { - /** - * The delivery address - */ - address?: Schema$OrderAddress; - /** - * The phone number of the person receiving the delivery. - */ - phoneNumber?: string; - } - export interface Schema$OrderinvoicesCreateChargeInvoiceRequest { - /** - * [required] The ID of the invoice. - */ - invoiceId?: string; - /** - * [required] Invoice summary. - */ - invoiceSummary?: Schema$InvoiceSummary; - /** - * [required] Invoice details per line item. - */ - lineItemInvoices?: Schema$ShipmentInvoiceLineItemInvoice[]; - /** - * [required] The ID of the operation, unique across all operations for a - * given order. - */ - operationId?: string; - /** - * [required] ID of the shipment group. - */ - shipmentGroupId?: string; - } - export interface Schema$OrderinvoicesCreateChargeInvoiceResponse { - /** - * The status of the execution. - */ - executionStatus?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#orderinvoicesCreateChargeInvoiceResponse". - */ - kind?: string; - } - export interface Schema$OrderinvoicesCreateRefundInvoiceRequest { - /** - * [required] The ID of the invoice. - */ - invoiceId?: string; - /** - * [required] The ID of the operation, unique across all operations for a - * given order. - */ - operationId?: string; - /** - * Option to create a refund-only invoice. Exactly one of refundOnlyOption - * or returnOption must be provided. - */ - refundOnlyOption?: - Schema$OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption; - /** - * Option to create an invoice for a refund and mark all items within the - * invoice as returned. Exactly one of refundOnlyOption or returnOption must - * be provided. - */ - returnOption?: - Schema$OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption; - /** - * Invoice details for different shipment groups. - */ - shipmentInvoices?: Schema$ShipmentInvoice[]; - } - export interface Schema$OrderinvoicesCreateRefundInvoiceResponse { - /** - * The status of the execution. - */ - executionStatus?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#orderinvoicesCreateRefundInvoiceResponse". - */ - kind?: string; - } - export interface Schema$OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption { - /** - * Optional description of the refund reason. - */ - description?: string; - /** - * [required] Reason for the refund. - */ - reason?: string; - } - export interface Schema$OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption { - /** - * Optional description of the return reason. - */ - description?: string; - /** - * [required] Reason for the return. - */ - reason?: string; - } - export interface Schema$OrderLegacyPromotion { - benefits?: Schema$OrderLegacyPromotionBenefit[]; - /** - * The date and time frame when the promotion is active and ready for - * validation review. Note that the promotion live time may be delayed for a - * few hours due to the validation review. Start date and end date are - * separated by a forward slash (/). The start date is specified by the - * format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when - * the sale starts (in Greenwich Mean Time, GMT), followed by an expression - * of the time zone for the sale. The end date is in the same format. - */ - effectiveDates?: string; - /** - * Optional. The text code that corresponds to the promotion when applied on - * the retailer?s website. - */ - genericRedemptionCode?: string; - /** - * The unique ID of the promotion. - */ - id?: string; - /** - * The full title of the promotion. - */ - longTitle?: string; - /** - * Whether the promotion is applicable to all products or only specific - * products. - */ - productApplicability?: string; - /** - * Indicates that the promotion is valid online. - */ - redemptionChannel?: string; - } - export interface Schema$OrderLegacyPromotionBenefit { - /** - * The discount in the order price when the promotion is applied. - */ - discount?: Schema$Price; - /** - * The OfferId(s) that were purchased in this order and map to this specific - * benefit of the promotion. - */ - offerIds?: string[]; - /** - * Further describes the benefit of the promotion. Note that we will expand - * on this enumeration as we support new promotion sub-types. - */ - subType?: string; - /** - * The impact on tax when the promotion is applied. - */ - taxImpact?: Schema$Price; - /** - * Describes whether the promotion applies to products (e.g. 20% off) or to - * shipping (e.g. Free Shipping). - */ - type?: string; - } - export interface Schema$OrderLineItem { - /** - * Annotations that are attached to the line item. - */ - annotations?: Schema$OrderMerchantProvidedAnnotation[]; - /** - * Cancellations of the line item. - */ - cancellations?: Schema$OrderCancellation[]; - /** - * The id of the line item. - */ - id?: string; - /** - * Total price for the line item. For example, if two items for $10 are - * purchased, the total price will be $20. - */ - price?: Schema$Price; - /** - * Product data from the time of the order placement. - */ - product?: Schema$OrderLineItemProduct; - /** - * Number of items canceled. - */ - quantityCanceled?: number; - /** - * Number of items delivered. - */ - quantityDelivered?: number; - /** - * Number of items ordered. - */ - quantityOrdered?: number; - /** - * Number of items pending. - */ - quantityPending?: number; - /** - * Number of items returned. - */ - quantityReturned?: number; - /** - * Number of items shipped. - */ - quantityShipped?: number; - /** - * Details of the return policy for the line item. - */ - returnInfo?: Schema$OrderLineItemReturnInfo; - /** - * Returns of the line item. - */ - returns?: Schema$OrderReturn[]; - /** - * Details of the requested shipping for the line item. - */ - shippingDetails?: Schema$OrderLineItemShippingDetails; - /** - * Total tax amount for the line item. For example, if two items are - * purchased, and each have a cost tax of $2, the total tax amount will be - * $4. - */ - tax?: Schema$Price; - } - export interface Schema$OrderLineItemProduct { - /** - * Brand of the item. - */ - brand?: string; - /** - * The item's channel (online or local). - */ - channel?: string; - /** - * Condition or state of the item. - */ - condition?: string; - /** - * The two-letter ISO 639-1 language code for the item. - */ - contentLanguage?: string; - /** - * Global Trade Item Number (GTIN) of the item. - */ - gtin?: string; - /** - * The REST id of the product. - */ - id?: string; - /** - * URL of an image of the item. - */ - imageLink?: string; - /** - * Shared identifier for all variants of the same product. - */ - itemGroupId?: string; - /** - * Manufacturer Part Number (MPN) of the item. - */ - mpn?: string; - /** - * An identifier of the item. - */ - offerId?: string; - /** - * Price of the item. - */ - price?: Schema$Price; - /** - * URL to the cached image shown to the user when order was placed. - */ - shownImage?: string; - /** - * The CLDR territory code of the target country of the product. - */ - targetCountry?: string; - /** - * The title of the product. - */ - title?: string; - /** - * Variant attributes for the item. These are dimensions of the product, - * such as color, gender, material, pattern, and size. You can find a - * comprehensive list of variant attributes here. - */ - variantAttributes?: Schema$OrderLineItemProductVariantAttribute[]; - } - export interface Schema$OrderLineItemProductVariantAttribute { - /** - * The dimension of the variant. - */ - dimension?: string; - /** - * The value for the dimension. - */ - value?: string; - } - export interface Schema$OrderLineItemReturnInfo { - /** - * How many days later the item can be returned. - */ - daysToReturn?: number; - /** - * Whether the item is returnable. - */ - isReturnable?: boolean; - /** - * URL of the item return policy. - */ - policyUrl?: string; - } - export interface Schema$OrderLineItemShippingDetails { - /** - * The delivery by date, in ISO 8601 format. - */ - deliverByDate?: string; - /** - * Details of the shipping method. - */ - method?: Schema$OrderLineItemShippingDetailsMethod; - /** - * The ship by date, in ISO 8601 format. - */ - shipByDate?: string; - } - export interface Schema$OrderLineItemShippingDetailsMethod { - /** - * The carrier for the shipping. Optional. See shipments[].carrier for a - * list of acceptable values. - */ - carrier?: string; - /** - * Maximum transit time. - */ - maxDaysInTransit?: number; - /** - * The name of the shipping method. - */ - methodName?: string; - /** - * Minimum transit time. - */ - minDaysInTransit?: number; - } - export interface Schema$OrderMerchantProvidedAnnotation { - /** - * Key for additional merchant provided (as key-value pairs) annotation - * about the line item. - */ - key?: string; - /** - * Value for additional merchant provided (as key-value pairs) annotation - * about the line item. - */ - value?: string; - } - export interface Schema$OrderPaymentMethod { - /** - * The billing address. - */ - billingAddress?: Schema$OrderAddress; - /** - * The card expiration month (January = 1, February = 2 etc.). - */ - expirationMonth?: number; - /** - * The card expiration year (4-digit, e.g. 2015). - */ - expirationYear?: number; - /** - * The last four digits of the card number. - */ - lastFourDigits?: string; - /** - * The billing phone number. - */ - phoneNumber?: string; - /** - * The type of instrument. Acceptable values are: - "AMEX" - - * "DISCOVER" - "JCB" - "MASTERCARD" - - * "UNIONPAY" - "VISA" - "" - */ - type?: string; - } - export interface Schema$OrderpaymentsNotifyAuthApprovedRequest { - authAmountPretax?: Schema$Price; - authAmountTax?: Schema$Price; - } - export interface Schema$OrderpaymentsNotifyAuthApprovedResponse { - /** - * The status of the execution. - */ - executionStatus?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#orderpaymentsNotifyAuthApprovedResponse". - */ - kind?: string; - } - export interface Schema$OrderpaymentsNotifyAuthDeclinedRequest { - /** - * Reason why payment authorization was declined. - */ - declineReason?: string; - } - export interface Schema$OrderpaymentsNotifyAuthDeclinedResponse { - /** - * The status of the execution. - */ - executionStatus?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#orderpaymentsNotifyAuthDeclinedResponse". - */ - kind?: string; - } - export interface Schema$OrderpaymentsNotifyChargeRequest { - /** - * Whether charge was successful. - */ - chargeState?: string; - /** - * Deprecated. Please use invoiceIds instead. - */ - invoiceId?: string; - /** - * Invoice IDs from the orderinvoices service that correspond to the charge. - */ - invoiceIds?: string[]; - } - export interface Schema$OrderpaymentsNotifyChargeResponse { - /** - * The status of the execution. - */ - executionStatus?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#orderpaymentsNotifyChargeResponse". - */ - kind?: string; - } - export interface Schema$OrderpaymentsNotifyRefundRequest { - /** - * Deprecated. Please use invoiceIds instead. - */ - invoiceId?: string; - /** - * Invoice IDs from the orderinvoices service that correspond to the refund. - */ - invoiceIds?: string[]; - /** - * Whether refund was successful. - */ - refundState?: string; - } - export interface Schema$OrderpaymentsNotifyRefundResponse { - /** - * The status of the execution. - */ - executionStatus?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#orderpaymentsNotifyRefundResponse". - */ - kind?: string; - } - export interface Schema$OrderRefund { - /** - * The actor that created the refund. - */ - actor?: string; - /** - * The amount that is refunded. - */ - amount?: Schema$Price; - /** - * Date on which the item has been created, in ISO 8601 format. - */ - creationDate?: string; - /** - * The reason for the refund. - */ - reason?: string; - /** - * The explanation of the reason. - */ - reasonText?: string; - } - export interface Schema$OrderReturn { - /** - * The actor that created the refund. - */ - actor?: string; - /** - * Date on which the item has been created, in ISO 8601 format. - */ - creationDate?: string; - /** - * Quantity that is returned. - */ - quantity?: number; - /** - * The reason for the return. - */ - reason?: string; - /** - * The explanation of the reason. - */ - reasonText?: string; - } - export interface Schema$OrderreturnsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#orderreturnsListResponse". - */ - kind?: string; - /** - * The token for the retrieval of the next page of returns. - */ - nextPageToken?: string; - resources?: Schema$MerchantOrderReturn[]; - } - export interface Schema$OrdersAcknowledgeRequest { - /** - * The ID of the operation. Unique across all operations for a given order. - */ - operationId?: string; - } - export interface Schema$OrdersAcknowledgeResponse { - /** - * The status of the execution. - */ - executionStatus?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersAcknowledgeResponse". - */ - kind?: string; - } - export interface Schema$OrdersAdvanceTestOrderResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersAdvanceTestOrderResponse". - */ - kind?: string; - } - export interface Schema$OrdersCancelLineItemRequest { - /** - * Deprecated. Please use amountPretax and amountTax instead. - */ - amount?: Schema$Price; - /** - * Amount to refund for the cancelation. Optional. If not set, Google will - * calculate the default based on the price and tax of the items involved. - * The amount must not be larger than the net amount left on the order. - */ - amountPretax?: Schema$Price; - /** - * Tax amount that correspond to cancellation amount in amountPretax. - */ - amountTax?: Schema$Price; - /** - * The ID of the line item to cancel. Either lineItemId or productId is - * required. - */ - lineItemId?: string; - /** - * The ID of the operation. Unique across all operations for a given order. - */ - operationId?: string; - /** - * The ID of the product to cancel. This is the REST ID used in the products - * service. Either lineItemId or productId is required. - */ - productId?: string; - /** - * The quantity to cancel. - */ - quantity?: number; - /** - * The reason for the cancellation. - */ - reason?: string; - /** - * The explanation of the reason. - */ - reasonText?: string; - } - export interface Schema$OrdersCancelLineItemResponse { - /** - * The status of the execution. - */ - executionStatus?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersCancelLineItemResponse". - */ - kind?: string; - } - export interface Schema$OrdersCancelRequest { - /** - * The ID of the operation. Unique across all operations for a given order. - */ - operationId?: string; - /** - * The reason for the cancellation. - */ - reason?: string; - /** - * The explanation of the reason. - */ - reasonText?: string; - } - export interface Schema$OrdersCancelResponse { - /** - * The status of the execution. - */ - executionStatus?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersCancelResponse". - */ - kind?: string; - } - export interface Schema$OrdersCancelTestOrderByCustomerRequest { - /** - * The reason for the cancellation. - */ - reason?: string; - } - export interface Schema$OrdersCancelTestOrderByCustomerResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersCancelTestOrderByCustomerResponse". - */ - kind?: string; - } - export interface Schema$OrdersCreateTestOrderRequest { - /** - * The CLDR territory code of the country of the test order to create. - * Affects the currency and addresses of orders created via template_name, - * or the addresses of orders created via test_order. Acceptable values - * are: - "US" - "FR" Defaults to US. - */ - country?: string; - /** - * The test order template to use. Specify as an alternative to testOrder as - * a shortcut for retrieving a template and then creating an order using - * that template. - */ - templateName?: string; - /** - * The test order to create. - */ - testOrder?: Schema$TestOrder; - } - export interface Schema$OrdersCreateTestOrderResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersCreateTestOrderResponse". - */ - kind?: string; - /** - * The ID of the newly created test order. - */ - orderId?: string; - } - export interface Schema$OrdersCreateTestReturnRequest { - /** - * Returned items. - */ - items?: Schema$OrdersCustomBatchRequestEntryCreateTestReturnReturnItem[]; - } - export interface Schema$OrdersCreateTestReturnResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersCreateTestReturnResponse". - */ - kind?: string; - /** - * The ID of the newly created test order return. - */ - returnId?: string; - } - export interface Schema$OrdersCustomBatchRequest { - /** - * The request entries to be processed in the batch. - */ - entries?: Schema$OrdersCustomBatchRequestEntry[]; - } - export interface Schema$OrdersCustomBatchRequestEntry { - /** - * An entry ID, unique within the batch request. - */ - batchId?: number; - /** - * Required for cancel method. - */ - cancel?: Schema$OrdersCustomBatchRequestEntryCancel; - /** - * Required for cancelLineItem method. - */ - cancelLineItem?: Schema$OrdersCustomBatchRequestEntryCancelLineItem; - /** - * Required for inStoreReturnLineItem method. - */ - inStoreRefundLineItem?: - Schema$OrdersCustomBatchRequestEntryInStoreRefundLineItem; - /** - * The ID of the managing account. - */ - merchantId?: string; - /** - * The merchant order id. Required for updateMerchantOrderId and - * getByMerchantOrderId methods. - */ - merchantOrderId?: string; - /** - * The method to apply. - */ - method?: string; - /** - * The ID of the operation. Unique across all operations for a given order. - * Required for all methods beside get and getByMerchantOrderId. - */ - operationId?: string; - /** - * The ID of the order. Required for all methods beside - * getByMerchantOrderId. - */ - orderId?: string; - /** - * Required for refund method. - */ - refund?: Schema$OrdersCustomBatchRequestEntryRefund; - /** - * Required for rejectReturnLineItem method. - */ - rejectReturnLineItem?: - Schema$OrdersCustomBatchRequestEntryRejectReturnLineItem; - /** - * Required for returnLineItem method. - */ - returnLineItem?: Schema$OrdersCustomBatchRequestEntryReturnLineItem; - /** - * Required for returnRefundLineItem method. - */ - returnRefundLineItem?: - Schema$OrdersCustomBatchRequestEntryReturnRefundLineItem; - /** - * Required for setLineItemMetadata method. - */ - setLineItemMetadata?: - Schema$OrdersCustomBatchRequestEntrySetLineItemMetadata; - /** - * Required for shipLineItems method. - */ - shipLineItems?: Schema$OrdersCustomBatchRequestEntryShipLineItems; - /** - * Required for updateLineItemShippingDate method. - */ - updateLineItemShippingDetails?: - Schema$OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails; - /** - * Required for updateShipment method. - */ - updateShipment?: Schema$OrdersCustomBatchRequestEntryUpdateShipment; - } - export interface Schema$OrdersCustomBatchRequestEntryCancel { - /** - * The reason for the cancellation. - */ - reason?: string; - /** - * The explanation of the reason. - */ - reasonText?: string; - } - export interface Schema$OrdersCustomBatchRequestEntryCancelLineItem { - /** - * Deprecated. Please use amountPretax and amountTax instead. - */ - amount?: Schema$Price; - /** - * Amount to refund for the cancelation. Optional. If not set, Google will - * calculate the default based on the price and tax of the items involved. - * The amount must not be larger than the net amount left on the order. - */ - amountPretax?: Schema$Price; - /** - * Tax amount that correspond to cancellation amount in amountPretax. - */ - amountTax?: Schema$Price; - /** - * The ID of the line item to cancel. Either lineItemId or productId is - * required. - */ - lineItemId?: string; - /** - * The ID of the product to cancel. This is the REST ID used in the products - * service. Either lineItemId or productId is required. - */ - productId?: string; - /** - * The quantity to cancel. - */ - quantity?: number; - /** - * The reason for the cancellation. - */ - reason?: string; - /** - * The explanation of the reason. - */ - reasonText?: string; - } - export interface Schema$OrdersCustomBatchRequestEntryCreateTestReturnReturnItem { - /** - * The ID of the line item to return. - */ - lineItemId?: string; - /** - * Quantity that is returned. - */ - quantity?: number; - } - export interface Schema$OrdersCustomBatchRequestEntryInStoreRefundLineItem { - /** - * The amount that is refunded. Required. - */ - amountPretax?: Schema$Price; - /** - * Tax amount that correspond to refund amount in amountPretax. Required. - */ - amountTax?: Schema$Price; - /** - * The ID of the line item to return. Either lineItemId or productId is - * required. - */ - lineItemId?: string; - /** - * The ID of the product to return. This is the REST ID used in the products - * service. Either lineItemId or productId is required. - */ - productId?: string; - /** - * The quantity to return and refund. - */ - quantity?: number; - /** - * The reason for the return. - */ - reason?: string; - /** - * The explanation of the reason. - */ - reasonText?: string; - } - export interface Schema$OrdersCustomBatchRequestEntryRefund { - /** - * Deprecated. Please use amountPretax and amountTax instead. - */ - amount?: Schema$Price; - /** - * The amount that is refunded. Either amount or amountPretax and amountTax - * should be filled. - */ - amountPretax?: Schema$Price; - /** - * Tax amount that correspond to refund amount in amountPretax. - */ - amountTax?: Schema$Price; - /** - * The reason for the refund. - */ - reason?: string; - /** - * The explanation of the reason. - */ - reasonText?: string; - } - export interface Schema$OrdersCustomBatchRequestEntryRejectReturnLineItem { - /** - * The ID of the line item to return. Either lineItemId or productId is - * required. - */ - lineItemId?: string; - /** - * The ID of the product to return. This is the REST ID used in the products - * service. Either lineItemId or productId is required. - */ - productId?: string; - /** - * The quantity to return and refund. - */ - quantity?: number; - /** - * The reason for the return. - */ - reason?: string; - /** - * The explanation of the reason. - */ - reasonText?: string; - } - export interface Schema$OrdersCustomBatchRequestEntryReturnLineItem { - /** - * The ID of the line item to return. Either lineItemId or productId is - * required. - */ - lineItemId?: string; - /** - * The ID of the product to return. This is the REST ID used in the products - * service. Either lineItemId or productId is required. - */ - productId?: string; - /** - * The quantity to return. - */ - quantity?: number; - /** - * The reason for the return. - */ - reason?: string; - /** - * The explanation of the reason. - */ - reasonText?: string; - } - export interface Schema$OrdersCustomBatchRequestEntryReturnRefundLineItem { - /** - * The amount that is refunded. If omitted, refundless return is assumed - * (same as calling returnLineItem method). Optional, but if filled then - * both amountPretax and amountTax must be set. - */ - amountPretax?: Schema$Price; - /** - * Tax amount that correspond to refund amount in amountPretax. - */ - amountTax?: Schema$Price; - /** - * The ID of the line item to return. Either lineItemId or productId is - * required. - */ - lineItemId?: string; - /** - * The ID of the product to return. This is the REST ID used in the products - * service. Either lineItemId or productId is required. - */ - productId?: string; - /** - * The quantity to return and refund. - */ - quantity?: number; - /** - * The reason for the return. - */ - reason?: string; - /** - * The explanation of the reason. - */ - reasonText?: string; - } - export interface Schema$OrdersCustomBatchRequestEntrySetLineItemMetadata { - annotations?: Schema$OrderMerchantProvidedAnnotation[]; - /** - * The ID of the line item to set metadata. Either lineItemId or productId - * is required. - */ - lineItemId?: string; - /** - * The ID of the product to set metadata. This is the REST ID used in the - * products service. Either lineItemId or productId is required. - */ - productId?: string; - } - export interface Schema$OrdersCustomBatchRequestEntryShipLineItems { - /** - * Deprecated. Please use shipmentInfo instead. The carrier handling the - * shipment. See shipments[].carrier in the Orders resource representation - * for a list of acceptable values. - */ - carrier?: string; - /** - * Line items to ship. - */ - lineItems?: Schema$OrderShipmentLineItemShipment[]; - /** - * ID of the shipment group. Required for orders that use the orderinvoices - * service. - */ - shipmentGroupId?: string; - /** - * Deprecated. Please use shipmentInfo instead. The ID of the shipment. - */ - shipmentId?: string; - /** - * Shipment information. This field is repeated because a single line item - * can be shipped in several packages (and have several tracking IDs). - */ - shipmentInfos?: - Schema$OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo[]; - /** - * Deprecated. Please use shipmentInfo instead. The tracking id for the - * shipment. - */ - trackingId?: string; - } - export interface Schema$OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo { - /** - * The carrier handling the shipment. See shipments[].carrier in the Orders - * resource representation for a list of acceptable values. - */ - carrier?: string; - /** - * The ID of the shipment. - */ - shipmentId?: string; - /** - * The tracking id for the shipment. - */ - trackingId?: string; - } - export interface Schema$OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails { - /** - * Updated delivery by date, in ISO 8601 format. If not specified only ship - * by date is updated. - */ - deliverByDate?: string; - /** - * The ID of the line item to set metadata. Either lineItemId or productId - * is required. - */ - lineItemId?: string; - /** - * The ID of the product to set metadata. This is the REST ID used in the - * products service. Either lineItemId or productId is required. - */ - productId?: string; - /** - * Updated ship by date, in ISO 8601 format. If not specified only deliver - * by date is updated. - */ - shipByDate?: string; - } - export interface Schema$OrdersCustomBatchRequestEntryUpdateShipment { - /** - * The carrier handling the shipment. Not updated if missing. See - * shipments[].carrier in the Orders resource representation for a list of - * acceptable values. - */ - carrier?: string; - /** - * Date on which the shipment has been delivered, in ISO 8601 format. - * Optional and can be provided only if status is delivered. - */ - deliveryDate?: string; - /** - * The ID of the shipment. - */ - shipmentId?: string; - /** - * New status for the shipment. Not updated if missing. - */ - status?: string; - /** - * The tracking id for the shipment. Not updated if missing. - */ - trackingId?: string; - } - export interface Schema$OrdersCustomBatchResponse { - /** - * The result of the execution of the batch requests. - */ - entries?: Schema$OrdersCustomBatchResponseEntry[]; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersCustomBatchResponse". - */ - kind?: string; - } - export interface Schema$OrdersCustomBatchResponseEntry { - /** - * The ID of the request entry this entry responds to. - */ - batchId?: number; - /** - * A list of errors defined if and only if the request failed. - */ - errors?: Schema$Errors; - /** - * The status of the execution. Only defined if - the request was - * successful; and - the method is not get, getByMerchantOrderId, or one of - * the test methods. - */ - executionStatus?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersCustomBatchResponseEntry". - */ - kind?: string; - /** - * The retrieved order. Only defined if the method is get and if the request - * was successful. - */ - order?: Schema$Order; - } - export interface Schema$OrdersGetByMerchantOrderIdResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersGetByMerchantOrderIdResponse". - */ - kind?: string; - /** - * The requested order. - */ - order?: Schema$Order; - } - export interface Schema$OrdersGetTestOrderTemplateResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersGetTestOrderTemplateResponse". - */ - kind?: string; - /** - * The requested test order template. - */ - template?: Schema$TestOrder; - } - export interface Schema$OrderShipment { - /** - * The carrier handling the shipment. Acceptable values are: - - * "gsx" - "ups" - "usps" - - * "fedex" - "dhl" - "ecourier" - - * "cxt" - "google" - "ontrac" - - * "emsy" - "ont" - "deliv" - - * "dynamex" - "lasership" - "mpx" - - * "uds" - */ - carrier?: string; - /** - * Date on which the shipment has been created, in ISO 8601 format. - */ - creationDate?: string; - /** - * Date on which the shipment has been delivered, in ISO 8601 format. - * Present only if status is delivered - */ - deliveryDate?: string; - /** - * The id of the shipment. - */ - id?: string; - /** - * The line items that are shipped. - */ - lineItems?: Schema$OrderShipmentLineItemShipment[]; - /** - * The status of the shipment. - */ - status?: string; - /** - * The tracking id for the shipment. - */ - trackingId?: string; - } - export interface Schema$OrderShipmentLineItemShipment { - /** - * The id of the line item that is shipped. Either lineItemId or productId - * is required. - */ - lineItemId?: string; - /** - * The ID of the product to ship. This is the REST ID used in the products - * service. Either lineItemId or productId is required. - */ - productId?: string; - /** - * The quantity that is shipped. - */ - quantity?: number; - } - export interface Schema$OrdersInStoreRefundLineItemRequest { - /** - * The amount that is refunded. Required. - */ - amountPretax?: Schema$Price; - /** - * Tax amount that correspond to refund amount in amountPretax. Required. - */ - amountTax?: Schema$Price; - /** - * The ID of the line item to return. Either lineItemId or productId is - * required. - */ - lineItemId?: string; - /** - * The ID of the operation. Unique across all operations for a given order. - */ - operationId?: string; - /** - * The ID of the product to return. This is the REST ID used in the products - * service. Either lineItemId or productId is required. - */ - productId?: string; - /** - * The quantity to return and refund. - */ - quantity?: number; - /** - * The reason for the return. - */ - reason?: string; - /** - * The explanation of the reason. - */ - reasonText?: string; - } - export interface Schema$OrdersInStoreRefundLineItemResponse { - /** - * The status of the execution. - */ - executionStatus?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersInStoreRefundLineItemResponse". - */ - kind?: string; - } - export interface Schema$OrdersListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersListResponse". - */ - kind?: string; - /** - * The token for the retrieval of the next page of orders. - */ - nextPageToken?: string; - resources?: Schema$Order[]; - } - export interface Schema$OrdersRefundRequest { - /** - * Deprecated. Please use amountPretax and amountTax instead. - */ - amount?: Schema$Price; - /** - * The amount that is refunded. Either amount or amountPretax and amountTax - * should be filled. - */ - amountPretax?: Schema$Price; - /** - * Tax amount that correspond to refund amount in amountPretax. - */ - amountTax?: Schema$Price; - /** - * The ID of the operation. Unique across all operations for a given order. - */ - operationId?: string; - /** - * The reason for the refund. - */ - reason?: string; - /** - * The explanation of the reason. - */ - reasonText?: string; - } - export interface Schema$OrdersRefundResponse { - /** - * The status of the execution. - */ - executionStatus?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersRefundResponse". - */ - kind?: string; - } - export interface Schema$OrdersRejectReturnLineItemRequest { - /** - * The ID of the line item to return. Either lineItemId or productId is - * required. - */ - lineItemId?: string; - /** - * The ID of the operation. Unique across all operations for a given order. - */ - operationId?: string; - /** - * The ID of the product to return. This is the REST ID used in the products - * service. Either lineItemId or productId is required. - */ - productId?: string; - /** - * The quantity to return and refund. - */ - quantity?: number; - /** - * The reason for the return. - */ - reason?: string; - /** - * The explanation of the reason. - */ - reasonText?: string; - } - export interface Schema$OrdersRejectReturnLineItemResponse { - /** - * The status of the execution. - */ - executionStatus?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersRejectReturnLineItemResponse". - */ - kind?: string; - } - export interface Schema$OrdersReturnLineItemRequest { - /** - * The ID of the line item to return. Either lineItemId or productId is - * required. - */ - lineItemId?: string; - /** - * The ID of the operation. Unique across all operations for a given order. - */ - operationId?: string; - /** - * The ID of the product to return. This is the REST ID used in the products - * service. Either lineItemId or productId is required. - */ - productId?: string; - /** - * The quantity to return. - */ - quantity?: number; - /** - * The reason for the return. - */ - reason?: string; - /** - * The explanation of the reason. - */ - reasonText?: string; - } - export interface Schema$OrdersReturnLineItemResponse { - /** - * The status of the execution. - */ - executionStatus?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersReturnLineItemResponse". - */ - kind?: string; - } - export interface Schema$OrdersReturnRefundLineItemRequest { - /** - * The amount that is refunded. If omitted, refundless return is assumed - * (same as calling returnLineItem method). Optional, but if filled then - * both amountPretax and amountTax must be set. - */ - amountPretax?: Schema$Price; - /** - * Tax amount that correspond to refund amount in amountPretax. - */ - amountTax?: Schema$Price; - /** - * The ID of the line item to return. Either lineItemId or productId is - * required. - */ - lineItemId?: string; - /** - * The ID of the operation. Unique across all operations for a given order. - */ - operationId?: string; - /** - * The ID of the product to return. This is the REST ID used in the products - * service. Either lineItemId or productId is required. - */ - productId?: string; - /** - * The quantity to return and refund. - */ - quantity?: number; - /** - * The reason for the return. - */ - reason?: string; - /** - * The explanation of the reason. - */ - reasonText?: string; - } - export interface Schema$OrdersReturnRefundLineItemResponse { - /** - * The status of the execution. - */ - executionStatus?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersReturnRefundLineItemResponse". - */ - kind?: string; - } - export interface Schema$OrdersSetLineItemMetadataRequest { - annotations?: Schema$OrderMerchantProvidedAnnotation[]; - /** - * The ID of the line item to set metadata. Either lineItemId or productId - * is required. - */ - lineItemId?: string; - /** - * The ID of the operation. Unique across all operations for a given order. - */ - operationId?: string; - /** - * The ID of the product to set metadata. This is the REST ID used in the - * products service. Either lineItemId or productId is required. - */ - productId?: string; - } - export interface Schema$OrdersSetLineItemMetadataResponse { - /** - * The status of the execution. - */ - executionStatus?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersSetLineItemMetadataResponse". - */ - kind?: string; - } - export interface Schema$OrdersShipLineItemsRequest { - /** - * Deprecated. Please use shipmentInfo instead. The carrier handling the - * shipment. See shipments[].carrier in the Orders resource representation - * for a list of acceptable values. - */ - carrier?: string; - /** - * Line items to ship. - */ - lineItems?: Schema$OrderShipmentLineItemShipment[]; - /** - * The ID of the operation. Unique across all operations for a given order. - */ - operationId?: string; - /** - * ID of the shipment group. Required for orders that use the orderinvoices - * service. - */ - shipmentGroupId?: string; - /** - * Deprecated. Please use shipmentInfo instead. The ID of the shipment. - */ - shipmentId?: string; - /** - * Shipment information. This field is repeated because a single line item - * can be shipped in several packages (and have several tracking IDs). - */ - shipmentInfos?: - Schema$OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo[]; - /** - * Deprecated. Please use shipmentInfo instead. The tracking id for the - * shipment. - */ - trackingId?: string; - } - export interface Schema$OrdersShipLineItemsResponse { - /** - * The status of the execution. - */ - executionStatus?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersShipLineItemsResponse". - */ - kind?: string; - } - export interface Schema$OrdersUpdateLineItemShippingDetailsRequest { - /** - * Updated delivery by date, in ISO 8601 format. If not specified only ship - * by date is updated. - */ - deliverByDate?: string; - /** - * The ID of the line item to set metadata. Either lineItemId or productId - * is required. - */ - lineItemId?: string; - /** - * The ID of the operation. Unique across all operations for a given order. - */ - operationId?: string; - /** - * The ID of the product to set metadata. This is the REST ID used in the - * products service. Either lineItemId or productId is required. - */ - productId?: string; - /** - * Updated ship by date, in ISO 8601 format. If not specified only deliver - * by date is updated. - */ - shipByDate?: string; - } - export interface Schema$OrdersUpdateLineItemShippingDetailsResponse { - /** - * The status of the execution. - */ - executionStatus?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersUpdateLineItemShippingDetailsResponse". - */ - kind?: string; - } - export interface Schema$OrdersUpdateMerchantOrderIdRequest { - /** - * The merchant order id to be assigned to the order. Must be unique per - * merchant. - */ - merchantOrderId?: string; - /** - * The ID of the operation. Unique across all operations for a given order. - */ - operationId?: string; - } - export interface Schema$OrdersUpdateMerchantOrderIdResponse { - /** - * The status of the execution. - */ - executionStatus?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersUpdateMerchantOrderIdResponse". - */ - kind?: string; - } - export interface Schema$OrdersUpdateShipmentRequest { - /** - * The carrier handling the shipment. Not updated if missing. See - * shipments[].carrier in the Orders resource representation for a list of - * acceptable values. - */ - carrier?: string; - /** - * Date on which the shipment has been delivered, in ISO 8601 format. - * Optional and can be provided only if status is delivered. - */ - deliveryDate?: string; - /** - * The ID of the operation. Unique across all operations for a given order. - */ - operationId?: string; - /** - * The ID of the shipment. - */ - shipmentId?: string; - /** - * New status for the shipment. Not updated if missing. - */ - status?: string; - /** - * The tracking id for the shipment. Not updated if missing. - */ - trackingId?: string; - } - export interface Schema$OrdersUpdateShipmentResponse { - /** - * The status of the execution. - */ - executionStatus?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#ordersUpdateShipmentResponse". - */ - kind?: string; - } - export interface Schema$Price { - /** - * The currency of the price. - */ - currency?: string; - /** - * The price represented as a number. - */ - value?: string; - } - export interface Schema$Promotion { - /** - * [required] Amount of the promotion. The values here are the promotion - * applied to the unit price pretax and to the total of the tax amounts. - */ - promotionAmount?: Schema$Amount; - /** - * [required] ID of the promotion. - */ - promotionId?: string; - } - export interface Schema$RefundReason { - description?: string; - reasonCode?: string; - } - export interface Schema$ReturnShipment { - creationDate?: string; - returnMethodType?: string; - shipmentId?: string; - shipmentTrackingInfos?: Schema$ShipmentTrackingInfo[]; - } - export interface Schema$ShipmentInvoice { - /** - * [required] Invoice summary. - */ - invoiceSummary?: Schema$InvoiceSummary; - /** - * [required] Invoice details per line item. - */ - lineItemInvoices?: Schema$ShipmentInvoiceLineItemInvoice[]; - /** - * [required] ID of the shipment group. - */ - shipmentGroupId?: string; - } - export interface Schema$ShipmentInvoiceLineItemInvoice { - /** - * ID of the line item. Either lineItemId or productId must be set. - */ - lineItemId?: string; - /** - * ID of the product. This is the REST ID used in the products service. - * Either lineItemId or productId must be set. - */ - productId?: string; - /** - * [required] Unit IDs to define specific units within the line item. - */ - shipmentUnitIds?: string[]; - /** - * [required] Invoice details for a single unit. - */ - unitInvoice?: Schema$UnitInvoice; - } - export interface Schema$ShipmentTrackingInfo { - carrier?: string; - trackingNumber?: string; - } - export interface Schema$TestOrder { - /** - * The details of the customer who placed the order. - */ - customer?: Schema$TestOrderCustomer; - /** - * Whether the orderinvoices service should support this order. - */ - enableOrderinvoices?: boolean; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "content#testOrder". - */ - kind?: string; - /** - * Line items that are ordered. At least one line item must be provided. - */ - lineItems?: Schema$TestOrderLineItem[]; - /** - * Determines if test order must be pulled by merchant or pushed to merchant - * via push integration. - */ - notificationMode?: string; - /** - * The details of the payment method. - */ - paymentMethod?: Schema$TestOrderPaymentMethod; - /** - * Identifier of one of the predefined delivery addresses for the delivery. - */ - predefinedDeliveryAddress?: string; - /** - * Deprecated. The details of the merchant provided promotions applied to - * the order. More details about the program are here. - */ - promotions?: Schema$OrderLegacyPromotion[]; - /** - * The total cost of shipping for all items. - */ - shippingCost?: Schema$Price; - /** - * The tax for the total shipping cost. - */ - shippingCostTax?: Schema$Price; - /** - * The requested shipping option. - */ - shippingOption?: string; - } - export interface Schema$TestOrderCustomer { - /** - * Deprecated. - */ - email?: string; - /** - * Deprecated. Please use marketingRightsInfo instead. - */ - explicitMarketingPreference?: boolean; - /** - * Full name of the customer. - */ - fullName?: string; - /** - * Customer's marketing preferences. - */ - marketingRightsInfo?: Schema$TestOrderCustomerMarketingRightsInfo; - } - export interface Schema$TestOrderCustomerMarketingRightsInfo { - /** - * Last know user use selection regards marketing preferences. In certain - * cases selection might not be known, so this field would be empty. - */ - explicitMarketingPreference?: string; - /** - * Timestamp when last time marketing preference was updated. Could be - * empty, if user wasn't offered a selection yet. - */ - lastUpdatedTimestamp?: string; - } - export interface Schema$TestOrderLineItem { - /** - * Product data from the time of the order placement. - */ - product?: Schema$TestOrderLineItemProduct; - /** - * Number of items ordered. - */ - quantityOrdered?: number; - /** - * Details of the return policy for the line item. - */ - returnInfo?: Schema$OrderLineItemReturnInfo; - /** - * Details of the requested shipping for the line item. - */ - shippingDetails?: Schema$OrderLineItemShippingDetails; - /** - * Unit tax for the line item. - */ - unitTax?: Schema$Price; - } - export interface Schema$TestOrderLineItemProduct { - /** - * Brand of the item. - */ - brand?: string; - /** - * The item's channel. - */ - channel?: string; - /** - * Condition or state of the item. - */ - condition?: string; - /** - * The two-letter ISO 639-1 language code for the item. - */ - contentLanguage?: string; - /** - * Global Trade Item Number (GTIN) of the item. Optional. - */ - gtin?: string; - /** - * URL of an image of the item. - */ - imageLink?: string; - /** - * Shared identifier for all variants of the same product. Optional. - */ - itemGroupId?: string; - /** - * Manufacturer Part Number (MPN) of the item. Optional. - */ - mpn?: string; - /** - * An identifier of the item. - */ - offerId?: string; - /** - * The price for the product. - */ - price?: Schema$Price; - /** - * The CLDR territory code of the target country of the product. - */ - targetCountry?: string; - /** - * The title of the product. - */ - title?: string; - /** - * Variant attributes for the item. Optional. - */ - variantAttributes?: Schema$OrderLineItemProductVariantAttribute[]; - } - export interface Schema$TestOrderPaymentMethod { - /** - * The card expiration month (January = 1, February = 2 etc.). - */ - expirationMonth?: number; - /** - * The card expiration year (4-digit, e.g. 2015). - */ - expirationYear?: number; - /** - * The last four digits of the card number. - */ - lastFourDigits?: string; - /** - * The billing address. - */ - predefinedBillingAddress?: string; - /** - * The type of instrument. Note that real orders might have different values - * than the four values accepted by createTestOrder. - */ - type?: string; - } - export interface Schema$UnitInvoice { - /** - * Additional charges for a unit, e.g. shipping costs. - */ - additionalCharges?: Schema$UnitInvoiceAdditionalCharge[]; - /** - * Promotions applied to a unit. - */ - promotions?: Schema$Promotion[]; - /** - * [required] Price of the unit, before applying taxes. - */ - unitPricePretax?: Schema$Price; - /** - * Tax amounts to apply to the unit price. - */ - unitPriceTaxes?: Schema$UnitInvoiceTaxLine[]; - } - export interface Schema$UnitInvoiceAdditionalCharge { - /** - * [required] Amount of the additional charge. - */ - additionalChargeAmount?: Schema$Amount; - /** - * Promotions applied to the additional charge. - */ - additionalChargePromotions?: Schema$Promotion[]; - /** - * [required] Type of the additional charge. - */ - type?: string; - } - export interface Schema$UnitInvoiceTaxLine { - /** - * [required] Tax amount for the tax type. - */ - taxAmount?: Schema$Price; - /** - * Optional name of the tax type. This should only be provided if taxType is - * otherFeeTax. - */ - taxName?: string; - /** - * [required] Type of the tax. - */ - taxType?: string; - } - - - export class Resource$Orderinvoices { - root: Content; - constructor(root: Content) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * content.orderinvoices.createchargeinvoice - * @desc Creates a charge invoice for a shipment group, and triggers a - * charge capture for non-facilitated payment orders. - * @alias content.orderinvoices.createchargeinvoice - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string} params.orderId The ID of the order. - * @param {().OrderinvoicesCreateChargeInvoiceRequest} 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 - */ - createchargeinvoice( - params?: Params$Resource$Orderinvoices$Createchargeinvoice, - options?: MethodOptions): - AxiosPromise; - createchargeinvoice( - params: Params$Resource$Orderinvoices$Createchargeinvoice, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback< - Schema$OrderinvoicesCreateChargeInvoiceResponse>): void; - createchargeinvoice( - params: Params$Resource$Orderinvoices$Createchargeinvoice, - callback: BodyResponseCallback< - Schema$OrderinvoicesCreateChargeInvoiceResponse>): void; - createchargeinvoice(callback: BodyResponseCallback< - Schema$OrderinvoicesCreateChargeInvoiceResponse>): void; - createchargeinvoice( - paramsOrCallback?: Params$Resource$Orderinvoices$Createchargeinvoice| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$OrderinvoicesCreateChargeInvoiceResponse>): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Orderinvoices$Createchargeinvoice; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orderinvoices$Createchargeinvoice; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/content/v2sandbox/{merchantId}/orderinvoices/{orderId}/createChargeInvoice') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['merchantId', 'orderId'], - pathParams: ['merchantId', 'orderId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest< - Schema$OrderinvoicesCreateChargeInvoiceResponse>(parameters); - } - } - - - /** - * content.orderinvoices.createrefundinvoice - * @desc Creates a refund invoice for one or more shipment groups, and - * triggers a refund for non-facilitated payment orders. This can only be - * used for line items that have previously been charged using - * createChargeInvoice. All amounts (except for the summary) are incremental - * with respect to the previous invoice. - * @alias content.orderinvoices.createrefundinvoice - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string} params.orderId The ID of the order. - * @param {().OrderinvoicesCreateRefundInvoiceRequest} 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 - */ - createrefundinvoice( - params?: Params$Resource$Orderinvoices$Createrefundinvoice, - options?: MethodOptions): - AxiosPromise; - createrefundinvoice( - params: Params$Resource$Orderinvoices$Createrefundinvoice, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback< - Schema$OrderinvoicesCreateRefundInvoiceResponse>): void; - createrefundinvoice( - params: Params$Resource$Orderinvoices$Createrefundinvoice, - callback: BodyResponseCallback< - Schema$OrderinvoicesCreateRefundInvoiceResponse>): void; - createrefundinvoice(callback: BodyResponseCallback< - Schema$OrderinvoicesCreateRefundInvoiceResponse>): void; - createrefundinvoice( - paramsOrCallback?: Params$Resource$Orderinvoices$Createrefundinvoice| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$OrderinvoicesCreateRefundInvoiceResponse>): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Orderinvoices$Createrefundinvoice; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orderinvoices$Createrefundinvoice; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/content/v2sandbox/{merchantId}/orderinvoices/{orderId}/createRefundInvoice') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['merchantId', 'orderId'], - pathParams: ['merchantId', 'orderId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest< - Schema$OrderinvoicesCreateRefundInvoiceResponse>(parameters); - } - } - } - - export interface Params$Resource$Orderinvoices$Createchargeinvoice { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. - */ - merchantId?: string; - /** - * The ID of the order. - */ - orderId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$OrderinvoicesCreateChargeInvoiceRequest; - } - export interface Params$Resource$Orderinvoices$Createrefundinvoice { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. - */ - merchantId?: string; - /** - * The ID of the order. - */ - orderId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$OrderinvoicesCreateRefundInvoiceRequest; - } - - - export class Resource$Orderpayments { - root: Content; - constructor(root: Content) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * content.orderpayments.notifyauthapproved - * @desc Notify about successfully authorizing user's payment method for a - * given amount. - * @alias content.orderpayments.notifyauthapproved - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string} params.orderId The ID of the order for for which payment authorization is happening. - * @param {().OrderpaymentsNotifyAuthApprovedRequest} 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 - */ - notifyauthapproved( - params?: Params$Resource$Orderpayments$Notifyauthapproved, - options?: MethodOptions): - AxiosPromise; - notifyauthapproved( - params: Params$Resource$Orderpayments$Notifyauthapproved, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback< - Schema$OrderpaymentsNotifyAuthApprovedResponse>): void; - notifyauthapproved( - params: Params$Resource$Orderpayments$Notifyauthapproved, - callback: BodyResponseCallback< - Schema$OrderpaymentsNotifyAuthApprovedResponse>): void; - notifyauthapproved(callback: BodyResponseCallback< - Schema$OrderpaymentsNotifyAuthApprovedResponse>): void; - notifyauthapproved( - paramsOrCallback?: Params$Resource$Orderpayments$Notifyauthapproved| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$OrderpaymentsNotifyAuthApprovedResponse>): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Orderpayments$Notifyauthapproved; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orderpayments$Notifyauthapproved; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/content/v2sandbox/{merchantId}/orderpayments/{orderId}/notifyAuthApproved') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['merchantId', 'orderId'], - pathParams: ['merchantId', 'orderId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * content.orderpayments.notifyauthdeclined - * @desc Notify about failure to authorize user's payment method. - * @alias content.orderpayments.notifyauthdeclined - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string} params.orderId The ID of the order for which payment authorization was declined. - * @param {().OrderpaymentsNotifyAuthDeclinedRequest} 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 - */ - notifyauthdeclined( - params?: Params$Resource$Orderpayments$Notifyauthdeclined, - options?: MethodOptions): - AxiosPromise; - notifyauthdeclined( - params: Params$Resource$Orderpayments$Notifyauthdeclined, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback< - Schema$OrderpaymentsNotifyAuthDeclinedResponse>): void; - notifyauthdeclined( - params: Params$Resource$Orderpayments$Notifyauthdeclined, - callback: BodyResponseCallback< - Schema$OrderpaymentsNotifyAuthDeclinedResponse>): void; - notifyauthdeclined(callback: BodyResponseCallback< - Schema$OrderpaymentsNotifyAuthDeclinedResponse>): void; - notifyauthdeclined( - paramsOrCallback?: Params$Resource$Orderpayments$Notifyauthdeclined| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$OrderpaymentsNotifyAuthDeclinedResponse>): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Orderpayments$Notifyauthdeclined; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orderpayments$Notifyauthdeclined; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/content/v2sandbox/{merchantId}/orderpayments/{orderId}/notifyAuthDeclined') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['merchantId', 'orderId'], - pathParams: ['merchantId', 'orderId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * content.orderpayments.notifycharge - * @desc Notify about charge on user's selected payments method. - * @alias content.orderpayments.notifycharge - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string} params.orderId The ID of the order for which charge is happening. - * @param {().OrderpaymentsNotifyChargeRequest} 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 - */ - notifycharge( - params?: Params$Resource$Orderpayments$Notifycharge, - options?: MethodOptions): - AxiosPromise; - notifycharge( - params: Params$Resource$Orderpayments$Notifycharge, - options: MethodOptions| - BodyResponseCallback, - callback: - BodyResponseCallback): - void; - notifycharge( - params: Params$Resource$Orderpayments$Notifycharge, - callback: - BodyResponseCallback): - void; - notifycharge( - callback: - BodyResponseCallback): - void; - notifycharge( - paramsOrCallback?: Params$Resource$Orderpayments$Notifycharge| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: - BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Orderpayments$Notifycharge; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orderpayments$Notifycharge; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/content/v2sandbox/{merchantId}/orderpayments/{orderId}/notifyCharge') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['merchantId', 'orderId'], - pathParams: ['merchantId', 'orderId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * content.orderpayments.notifyrefund - * @desc Notify about refund on user's selected payments method. - * @alias content.orderpayments.notifyrefund - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string} params.orderId The ID of the order for which charge is happening. - * @param {().OrderpaymentsNotifyRefundRequest} 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 - */ - notifyrefund( - params?: Params$Resource$Orderpayments$Notifyrefund, - options?: MethodOptions): - AxiosPromise; - notifyrefund( - params: Params$Resource$Orderpayments$Notifyrefund, - options: MethodOptions| - BodyResponseCallback, - callback: - BodyResponseCallback): - void; - notifyrefund( - params: Params$Resource$Orderpayments$Notifyrefund, - callback: - BodyResponseCallback): - void; - notifyrefund( - callback: - BodyResponseCallback): - void; - notifyrefund( - paramsOrCallback?: Params$Resource$Orderpayments$Notifyrefund| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: - BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Orderpayments$Notifyrefund; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orderpayments$Notifyrefund; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/content/v2sandbox/{merchantId}/orderpayments/{orderId}/notifyRefund') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['merchantId', 'orderId'], - pathParams: ['merchantId', 'orderId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - } - - export interface Params$Resource$Orderpayments$Notifyauthapproved { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. - */ - merchantId?: string; - /** - * The ID of the order for for which payment authorization is happening. - */ - orderId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$OrderpaymentsNotifyAuthApprovedRequest; - } - export interface Params$Resource$Orderpayments$Notifyauthdeclined { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. - */ - merchantId?: string; - /** - * The ID of the order for which payment authorization was declined. - */ - orderId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$OrderpaymentsNotifyAuthDeclinedRequest; - } - export interface Params$Resource$Orderpayments$Notifycharge { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. - */ - merchantId?: string; - /** - * The ID of the order for which charge is happening. - */ - orderId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$OrderpaymentsNotifyChargeRequest; - } - export interface Params$Resource$Orderpayments$Notifyrefund { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. - */ - merchantId?: string; - /** - * The ID of the order for which charge is happening. - */ - orderId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$OrderpaymentsNotifyRefundRequest; - } - - - export class Resource$Orderreturns { - root: Content; - constructor(root: Content) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * content.orderreturns.get - * @desc Retrieves an order return from your Merchant Center account. - * @alias content.orderreturns.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string} params.returnId Merchant order return ID generated by Google. - * @param {object} [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$Orderreturns$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Orderreturns$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Orderreturns$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Orderreturns$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Orderreturns$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orderreturns$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/content/v2sandbox/{merchantId}/orderreturns/{returnId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['merchantId', 'returnId'], - pathParams: ['merchantId', 'returnId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * content.orderreturns.list - * @desc Lists order returns in your Merchant Center account. - * @alias content.orderreturns.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.createdEndDate Obtains order returns created before this date (inclusively), in ISO 8601 format. - * @param {string=} params.createdStartDate Obtains order returns created after this date (inclusively), in ISO 8601 format. - * @param {integer=} params.maxResults The maximum number of order returns to return in the response, used for paging. The default value is 25 returns per page, and the maximum allowed value is 250 returns per page. - * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string=} params.orderBy Return the results in the specified order. - * @param {string=} params.pageToken The token returned by the previous 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 - */ - list(params?: Params$Resource$Orderreturns$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Orderreturns$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Orderreturns$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Orderreturns$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Orderreturns$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orderreturns$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/content/v2sandbox/{merchantId}/orderreturns') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['merchantId'], - pathParams: ['merchantId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Orderreturns$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. - */ - merchantId?: string; - /** - * Merchant order return ID generated by Google. - */ - returnId?: string; - } - export interface Params$Resource$Orderreturns$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Obtains order returns created before this date (inclusively), in ISO 8601 - * format. - */ - createdEndDate?: string; - /** - * Obtains order returns created after this date (inclusively), in ISO 8601 - * format. - */ - createdStartDate?: string; - /** - * The maximum number of order returns to return in the response, used for - * paging. The default value is 25 returns per page, and the maximum allowed - * value is 250 returns per page. - */ - maxResults?: number; - /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. - */ - merchantId?: string; - /** - * Return the results in the specified order. - */ - orderBy?: string; - /** - * The token returned by the previous request. - */ - pageToken?: string; - } - - - export class Resource$Orders { - root: Content; - constructor(root: Content) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * content.orders.acknowledge - * @desc Marks an order as acknowledged. - * @alias content.orders.acknowledge - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string} params.orderId The ID of the order. - * @param {().OrdersAcknowledgeRequest} 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 - */ - acknowledge( - params?: Params$Resource$Orders$Acknowledge, options?: MethodOptions): - AxiosPromise; - acknowledge( - params: Params$Resource$Orders$Acknowledge, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - acknowledge( - params: Params$Resource$Orders$Acknowledge, - callback: BodyResponseCallback): void; - acknowledge( - callback: BodyResponseCallback): void; - acknowledge( - paramsOrCallback?: Params$Resource$Orders$Acknowledge| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Orders$Acknowledge; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orders$Acknowledge; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/content/v2sandbox/{merchantId}/orders/{orderId}/acknowledge') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['merchantId', 'orderId'], - pathParams: ['merchantId', 'orderId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * content.orders.advancetestorder - * @desc Sandbox only. Moves a test order from state "inProgress" to state - * "pendingShipment". - * @alias content.orders.advancetestorder - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string} params.orderId The ID of the test order to modify. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - advancetestorder( - params?: Params$Resource$Orders$Advancetestorder, - options?: MethodOptions): - AxiosPromise; - advancetestorder( - params: Params$Resource$Orders$Advancetestorder, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - advancetestorder( - params: Params$Resource$Orders$Advancetestorder, - callback: BodyResponseCallback): - void; - advancetestorder( - callback: BodyResponseCallback): - void; - advancetestorder( - paramsOrCallback?: Params$Resource$Orders$Advancetestorder| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Orders$Advancetestorder; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orders$Advancetestorder; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/content/v2sandbox/{merchantId}/testorders/{orderId}/advance') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['merchantId', 'orderId'], - pathParams: ['merchantId', 'orderId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * content.orders.cancel - * @desc Cancels all line items in an order, making a full refund. - * @alias content.orders.cancel - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string} params.orderId The ID of the order to cancel. - * @param {().OrdersCancelRequest} 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 - */ - cancel(params?: Params$Resource$Orders$Cancel, options?: MethodOptions): - AxiosPromise; - cancel( - params: Params$Resource$Orders$Cancel, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - cancel( - params: Params$Resource$Orders$Cancel, - callback: BodyResponseCallback): void; - cancel(callback: BodyResponseCallback): void; - cancel( - paramsOrCallback?: Params$Resource$Orders$Cancel| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Orders$Cancel; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orders$Cancel; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/content/v2sandbox/{merchantId}/orders/{orderId}/cancel') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['merchantId', 'orderId'], - pathParams: ['merchantId', 'orderId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * content.orders.cancellineitem - * @desc Cancels a line item, making a full refund. - * @alias content.orders.cancellineitem - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string} params.orderId The ID of the order. - * @param {().OrdersCancelLineItemRequest} 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 - */ - cancellineitem( - params?: Params$Resource$Orders$Cancellineitem, - options?: MethodOptions): - AxiosPromise; - cancellineitem( - params: Params$Resource$Orders$Cancellineitem, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - cancellineitem( - params: Params$Resource$Orders$Cancellineitem, - callback: BodyResponseCallback): - void; - cancellineitem( - callback: BodyResponseCallback): - void; - cancellineitem( - paramsOrCallback?: Params$Resource$Orders$Cancellineitem| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Orders$Cancellineitem; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orders$Cancellineitem; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/content/v2sandbox/{merchantId}/orders/{orderId}/cancelLineItem') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['merchantId', 'orderId'], - pathParams: ['merchantId', 'orderId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * content.orders.canceltestorderbycustomer - * @desc Sandbox only. Cancels a test order for customer-initiated - * cancellation. - * @alias content.orders.canceltestorderbycustomer - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string} params.orderId The ID of the test order to cancel. - * @param {().OrdersCancelTestOrderByCustomerRequest} 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 - */ - canceltestorderbycustomer( - params?: Params$Resource$Orders$Canceltestorderbycustomer, - options?: MethodOptions): - AxiosPromise; - canceltestorderbycustomer( - params: Params$Resource$Orders$Canceltestorderbycustomer, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback< - Schema$OrdersCancelTestOrderByCustomerResponse>): void; - canceltestorderbycustomer( - params: Params$Resource$Orders$Canceltestorderbycustomer, - callback: BodyResponseCallback< - Schema$OrdersCancelTestOrderByCustomerResponse>): void; - canceltestorderbycustomer(callback: BodyResponseCallback< - Schema$OrdersCancelTestOrderByCustomerResponse>): - void; - canceltestorderbycustomer( - paramsOrCallback?: Params$Resource$Orders$Canceltestorderbycustomer| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$OrdersCancelTestOrderByCustomerResponse>): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Orders$Canceltestorderbycustomer; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orders$Canceltestorderbycustomer; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/content/v2sandbox/{merchantId}/testorders/{orderId}/cancelByCustomer') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['merchantId', 'orderId'], - pathParams: ['merchantId', 'orderId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * content.orders.createtestorder - * @desc Sandbox only. Creates a test order. - * @alias content.orders.createtestorder - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.merchantId The ID of the account that should manage the order. This cannot be a multi-client account. - * @param {().OrdersCreateTestOrderRequest} 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 - */ - createtestorder( - params?: Params$Resource$Orders$Createtestorder, - options?: MethodOptions): - AxiosPromise; - createtestorder( - params: Params$Resource$Orders$Createtestorder, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - createtestorder( - params: Params$Resource$Orders$Createtestorder, - callback: BodyResponseCallback): - void; - createtestorder( - callback: BodyResponseCallback): - void; - createtestorder( - paramsOrCallback?: Params$Resource$Orders$Createtestorder| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Orders$Createtestorder; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orders$Createtestorder; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/content/v2sandbox/{merchantId}/testorders') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['merchantId'], - pathParams: ['merchantId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * content.orders.createtestreturn - * @desc Sandbox only. Creates a test return. - * @alias content.orders.createtestreturn - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string} params.orderId The ID of the order. - * @param {().OrdersCreateTestReturnRequest} 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 - */ - createtestreturn( - params?: Params$Resource$Orders$Createtestreturn, - options?: MethodOptions): - AxiosPromise; - createtestreturn( - params: Params$Resource$Orders$Createtestreturn, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - createtestreturn( - params: Params$Resource$Orders$Createtestreturn, - callback: BodyResponseCallback): - void; - createtestreturn( - callback: BodyResponseCallback): - void; - createtestreturn( - paramsOrCallback?: Params$Resource$Orders$Createtestreturn| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Orders$Createtestreturn; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orders$Createtestreturn; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/content/v2sandbox/{merchantId}/orders/{orderId}/testreturn') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['merchantId', 'orderId'], - pathParams: ['merchantId', 'orderId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * content.orders.custombatch - * @desc Retrieves or modifies multiple orders in a single request. - * @alias content.orders.custombatch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {().OrdersCustomBatchRequest} 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 - */ - custombatch( - params?: Params$Resource$Orders$Custombatch, options?: MethodOptions): - AxiosPromise; - custombatch( - params: Params$Resource$Orders$Custombatch, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - custombatch( - params: Params$Resource$Orders$Custombatch, - callback: BodyResponseCallback): void; - custombatch( - callback: BodyResponseCallback): void; - custombatch( - paramsOrCallback?: Params$Resource$Orders$Custombatch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Orders$Custombatch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orders$Custombatch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/content/v2sandbox/orders/batch') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: [], - pathParams: [], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * content.orders.get - * @desc Retrieves an order from your Merchant Center account. - * @alias content.orders.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string} params.orderId The ID of the order. - * @param {object} [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$Orders$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Orders$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Orders$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Orders$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Orders$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orders$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + '/content/v2sandbox/{merchantId}/orders/{orderId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['merchantId', 'orderId'], - pathParams: ['merchantId', 'orderId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * content.orders.getbymerchantorderid - * @desc Retrieves an order using merchant order id. - * @alias content.orders.getbymerchantorderid - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string} params.merchantOrderId The merchant order id to be looked 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 - */ - getbymerchantorderid( - params?: Params$Resource$Orders$Getbymerchantorderid, - options?: MethodOptions): - AxiosPromise; - getbymerchantorderid( - params: Params$Resource$Orders$Getbymerchantorderid, - options: MethodOptions| - BodyResponseCallback, - callback: - BodyResponseCallback): - void; - getbymerchantorderid( - params: Params$Resource$Orders$Getbymerchantorderid, - callback: - BodyResponseCallback): - void; - getbymerchantorderid( - callback: - BodyResponseCallback): - void; - getbymerchantorderid( - paramsOrCallback?: Params$Resource$Orders$Getbymerchantorderid| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: - BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Orders$Getbymerchantorderid; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orders$Getbymerchantorderid; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/content/v2sandbox/{merchantId}/ordersbymerchantid/{merchantOrderId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['merchantId', 'merchantOrderId'], - pathParams: ['merchantId', 'merchantOrderId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * content.orders.gettestordertemplate - * @desc Sandbox only. Retrieves an order template that can be used to - * quickly create a new order in sandbox. - * @alias content.orders.gettestordertemplate - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.country The country of the template to retrieve. Defaults to US. - * @param {string} params.merchantId The ID of the account that should manage the order. This cannot be a multi-client account. - * @param {string} params.templateName The name of the template 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 - */ - gettestordertemplate( - params?: Params$Resource$Orders$Gettestordertemplate, - options?: MethodOptions): - AxiosPromise; - gettestordertemplate( - params: Params$Resource$Orders$Gettestordertemplate, - options: MethodOptions| - BodyResponseCallback, - callback: - BodyResponseCallback): - void; - gettestordertemplate( - params: Params$Resource$Orders$Gettestordertemplate, - callback: - BodyResponseCallback): - void; - gettestordertemplate( - callback: - BodyResponseCallback): - void; - gettestordertemplate( - paramsOrCallback?: Params$Resource$Orders$Gettestordertemplate| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: - BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Orders$Gettestordertemplate; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orders$Gettestordertemplate; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/content/v2sandbox/{merchantId}/testordertemplates/{templateName}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['merchantId', 'templateName'], - pathParams: ['merchantId', 'templateName'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * content.orders.instorerefundlineitem - * @desc Notifies that item return and refund was handled directly by - * merchant outside of Google payments processing (e.g. cash refund done in - * store). - * @alias content.orders.instorerefundlineitem - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string} params.orderId The ID of the order. - * @param {().OrdersInStoreRefundLineItemRequest} 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 - */ - instorerefundlineitem( - params?: Params$Resource$Orders$Instorerefundlineitem, - options?: MethodOptions): - AxiosPromise; - instorerefundlineitem( - params: Params$Resource$Orders$Instorerefundlineitem, - options: MethodOptions| - BodyResponseCallback, - callback: - BodyResponseCallback): - void; - instorerefundlineitem( - params: Params$Resource$Orders$Instorerefundlineitem, - callback: - BodyResponseCallback): - void; - instorerefundlineitem( - callback: - BodyResponseCallback): - void; - instorerefundlineitem( - paramsOrCallback?: Params$Resource$Orders$Instorerefundlineitem| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: - BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Orders$Instorerefundlineitem; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orders$Instorerefundlineitem; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/content/v2sandbox/{merchantId}/orders/{orderId}/inStoreRefundLineItem') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['merchantId', 'orderId'], - pathParams: ['merchantId', 'orderId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * content.orders.list - * @desc Lists the orders in your Merchant Center account. - * @alias content.orders.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.acknowledged Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged. We recommend using this filter set to false, in conjunction with the acknowledge call, such that only un-acknowledged orders are returned. - * @param {integer=} params.maxResults The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page. Known issue: All List calls will return all Orders without limit regardless of the value of this field. - * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string=} params.orderBy The ordering of the returned list. The only supported value are placedDate desc and placedDate asc for now, which returns orders sorted by placement date. "placedDate desc" stands for listing orders by placement date, from oldest to most recent. "placedDate asc" stands for listing orders by placement date, from most recent to oldest. In future releases we'll support other sorting criteria. - * @param {string=} params.pageToken The token returned by the previous request. - * @param {string=} params.placedDateEnd Obtains orders placed before this date (exclusively), in ISO 8601 format. - * @param {string=} params.placedDateStart Obtains orders placed after this date (inclusively), in ISO 8601 format. - * @param {string=} params.statuses Obtains orders that match any of the specified statuses. Multiple values can be specified with comma separation. Additionally, please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped , partiallyDelivered, delivered, partiallyReturned, returned, and canceled. - * @param {object} [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$Orders$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Orders$List, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Orders$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Orders$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Orders$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orders$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/content/v2sandbox/{merchantId}/orders') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['merchantId'], - pathParams: ['merchantId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * content.orders.refund - * @desc Deprecated, please use returnRefundLineItem instead. - * @alias content.orders.refund - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string} params.orderId The ID of the order to refund. - * @param {().OrdersRefundRequest} 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 - */ - refund(params?: Params$Resource$Orders$Refund, options?: MethodOptions): - AxiosPromise; - refund( - params: Params$Resource$Orders$Refund, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - refund( - params: Params$Resource$Orders$Refund, - callback: BodyResponseCallback): void; - refund(callback: BodyResponseCallback): void; - refund( - paramsOrCallback?: Params$Resource$Orders$Refund| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Orders$Refund; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orders$Refund; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/content/v2sandbox/{merchantId}/orders/{orderId}/refund') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['merchantId', 'orderId'], - pathParams: ['merchantId', 'orderId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * content.orders.rejectreturnlineitem - * @desc Rejects return on an line item. - * @alias content.orders.rejectreturnlineitem - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string} params.orderId The ID of the order. - * @param {().OrdersRejectReturnLineItemRequest} 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 - */ - rejectreturnlineitem( - params?: Params$Resource$Orders$Rejectreturnlineitem, - options?: MethodOptions): - AxiosPromise; - rejectreturnlineitem( - params: Params$Resource$Orders$Rejectreturnlineitem, - options: MethodOptions| - BodyResponseCallback, - callback: - BodyResponseCallback): - void; - rejectreturnlineitem( - params: Params$Resource$Orders$Rejectreturnlineitem, - callback: - BodyResponseCallback): - void; - rejectreturnlineitem( - callback: - BodyResponseCallback): - void; - rejectreturnlineitem( - paramsOrCallback?: Params$Resource$Orders$Rejectreturnlineitem| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: - BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Orders$Rejectreturnlineitem; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orders$Rejectreturnlineitem; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/content/v2sandbox/{merchantId}/orders/{orderId}/rejectReturnLineItem') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['merchantId', 'orderId'], - pathParams: ['merchantId', 'orderId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * content.orders.returnlineitem - * @desc Returns a line item. - * @alias content.orders.returnlineitem - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string} params.orderId The ID of the order. - * @param {().OrdersReturnLineItemRequest} 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 - */ - returnlineitem( - params?: Params$Resource$Orders$Returnlineitem, - options?: MethodOptions): - AxiosPromise; - returnlineitem( - params: Params$Resource$Orders$Returnlineitem, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - returnlineitem( - params: Params$Resource$Orders$Returnlineitem, - callback: BodyResponseCallback): - void; - returnlineitem( - callback: BodyResponseCallback): - void; - returnlineitem( - paramsOrCallback?: Params$Resource$Orders$Returnlineitem| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Orders$Returnlineitem; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orders$Returnlineitem; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/content/v2sandbox/{merchantId}/orders/{orderId}/returnLineItem') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['merchantId', 'orderId'], - pathParams: ['merchantId', 'orderId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * content.orders.returnrefundlineitem - * @desc Returns and refunds a line item. Note that this method can only be - * called on fully shipped orders. - * @alias content.orders.returnrefundlineitem - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string} params.orderId The ID of the order. - * @param {().OrdersReturnRefundLineItemRequest} 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 - */ - returnrefundlineitem( - params?: Params$Resource$Orders$Returnrefundlineitem, - options?: MethodOptions): - AxiosPromise; - returnrefundlineitem( - params: Params$Resource$Orders$Returnrefundlineitem, - options: MethodOptions| - BodyResponseCallback, - callback: - BodyResponseCallback): - void; - returnrefundlineitem( - params: Params$Resource$Orders$Returnrefundlineitem, - callback: - BodyResponseCallback): - void; - returnrefundlineitem( - callback: - BodyResponseCallback): - void; - returnrefundlineitem( - paramsOrCallback?: Params$Resource$Orders$Returnrefundlineitem| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: - BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Orders$Returnrefundlineitem; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orders$Returnrefundlineitem; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/content/v2sandbox/{merchantId}/orders/{orderId}/returnRefundLineItem') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['merchantId', 'orderId'], - pathParams: ['merchantId', 'orderId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * content.orders.setlineitemmetadata - * @desc Sets (overrides) merchant provided annotations on the line item. - * @alias content.orders.setlineitemmetadata - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string} params.orderId The ID of the order. - * @param {().OrdersSetLineItemMetadataRequest} 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 - */ - setlineitemmetadata( - params?: Params$Resource$Orders$Setlineitemmetadata, - options?: MethodOptions): - AxiosPromise; - setlineitemmetadata( - params: Params$Resource$Orders$Setlineitemmetadata, - options: MethodOptions| - BodyResponseCallback, - callback: - BodyResponseCallback): - void; - setlineitemmetadata( - params: Params$Resource$Orders$Setlineitemmetadata, - callback: - BodyResponseCallback): - void; - setlineitemmetadata( - callback: - BodyResponseCallback): - void; - setlineitemmetadata( - paramsOrCallback?: Params$Resource$Orders$Setlineitemmetadata| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: - BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Orders$Setlineitemmetadata; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orders$Setlineitemmetadata; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/content/v2sandbox/{merchantId}/orders/{orderId}/setLineItemMetadata') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['merchantId', 'orderId'], - pathParams: ['merchantId', 'orderId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * content.orders.shiplineitems - * @desc Marks line item(s) as shipped. - * @alias content.orders.shiplineitems - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string} params.orderId The ID of the order. - * @param {().OrdersShipLineItemsRequest} 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 - */ - shiplineitems( - params?: Params$Resource$Orders$Shiplineitems, options?: MethodOptions): - AxiosPromise; - shiplineitems( - params: Params$Resource$Orders$Shiplineitems, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - shiplineitems( - params: Params$Resource$Orders$Shiplineitems, - callback: BodyResponseCallback): - void; - shiplineitems(callback: - BodyResponseCallback): - void; - shiplineitems( - paramsOrCallback?: Params$Resource$Orders$Shiplineitems| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Orders$Shiplineitems; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orders$Shiplineitems; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/content/v2sandbox/{merchantId}/orders/{orderId}/shipLineItems') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['merchantId', 'orderId'], - pathParams: ['merchantId', 'orderId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * content.orders.updatelineitemshippingdetails - * @desc Updates ship by and delivery by dates for a line item. - * @alias content.orders.updatelineitemshippingdetails - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string} params.orderId The ID of the order. - * @param {().OrdersUpdateLineItemShippingDetailsRequest} 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 - */ - updatelineitemshippingdetails( - params?: Params$Resource$Orders$Updatelineitemshippingdetails, - options?: MethodOptions): - AxiosPromise; - updatelineitemshippingdetails( - params: Params$Resource$Orders$Updatelineitemshippingdetails, - options: MethodOptions|BodyResponseCallback< - Schema$OrdersUpdateLineItemShippingDetailsResponse>, - callback: BodyResponseCallback< - Schema$OrdersUpdateLineItemShippingDetailsResponse>): void; - updatelineitemshippingdetails( - params: Params$Resource$Orders$Updatelineitemshippingdetails, - callback: BodyResponseCallback< - Schema$OrdersUpdateLineItemShippingDetailsResponse>): void; - updatelineitemshippingdetails( - callback: BodyResponseCallback< - Schema$OrdersUpdateLineItemShippingDetailsResponse>): void; - updatelineitemshippingdetails( - paramsOrCallback?: Params$Resource$Orders$Updatelineitemshippingdetails| - BodyResponseCallback< - Schema$OrdersUpdateLineItemShippingDetailsResponse>, - optionsOrCallback?: MethodOptions|BodyResponseCallback< - Schema$OrdersUpdateLineItemShippingDetailsResponse>, - callback?: BodyResponseCallback< - Schema$OrdersUpdateLineItemShippingDetailsResponse>): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Orders$Updatelineitemshippingdetails; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orders$Updatelineitemshippingdetails; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/content/v2sandbox/{merchantId}/orders/{orderId}/updateLineItemShippingDetails') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['merchantId', 'orderId'], - pathParams: ['merchantId', 'orderId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest< - Schema$OrdersUpdateLineItemShippingDetailsResponse>(parameters); - } - } - - - /** - * content.orders.updatemerchantorderid - * @desc Updates the merchant order ID for a given order. - * @alias content.orders.updatemerchantorderid - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string} params.orderId The ID of the order. - * @param {().OrdersUpdateMerchantOrderIdRequest} 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 - */ - updatemerchantorderid( - params?: Params$Resource$Orders$Updatemerchantorderid, - options?: MethodOptions): - AxiosPromise; - updatemerchantorderid( - params: Params$Resource$Orders$Updatemerchantorderid, - options: MethodOptions| - BodyResponseCallback, - callback: - BodyResponseCallback): - void; - updatemerchantorderid( - params: Params$Resource$Orders$Updatemerchantorderid, - callback: - BodyResponseCallback): - void; - updatemerchantorderid( - callback: - BodyResponseCallback): - void; - updatemerchantorderid( - paramsOrCallback?: Params$Resource$Orders$Updatemerchantorderid| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: - BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Orders$Updatemerchantorderid; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orders$Updatemerchantorderid; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/content/v2sandbox/{merchantId}/orders/{orderId}/updateMerchantOrderId') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['merchantId', 'orderId'], - pathParams: ['merchantId', 'orderId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * content.orders.updateshipment - * @desc Updates a shipment's status, carrier, and/or tracking ID. - * @alias content.orders.updateshipment - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string} params.orderId The ID of the order. - * @param {().OrdersUpdateShipmentRequest} 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 - */ - updateshipment( - params?: Params$Resource$Orders$Updateshipment, - options?: MethodOptions): - AxiosPromise; - updateshipment( - params: Params$Resource$Orders$Updateshipment, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - updateshipment( - params: Params$Resource$Orders$Updateshipment, - callback: BodyResponseCallback): - void; - updateshipment( - callback: BodyResponseCallback): - void; - updateshipment( - paramsOrCallback?: Params$Resource$Orders$Updateshipment| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Orders$Updateshipment; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orders$Updateshipment; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/content/v2sandbox/{merchantId}/orders/{orderId}/updateShipment') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['merchantId', 'orderId'], - pathParams: ['merchantId', 'orderId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - } - - export interface Params$Resource$Orders$Acknowledge { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. - */ - merchantId?: string; - /** - * The ID of the order. - */ - orderId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$OrdersAcknowledgeRequest; - } - export interface Params$Resource$Orders$Advancetestorder { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. - */ - merchantId?: string; - /** - * The ID of the test order to modify. - */ - orderId?: string; - } - export interface Params$Resource$Orders$Cancel { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. - */ - merchantId?: string; - /** - * The ID of the order to cancel. - */ - orderId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$OrdersCancelRequest; - } - export interface Params$Resource$Orders$Cancellineitem { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. - */ - merchantId?: string; - /** - * The ID of the order. - */ - orderId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$OrdersCancelLineItemRequest; - } - export interface Params$Resource$Orders$Canceltestorderbycustomer { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. - */ - merchantId?: string; - /** - * The ID of the test order to cancel. - */ - orderId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$OrdersCancelTestOrderByCustomerRequest; - } - export interface Params$Resource$Orders$Createtestorder { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the account that should manage the order. This cannot be a - * multi-client account. - */ - merchantId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$OrdersCreateTestOrderRequest; - } - export interface Params$Resource$Orders$Createtestreturn { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. - */ - merchantId?: string; - /** - * The ID of the order. - */ - orderId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$OrdersCreateTestReturnRequest; - } - export interface Params$Resource$Orders$Custombatch { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - - /** - * Request body metadata - */ - requestBody?: Schema$OrdersCustomBatchRequest; - } - export interface Params$Resource$Orders$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. - */ - merchantId?: string; - /** - * The ID of the order. - */ - orderId?: string; - } - export interface Params$Resource$Orders$Getbymerchantorderid { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. - */ - merchantId?: string; - /** - * The merchant order id to be looked for. - */ - merchantOrderId?: string; - } - export interface Params$Resource$Orders$Gettestordertemplate { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The country of the template to retrieve. Defaults to US. - */ - country?: string; - /** - * The ID of the account that should manage the order. This cannot be a - * multi-client account. - */ - merchantId?: string; - /** - * The name of the template to retrieve. - */ - templateName?: string; - } - export interface Params$Resource$Orders$Instorerefundlineitem { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. - */ - merchantId?: string; - /** - * The ID of the order. - */ - orderId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$OrdersInStoreRefundLineItemRequest; - } - export interface Params$Resource$Orders$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Obtains orders that match the acknowledgement status. When set to true, - * obtains orders that have been acknowledged. When false, obtains orders - * that have not been acknowledged. We recommend using this filter set to - * false, in conjunction with the acknowledge call, such that only - * un-acknowledged orders are returned. - */ - acknowledged?: boolean; - /** - * The maximum number of orders to return in the response, used for paging. - * The default value is 25 orders per page, and the maximum allowed value is - * 250 orders per page. Known issue: All List calls will return all Orders - * without limit regardless of the value of this field. - */ - maxResults?: number; - /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. - */ - merchantId?: string; - /** - * The ordering of the returned list. The only supported value are - * placedDate desc and placedDate asc for now, which returns orders sorted - * by placement date. "placedDate desc" stands for listing orders by - * placement date, from oldest to most recent. "placedDate asc" stands for - * listing orders by placement date, from most recent to oldest. In future - * releases we'll support other sorting criteria. - */ - orderBy?: string; - /** - * The token returned by the previous request. - */ - pageToken?: string; - /** - * Obtains orders placed before this date (exclusively), in ISO 8601 format. - */ - placedDateEnd?: string; - /** - * Obtains orders placed after this date (inclusively), in ISO 8601 format. - */ - placedDateStart?: string; - /** - * Obtains orders that match any of the specified statuses. Multiple values - * can be specified with comma separation. Additionally, please note that - * active is a shortcut for pendingShipment and partiallyShipped, and - * completed is a shortcut for shipped , partiallyDelivered, delivered, - * partiallyReturned, returned, and canceled. - */ - statuses?: string; - } - export interface Params$Resource$Orders$Refund { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. - */ - merchantId?: string; - /** - * The ID of the order to refund. - */ - orderId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$OrdersRefundRequest; - } - export interface Params$Resource$Orders$Rejectreturnlineitem { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. - */ - merchantId?: string; - /** - * The ID of the order. - */ - orderId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$OrdersRejectReturnLineItemRequest; - } - export interface Params$Resource$Orders$Returnlineitem { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. - */ - merchantId?: string; - /** - * The ID of the order. - */ - orderId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$OrdersReturnLineItemRequest; - } - export interface Params$Resource$Orders$Returnrefundlineitem { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. - */ - merchantId?: string; - /** - * The ID of the order. - */ - orderId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$OrdersReturnRefundLineItemRequest; - } - export interface Params$Resource$Orders$Setlineitemmetadata { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. - */ - merchantId?: string; - /** - * The ID of the order. - */ - orderId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$OrdersSetLineItemMetadataRequest; - } - export interface Params$Resource$Orders$Shiplineitems { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. - */ - merchantId?: string; - /** - * The ID of the order. - */ - orderId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$OrdersShipLineItemsRequest; - } - export interface Params$Resource$Orders$Updatelineitemshippingdetails { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. - */ - merchantId?: string; - /** - * The ID of the order. - */ - orderId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$OrdersUpdateLineItemShippingDetailsRequest; - } - export interface Params$Resource$Orders$Updatemerchantorderid { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. - */ - merchantId?: string; - /** - * The ID of the order. - */ - orderId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$OrdersUpdateMerchantOrderIdRequest; - } - export interface Params$Resource$Orders$Updateshipment { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the account that manages the order. This cannot be a - * multi-client account. - */ - merchantId?: string; - /** - * The ID of the order. - */ - orderId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$OrdersUpdateShipmentRequest; - } -} diff --git a/src/apis/customsearch/v1.ts b/src/apis/customsearch/v1.ts index e5fabe7307..b804030ba7 100644 --- a/src/apis/customsearch/v1.ts +++ b/src/apis/customsearch/v1.ts @@ -29,6 +29,40 @@ export namespace customsearch_v1 { version: 'v1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * CustomSearch API * @@ -251,7 +285,7 @@ export namespace customsearch_v1 { } } - export interface Params$Resource$Cse$List { + export interface Params$Resource$Cse$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -508,7 +542,8 @@ export namespace customsearch_v1 { } } - export interface Params$Resource$Cse$Siterestrict$List { + export interface Params$Resource$Cse$Siterestrict$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/dataflow/v1b3.ts b/src/apis/dataflow/v1b3.ts index 48b04b489b..73fbe398ed 100644 --- a/src/apis/dataflow/v1b3.ts +++ b/src/apis/dataflow/v1b3.ts @@ -29,6 +29,57 @@ export namespace dataflow_v1b3 { version: 'v1b3'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Dataflow API * @@ -1127,6 +1178,15 @@ export namespace dataflow_v1b3 { * mutate it. */ stageStates?: Schema$ExecutionStageState[]; + /** + * The timestamp when the job was started (transitioned to + * JOB_STATE_PENDING). Flexible resource scheduling jobs are started with + * some delay after job creation, so start_time is unset before start and is + * updated when the job is started by the Cloud Dataflow service. For other + * jobs, start_time always equals to create_time and is immutable and set by + * the Cloud Dataflow service. + */ + startTime?: string; /** * The top-level steps that constitute the entire job. */ @@ -2494,6 +2554,19 @@ export namespace dataflow_v1b3 { */ properties?: any; } + /** + * Streaming appliance snapshot configuration. + */ + export interface Schema$StreamingApplianceSnapshotConfig { + /** + * Indicates which endpoint is used to import appliance state. + */ + importStateEndpoint?: string; + /** + * If set, indicates the snapshot id for the snapshot being performed. + */ + snapshotId?: string; + } /** * Configuration information for a single streaming computation. */ @@ -2585,6 +2658,10 @@ export namespace dataflow_v1b3 { * streaming computation workers. */ receiveWorkPort?: number; + /** + * Configures streaming appliance snapshot. + */ + snapshotConfig?: Schema$StreamingApplianceSnapshotConfig; /** * The global topology of the streaming Dataflow job. */ @@ -3491,7 +3568,8 @@ export namespace dataflow_v1b3 { } } - export interface Params$Resource$Projects$Workermessages { + export interface Params$Resource$Projects$Workermessages extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3943,7 +4021,8 @@ export namespace dataflow_v1b3 { } } - export interface Params$Resource$Projects$Jobs$Aggregated { + export interface Params$Resource$Projects$Jobs$Aggregated extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3978,7 +4057,8 @@ export namespace dataflow_v1b3 { */ view?: string; } - export interface Params$Resource$Projects$Jobs$Create { + export interface Params$Resource$Projects$Jobs$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4006,7 +4086,8 @@ export namespace dataflow_v1b3 { */ requestBody?: Schema$Job; } - export interface Params$Resource$Projects$Jobs$Get { + export interface Params$Resource$Projects$Jobs$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4029,7 +4110,8 @@ export namespace dataflow_v1b3 { */ view?: string; } - export interface Params$Resource$Projects$Jobs$Getmetrics { + export interface Params$Resource$Projects$Jobs$Getmetrics extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4053,7 +4135,8 @@ export namespace dataflow_v1b3 { */ startTime?: string; } - export interface Params$Resource$Projects$Jobs$List { + export interface Params$Resource$Projects$Jobs$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4088,7 +4171,8 @@ export namespace dataflow_v1b3 { */ view?: string; } - export interface Params$Resource$Projects$Jobs$Update { + export interface Params$Resource$Projects$Jobs$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4269,7 +4353,8 @@ export namespace dataflow_v1b3 { } } - export interface Params$Resource$Projects$Jobs$Debug$Getconfig { + export interface Params$Resource$Projects$Jobs$Debug$Getconfig extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4289,7 +4374,8 @@ export namespace dataflow_v1b3 { */ requestBody?: Schema$GetDebugConfigRequest; } - export interface Params$Resource$Projects$Jobs$Debug$Sendcapture { + export interface Params$Resource$Projects$Jobs$Debug$Sendcapture extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4399,7 +4485,8 @@ export namespace dataflow_v1b3 { } } - export interface Params$Resource$Projects$Jobs$Messages$List { + export interface Params$Resource$Projects$Jobs$Messages$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4607,7 +4694,8 @@ export namespace dataflow_v1b3 { } } - export interface Params$Resource$Projects$Jobs$Workitems$Lease { + export interface Params$Resource$Projects$Jobs$Workitems$Lease extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4627,7 +4715,8 @@ export namespace dataflow_v1b3 { */ requestBody?: Schema$LeaseWorkItemRequest; } - export interface Params$Resource$Projects$Jobs$Workitems$Reportstatus { + export interface Params$Resource$Projects$Jobs$Workitems$Reportstatus extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4744,7 +4833,8 @@ export namespace dataflow_v1b3 { } } - export interface Params$Resource$Projects$Locations$Workermessages { + export interface Params$Resource$Projects$Locations$Workermessages extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5137,7 +5227,8 @@ export namespace dataflow_v1b3 { } } - export interface Params$Resource$Projects$Locations$Jobs$Create { + export interface Params$Resource$Projects$Locations$Jobs$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5165,7 +5256,8 @@ export namespace dataflow_v1b3 { */ requestBody?: Schema$Job; } - export interface Params$Resource$Projects$Locations$Jobs$Get { + export interface Params$Resource$Projects$Locations$Jobs$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5188,7 +5280,8 @@ export namespace dataflow_v1b3 { */ view?: string; } - export interface Params$Resource$Projects$Locations$Jobs$Getmetrics { + export interface Params$Resource$Projects$Locations$Jobs$Getmetrics extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5212,7 +5305,8 @@ export namespace dataflow_v1b3 { */ startTime?: string; } - export interface Params$Resource$Projects$Locations$Jobs$List { + export interface Params$Resource$Projects$Locations$Jobs$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5247,7 +5341,8 @@ export namespace dataflow_v1b3 { */ view?: string; } - export interface Params$Resource$Projects$Locations$Jobs$Update { + export interface Params$Resource$Projects$Locations$Jobs$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5435,7 +5530,8 @@ export namespace dataflow_v1b3 { } } - export interface Params$Resource$Projects$Locations$Jobs$Debug$Getconfig { + export interface Params$Resource$Projects$Locations$Jobs$Debug$Getconfig + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5459,7 +5555,8 @@ export namespace dataflow_v1b3 { */ requestBody?: Schema$GetDebugConfigRequest; } - export interface Params$Resource$Projects$Locations$Jobs$Debug$Sendcapture { + export interface Params$Resource$Projects$Locations$Jobs$Debug$Sendcapture + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5575,7 +5672,8 @@ export namespace dataflow_v1b3 { } } - export interface Params$Resource$Projects$Locations$Jobs$Messages$List { + export interface Params$Resource$Projects$Locations$Jobs$Messages$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5789,7 +5887,8 @@ export namespace dataflow_v1b3 { } } - export interface Params$Resource$Projects$Locations$Jobs$Workitems$Lease { + export interface Params$Resource$Projects$Locations$Jobs$Workitems$Lease + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5813,7 +5912,8 @@ export namespace dataflow_v1b3 { */ requestBody?: Schema$LeaseWorkItemRequest; } - export interface Params$Resource$Projects$Locations$Jobs$Workitems$Reportstatus { + export interface Params$Resource$Projects$Locations$Jobs$Workitems$Reportstatus + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6063,7 +6163,8 @@ export namespace dataflow_v1b3 { } } - export interface Params$Resource$Projects$Locations$Templates$Create { + export interface Params$Resource$Projects$Locations$Templates$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6083,7 +6184,8 @@ export namespace dataflow_v1b3 { */ requestBody?: Schema$CreateJobFromTemplateRequest; } - export interface Params$Resource$Projects$Locations$Templates$Get { + export interface Params$Resource$Projects$Locations$Templates$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6107,7 +6209,8 @@ export namespace dataflow_v1b3 { */ view?: string; } - export interface Params$Resource$Projects$Locations$Templates$Launch { + export interface Params$Resource$Projects$Locations$Templates$Launch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6357,7 +6460,8 @@ export namespace dataflow_v1b3 { } } - export interface Params$Resource$Projects$Templates$Create { + export interface Params$Resource$Projects$Templates$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6373,7 +6477,8 @@ export namespace dataflow_v1b3 { */ requestBody?: Schema$CreateJobFromTemplateRequest; } - export interface Params$Resource$Projects$Templates$Get { + export interface Params$Resource$Projects$Templates$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6397,7 +6502,8 @@ export namespace dataflow_v1b3 { */ view?: string; } - export interface Params$Resource$Projects$Templates$Launch { + export interface Params$Resource$Projects$Templates$Launch extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/dataproc/v1.ts b/src/apis/dataproc/v1.ts index ed62d18e7f..eb6ab49e25 100644 --- a/src/apis/dataproc/v1.ts +++ b/src/apis/dataproc/v1.ts @@ -29,6 +29,57 @@ export namespace dataproc_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Dataproc API * @@ -707,6 +758,12 @@ export namespace dataproc_v1 { * Job is a Hive job. */ hiveJob?: Schema$HiveJob; + /** + * Output only. A UUID that uniquely identifies a job within the project + * over time. This is in contrast to a user-settable reference.job_id that + * may be reused over time. + */ + jobUuid?: string; /** * Optional. The labels to associate with this job. Label keys must contain * 1 to 63 characters, and must conform to RFC 1035 @@ -1431,27 +1488,31 @@ export namespace dataproc_v1 { * field path is similar in syntax to a google.protobuf.FieldMask. For * example, a field path that references the zone field of a workflow * template's cluster selector would be specified as - * <code>placement.clusterSelector.zone</code>.Also, field paths - * can reference fields using the following syntax: Values in maps can be - * referenced by key. Examples<br> labels'key' - * placement.clusterSelector.clusterLabels'key' + * placement.clusterSelector.zone.Also, field paths can reference fields + * using the following syntax: Values in maps can be referenced by key: + * labels'key' placement.clusterSelector.clusterLabels'key' * placement.managedCluster.labels'key' * placement.clusterSelector.clusterLabels'key' - * jobsstep-id.labels'key' Jobs in the jobs list can be referenced - * by step-id. Examples:<br> jobsstep-id.hadoopJob.mainJarFileUri - * jobsstep-id.hiveJob.queryFileUri jobsstep-id.pySparkJob.mainPythonFileUri - * jobsstep-id.hadoopJob.jarFileUris0 jobsstep-id.hadoopJob.archiveUris0 - * jobsstep-id.hadoopJob.fileUris0 jobsstep-id.pySparkJob.pythonFileUris0 - * Items in repeated fields can be referenced by a zero-based index. - * Example:<br> jobsstep-id.sparkJob.args0 Other examples: - * jobsstep-id.hadoopJob.properties'key' jobsstep-id.hadoopJob.args0 - * jobsstep-id.hiveJob.scriptVariables'key' - * jobsstep-id.hadoopJob.mainJarFileUri placement.clusterSelector.zoneIt may - * not be possible to parameterize maps and repeated fields in their - * entirety since only individual map values and individual items in - * repeated fields can be referenced. For example, the following field paths - * are invalid: placement.clusterSelector.clusterLabels - * jobsstep-id.sparkJob.args + * jobs'step-id'.labels'key' Jobs in the jobs list can be + * referenced by step-id: jobs'step-id'.hadoopJob.mainJarFileUri + * jobs'step-id'.hiveJob.queryFileUri + * jobs'step-id'.pySparkJob.mainPythonFileUri + * jobs'step-id'.hadoopJob.jarFileUris0 + * jobs'step-id'.hadoopJob.archiveUris0 + * jobs'step-id'.hadoopJob.fileUris0 + * jobs'step-id'.pySparkJob.pythonFileUris0 Items in repeated fields + * can be referenced by a zero-based index: + * jobs'step-id'.sparkJob.args0 Other examples: + * jobs'step-id'.hadoopJob.properties'key' + * jobs'step-id'.hadoopJob.args0 + * jobs'step-id'.hiveJob.scriptVariables'key' + * jobs'step-id'.hadoopJob.mainJarFileUri + * placement.clusterSelector.zoneIt may not be possible to parameterize maps + * and repeated fields in their entirety since only individual map values + * and individual items in repeated fields can be referenced. For example, + * the following field paths are invalid: + * placement.clusterSelector.clusterLabels + * jobs'step-id'.sparkJob.args */ fields?: string[]; /** @@ -2471,7 +2532,8 @@ export namespace dataproc_v1 { } } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Create { + export interface Params$Resource$Projects$Locations$Workflowtemplates$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2489,7 +2551,8 @@ export namespace dataproc_v1 { */ requestBody?: Schema$WorkflowTemplate; } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Delete { + export interface Params$Resource$Projects$Locations$Workflowtemplates$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2508,7 +2571,8 @@ export namespace dataproc_v1 { */ version?: number; } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Get { + export interface Params$Resource$Projects$Locations$Workflowtemplates$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2527,7 +2591,8 @@ export namespace dataproc_v1 { */ version?: number; } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Getiampolicy { + export interface Params$Resource$Projects$Locations$Workflowtemplates$Getiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2544,7 +2609,8 @@ export namespace dataproc_v1 { */ requestBody?: Schema$GetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Instantiate { + export interface Params$Resource$Projects$Locations$Workflowtemplates$Instantiate + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2562,7 +2628,8 @@ export namespace dataproc_v1 { */ requestBody?: Schema$InstantiateWorkflowTemplateRequest; } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Instantiateinline { + export interface Params$Resource$Projects$Locations$Workflowtemplates$Instantiateinline + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2589,7 +2656,8 @@ export namespace dataproc_v1 { */ requestBody?: Schema$WorkflowTemplate; } - export interface Params$Resource$Projects$Locations$Workflowtemplates$List { + export interface Params$Resource$Projects$Locations$Workflowtemplates$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2611,7 +2679,8 @@ export namespace dataproc_v1 { */ parent?: string; } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy { + export interface Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2628,7 +2697,8 @@ export namespace dataproc_v1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions { + export interface Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2645,7 +2715,8 @@ export namespace dataproc_v1 { */ requestBody?: Schema$TestIamPermissionsRequest; } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Update { + export interface Params$Resource$Projects$Locations$Workflowtemplates$Update + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3721,7 +3792,8 @@ export namespace dataproc_v1 { } } - export interface Params$Resource$Projects$Regions$Clusters$Create { + export interface Params$Resource$Projects$Regions$Clusters$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3753,7 +3825,8 @@ export namespace dataproc_v1 { */ requestBody?: Schema$Cluster; } - export interface Params$Resource$Projects$Regions$Clusters$Delete { + export interface Params$Resource$Projects$Regions$Clusters$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3789,7 +3862,8 @@ export namespace dataproc_v1 { */ requestId?: string; } - export interface Params$Resource$Projects$Regions$Clusters$Diagnose { + export interface Params$Resource$Projects$Regions$Clusters$Diagnose extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3814,7 +3888,8 @@ export namespace dataproc_v1 { */ requestBody?: Schema$DiagnoseClusterRequest; } - export interface Params$Resource$Projects$Regions$Clusters$Get { + export interface Params$Resource$Projects$Regions$Clusters$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3834,7 +3909,8 @@ export namespace dataproc_v1 { */ region?: string; } - export interface Params$Resource$Projects$Regions$Clusters$Getiampolicy { + export interface Params$Resource$Projects$Regions$Clusters$Getiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3851,7 +3927,8 @@ export namespace dataproc_v1 { */ requestBody?: Schema$GetIamPolicyRequest; } - export interface Params$Resource$Projects$Regions$Clusters$List { + export interface Params$Resource$Projects$Regions$Clusters$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3890,7 +3967,8 @@ export namespace dataproc_v1 { */ region?: string; } - export interface Params$Resource$Projects$Regions$Clusters$Patch { + export interface Params$Resource$Projects$Regions$Clusters$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3957,7 +4035,8 @@ export namespace dataproc_v1 { */ requestBody?: Schema$Cluster; } - export interface Params$Resource$Projects$Regions$Clusters$Setiampolicy { + export interface Params$Resource$Projects$Regions$Clusters$Setiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3974,7 +4053,8 @@ export namespace dataproc_v1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Regions$Clusters$Testiampermissions { + export interface Params$Resource$Projects$Regions$Clusters$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5016,7 +5096,8 @@ export namespace dataproc_v1 { } } - export interface Params$Resource$Projects$Regions$Jobs$Cancel { + export interface Params$Resource$Projects$Regions$Jobs$Cancel extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5041,7 +5122,8 @@ export namespace dataproc_v1 { */ requestBody?: Schema$CancelJobRequest; } - export interface Params$Resource$Projects$Regions$Jobs$Delete { + export interface Params$Resource$Projects$Regions$Jobs$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5061,7 +5143,8 @@ export namespace dataproc_v1 { */ region?: string; } - export interface Params$Resource$Projects$Regions$Jobs$Get { + export interface Params$Resource$Projects$Regions$Jobs$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5081,7 +5164,8 @@ export namespace dataproc_v1 { */ region?: string; } - export interface Params$Resource$Projects$Regions$Jobs$Getiampolicy { + export interface Params$Resource$Projects$Regions$Jobs$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5098,7 +5182,8 @@ export namespace dataproc_v1 { */ requestBody?: Schema$GetIamPolicyRequest; } - export interface Params$Resource$Projects$Regions$Jobs$List { + export interface Params$Resource$Projects$Regions$Jobs$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5144,7 +5229,8 @@ export namespace dataproc_v1 { */ region?: string; } - export interface Params$Resource$Projects$Regions$Jobs$Patch { + export interface Params$Resource$Projects$Regions$Jobs$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5178,7 +5264,8 @@ export namespace dataproc_v1 { */ requestBody?: Schema$Job; } - export interface Params$Resource$Projects$Regions$Jobs$Setiampolicy { + export interface Params$Resource$Projects$Regions$Jobs$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5195,7 +5282,8 @@ export namespace dataproc_v1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Regions$Jobs$Submit { + export interface Params$Resource$Projects$Regions$Jobs$Submit extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5216,7 +5304,8 @@ export namespace dataproc_v1 { */ requestBody?: Schema$SubmitJobRequest; } - export interface Params$Resource$Projects$Regions$Jobs$Testiampermissions { + export interface Params$Resource$Projects$Regions$Jobs$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5975,7 +6064,8 @@ export namespace dataproc_v1 { } } - export interface Params$Resource$Projects$Regions$Operations$Cancel { + export interface Params$Resource$Projects$Regions$Operations$Cancel extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5986,7 +6076,8 @@ export namespace dataproc_v1 { */ name?: string; } - export interface Params$Resource$Projects$Regions$Operations$Delete { + export interface Params$Resource$Projects$Regions$Operations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5997,7 +6088,8 @@ export namespace dataproc_v1 { */ name?: string; } - export interface Params$Resource$Projects$Regions$Operations$Get { + export interface Params$Resource$Projects$Regions$Operations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6008,7 +6100,8 @@ export namespace dataproc_v1 { */ name?: string; } - export interface Params$Resource$Projects$Regions$Operations$Getiampolicy { + export interface Params$Resource$Projects$Regions$Operations$Getiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6025,7 +6118,8 @@ export namespace dataproc_v1 { */ requestBody?: Schema$GetIamPolicyRequest; } - export interface Params$Resource$Projects$Regions$Operations$List { + export interface Params$Resource$Projects$Regions$Operations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6048,7 +6142,8 @@ export namespace dataproc_v1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Regions$Operations$Setiampolicy { + export interface Params$Resource$Projects$Regions$Operations$Setiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6065,7 +6160,8 @@ export namespace dataproc_v1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Regions$Operations$Testiampermissions { + export interface Params$Resource$Projects$Regions$Operations$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6832,7 +6928,8 @@ export namespace dataproc_v1 { } } - export interface Params$Resource$Projects$Regions$Workflowtemplates$Create { + export interface Params$Resource$Projects$Regions$Workflowtemplates$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6850,7 +6947,8 @@ export namespace dataproc_v1 { */ requestBody?: Schema$WorkflowTemplate; } - export interface Params$Resource$Projects$Regions$Workflowtemplates$Delete { + export interface Params$Resource$Projects$Regions$Workflowtemplates$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6869,7 +6967,8 @@ export namespace dataproc_v1 { */ version?: number; } - export interface Params$Resource$Projects$Regions$Workflowtemplates$Get { + export interface Params$Resource$Projects$Regions$Workflowtemplates$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6888,7 +6987,8 @@ export namespace dataproc_v1 { */ version?: number; } - export interface Params$Resource$Projects$Regions$Workflowtemplates$Getiampolicy { + export interface Params$Resource$Projects$Regions$Workflowtemplates$Getiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6905,7 +7005,8 @@ export namespace dataproc_v1 { */ requestBody?: Schema$GetIamPolicyRequest; } - export interface Params$Resource$Projects$Regions$Workflowtemplates$Instantiate { + export interface Params$Resource$Projects$Regions$Workflowtemplates$Instantiate + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6923,7 +7024,8 @@ export namespace dataproc_v1 { */ requestBody?: Schema$InstantiateWorkflowTemplateRequest; } - export interface Params$Resource$Projects$Regions$Workflowtemplates$Instantiateinline { + export interface Params$Resource$Projects$Regions$Workflowtemplates$Instantiateinline + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6950,7 +7052,8 @@ export namespace dataproc_v1 { */ requestBody?: Schema$WorkflowTemplate; } - export interface Params$Resource$Projects$Regions$Workflowtemplates$List { + export interface Params$Resource$Projects$Regions$Workflowtemplates$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6972,7 +7075,8 @@ export namespace dataproc_v1 { */ parent?: string; } - export interface Params$Resource$Projects$Regions$Workflowtemplates$Setiampolicy { + export interface Params$Resource$Projects$Regions$Workflowtemplates$Setiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6989,7 +7093,8 @@ export namespace dataproc_v1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Regions$Workflowtemplates$Testiampermissions { + export interface Params$Resource$Projects$Regions$Workflowtemplates$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7006,7 +7111,8 @@ export namespace dataproc_v1 { */ requestBody?: Schema$TestIamPermissionsRequest; } - export interface Params$Resource$Projects$Regions$Workflowtemplates$Update { + export interface Params$Resource$Projects$Regions$Workflowtemplates$Update + extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/dataproc/v1beta2.ts b/src/apis/dataproc/v1beta2.ts index 81214eee81..87e956b544 100644 --- a/src/apis/dataproc/v1beta2.ts +++ b/src/apis/dataproc/v1beta2.ts @@ -29,6 +29,57 @@ export namespace dataproc_v1beta2 { version: 'v1beta2'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Dataproc API * @@ -722,6 +773,12 @@ export namespace dataproc_v1beta2 { * Job is a Hive job. */ hiveJob?: Schema$HiveJob; + /** + * Output only. A UUID that uniquely identifies a job within the project + * over time. This is in contrast to a user-settable reference.job_id that + * may be reused over time. + */ + jobUuid?: string; /** * Optional. The labels to associate with this job. Label keys must contain * 1 to 63 characters, and must conform to RFC 1035 @@ -758,6 +815,10 @@ export namespace dataproc_v1beta2 { * Job is a Spark job. */ sparkJob?: Schema$SparkJob; + /** + * Job is a SparkR job. + */ + sparkRJob?: Schema$SparkRJob; /** * Job is a SparkSql job. */ @@ -1350,6 +1411,45 @@ export namespace dataproc_v1beta2 { */ properties?: any; } + /** + * A Cloud Dataproc job for running Apache SparkR + * (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. + */ + export interface Schema$SparkRJob { + /** + * Optional. HCFS URIs of archives to be extracted in the working directory + * of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, + * .tgz, and .zip. + */ + archiveUris?: string[]; + /** + * Optional. The arguments to pass to the driver. Do not include arguments, + * such as --conf, that can be set as job properties, since a collision may + * occur that causes an incorrect job submission. + */ + args?: string[]; + /** + * Optional. HCFS URIs of files to be copied to the working directory of R + * drivers and distributed tasks. Useful for naively parallel tasks. + */ + fileUris?: string[]; + /** + * Optional. The runtime log config for job execution. + */ + loggingConfig?: Schema$LoggingConfig; + /** + * Required. The HCFS URI of the main R file to use as the driver. Must be a + * .R file. + */ + mainRFileUri?: string; + /** + * Optional. A mapping of property names to values, used to configure + * SparkR. Properties that conflict with values set by the Cloud Dataproc + * API may be overwritten. Can include properties set in + * /etc/spark/conf/spark-defaults.conf and classes in user code. + */ + properties?: any; + } /** * A Cloud Dataproc job for running Apache Spark SQL * (http://spark.apache.org/sql/) queries. @@ -1472,27 +1572,31 @@ export namespace dataproc_v1beta2 { * field path is similar in syntax to a google.protobuf.FieldMask. For * example, a field path that references the zone field of a workflow * template's cluster selector would be specified as - * <code>placement.clusterSelector.zone</code>.Also, field paths - * can reference fields using the following syntax: Values in maps can be - * referenced by key. Examples<br> labels'key' - * placement.clusterSelector.clusterLabels'key' + * placement.clusterSelector.zone.Also, field paths can reference fields + * using the following syntax: Values in maps can be referenced by key: + * labels'key' placement.clusterSelector.clusterLabels'key' * placement.managedCluster.labels'key' * placement.clusterSelector.clusterLabels'key' - * jobsstep-id.labels'key' Jobs in the jobs list can be referenced - * by step-id. Examples:<br> jobsstep-id.hadoopJob.mainJarFileUri - * jobsstep-id.hiveJob.queryFileUri jobsstep-id.pySparkJob.mainPythonFileUri - * jobsstep-id.hadoopJob.jarFileUris0 jobsstep-id.hadoopJob.archiveUris0 - * jobsstep-id.hadoopJob.fileUris0 jobsstep-id.pySparkJob.pythonFileUris0 - * Items in repeated fields can be referenced by a zero-based index. - * Example:<br> jobsstep-id.sparkJob.args0 Other examples: - * jobsstep-id.hadoopJob.properties'key' jobsstep-id.hadoopJob.args0 - * jobsstep-id.hiveJob.scriptVariables'key' - * jobsstep-id.hadoopJob.mainJarFileUri placement.clusterSelector.zoneIt may - * not be possible to parameterize maps and repeated fields in their - * entirety since only individual map values and individual items in - * repeated fields can be referenced. For example, the following field paths - * are invalid: placement.clusterSelector.clusterLabels - * jobsstep-id.sparkJob.args + * jobs'step-id'.labels'key' Jobs in the jobs list can be + * referenced by step-id: jobs'step-id'.hadoopJob.mainJarFileUri + * jobs'step-id'.hiveJob.queryFileUri + * jobs'step-id'.pySparkJob.mainPythonFileUri + * jobs'step-id'.hadoopJob.jarFileUris0 + * jobs'step-id'.hadoopJob.archiveUris0 + * jobs'step-id'.hadoopJob.fileUris0 + * jobs'step-id'.pySparkJob.pythonFileUris0 Items in repeated fields + * can be referenced by a zero-based index: + * jobs'step-id'.sparkJob.args0 Other examples: + * jobs'step-id'.hadoopJob.properties'key' + * jobs'step-id'.hadoopJob.args0 + * jobs'step-id'.hiveJob.scriptVariables'key' + * jobs'step-id'.hadoopJob.mainJarFileUri + * placement.clusterSelector.zoneIt may not be possible to parameterize maps + * and repeated fields in their entirety since only individual map values + * and individual items in repeated fields can be referenced. For example, + * the following field paths are invalid: + * placement.clusterSelector.clusterLabels + * jobs'step-id'.sparkJob.args */ fields?: string[]; /** @@ -2512,7 +2616,8 @@ export namespace dataproc_v1beta2 { } } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Create { + export interface Params$Resource$Projects$Locations$Workflowtemplates$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2530,7 +2635,8 @@ export namespace dataproc_v1beta2 { */ requestBody?: Schema$WorkflowTemplate; } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Delete { + export interface Params$Resource$Projects$Locations$Workflowtemplates$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2549,7 +2655,8 @@ export namespace dataproc_v1beta2 { */ version?: number; } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Get { + export interface Params$Resource$Projects$Locations$Workflowtemplates$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2568,7 +2675,8 @@ export namespace dataproc_v1beta2 { */ version?: number; } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Getiampolicy { + export interface Params$Resource$Projects$Locations$Workflowtemplates$Getiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2580,7 +2688,8 @@ export namespace dataproc_v1beta2 { */ resource?: string; } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Instantiate { + export interface Params$Resource$Projects$Locations$Workflowtemplates$Instantiate + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2598,7 +2707,8 @@ export namespace dataproc_v1beta2 { */ requestBody?: Schema$InstantiateWorkflowTemplateRequest; } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Instantiateinline { + export interface Params$Resource$Projects$Locations$Workflowtemplates$Instantiateinline + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2629,7 +2739,8 @@ export namespace dataproc_v1beta2 { */ requestBody?: Schema$WorkflowTemplate; } - export interface Params$Resource$Projects$Locations$Workflowtemplates$List { + export interface Params$Resource$Projects$Locations$Workflowtemplates$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2651,7 +2762,8 @@ export namespace dataproc_v1beta2 { */ parent?: string; } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy { + export interface Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2668,7 +2780,8 @@ export namespace dataproc_v1beta2 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions { + export interface Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2685,7 +2798,8 @@ export namespace dataproc_v1beta2 { */ requestBody?: Schema$TestIamPermissionsRequest; } - export interface Params$Resource$Projects$Locations$Workflowtemplates$Update { + export interface Params$Resource$Projects$Locations$Workflowtemplates$Update + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3389,7 +3503,8 @@ export namespace dataproc_v1beta2 { } } - export interface Params$Resource$Projects$Regions$Clusters$Create { + export interface Params$Resource$Projects$Regions$Clusters$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3421,7 +3536,8 @@ export namespace dataproc_v1beta2 { */ requestBody?: Schema$Cluster; } - export interface Params$Resource$Projects$Regions$Clusters$Delete { + export interface Params$Resource$Projects$Regions$Clusters$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3457,7 +3573,8 @@ export namespace dataproc_v1beta2 { */ requestId?: string; } - export interface Params$Resource$Projects$Regions$Clusters$Diagnose { + export interface Params$Resource$Projects$Regions$Clusters$Diagnose extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3482,7 +3599,8 @@ export namespace dataproc_v1beta2 { */ requestBody?: Schema$DiagnoseClusterRequest; } - export interface Params$Resource$Projects$Regions$Clusters$Get { + export interface Params$Resource$Projects$Regions$Clusters$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3502,7 +3620,8 @@ export namespace dataproc_v1beta2 { */ region?: string; } - export interface Params$Resource$Projects$Regions$Clusters$Getiampolicy { + export interface Params$Resource$Projects$Regions$Clusters$Getiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3514,7 +3633,8 @@ export namespace dataproc_v1beta2 { */ resource?: string; } - export interface Params$Resource$Projects$Regions$Clusters$List { + export interface Params$Resource$Projects$Regions$Clusters$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3553,7 +3673,8 @@ export namespace dataproc_v1beta2 { */ region?: string; } - export interface Params$Resource$Projects$Regions$Clusters$Patch { + export interface Params$Resource$Projects$Regions$Clusters$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3625,7 +3746,8 @@ export namespace dataproc_v1beta2 { */ requestBody?: Schema$Cluster; } - export interface Params$Resource$Projects$Regions$Clusters$Setiampolicy { + export interface Params$Resource$Projects$Regions$Clusters$Setiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3642,7 +3764,8 @@ export namespace dataproc_v1beta2 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Regions$Clusters$Testiampermissions { + export interface Params$Resource$Projects$Regions$Clusters$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4314,7 +4437,8 @@ export namespace dataproc_v1beta2 { } } - export interface Params$Resource$Projects$Regions$Jobs$Cancel { + export interface Params$Resource$Projects$Regions$Jobs$Cancel extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4339,7 +4463,8 @@ export namespace dataproc_v1beta2 { */ requestBody?: Schema$CancelJobRequest; } - export interface Params$Resource$Projects$Regions$Jobs$Delete { + export interface Params$Resource$Projects$Regions$Jobs$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4359,7 +4484,8 @@ export namespace dataproc_v1beta2 { */ region?: string; } - export interface Params$Resource$Projects$Regions$Jobs$Get { + export interface Params$Resource$Projects$Regions$Jobs$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4379,7 +4505,8 @@ export namespace dataproc_v1beta2 { */ region?: string; } - export interface Params$Resource$Projects$Regions$Jobs$Getiampolicy { + export interface Params$Resource$Projects$Regions$Jobs$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4391,7 +4518,8 @@ export namespace dataproc_v1beta2 { */ resource?: string; } - export interface Params$Resource$Projects$Regions$Jobs$List { + export interface Params$Resource$Projects$Regions$Jobs$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4437,7 +4565,8 @@ export namespace dataproc_v1beta2 { */ region?: string; } - export interface Params$Resource$Projects$Regions$Jobs$Patch { + export interface Params$Resource$Projects$Regions$Jobs$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4471,7 +4600,8 @@ export namespace dataproc_v1beta2 { */ requestBody?: Schema$Job; } - export interface Params$Resource$Projects$Regions$Jobs$Setiampolicy { + export interface Params$Resource$Projects$Regions$Jobs$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4488,7 +4618,8 @@ export namespace dataproc_v1beta2 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Regions$Jobs$Submit { + export interface Params$Resource$Projects$Regions$Jobs$Submit extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4509,7 +4640,8 @@ export namespace dataproc_v1beta2 { */ requestBody?: Schema$SubmitJobRequest; } - export interface Params$Resource$Projects$Regions$Jobs$Testiampermissions { + export interface Params$Resource$Projects$Regions$Jobs$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5042,7 +5174,8 @@ export namespace dataproc_v1beta2 { } } - export interface Params$Resource$Projects$Regions$Operations$Cancel { + export interface Params$Resource$Projects$Regions$Operations$Cancel extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5053,7 +5186,8 @@ export namespace dataproc_v1beta2 { */ name?: string; } - export interface Params$Resource$Projects$Regions$Operations$Delete { + export interface Params$Resource$Projects$Regions$Operations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5064,7 +5198,8 @@ export namespace dataproc_v1beta2 { */ name?: string; } - export interface Params$Resource$Projects$Regions$Operations$Get { + export interface Params$Resource$Projects$Regions$Operations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5075,7 +5210,8 @@ export namespace dataproc_v1beta2 { */ name?: string; } - export interface Params$Resource$Projects$Regions$Operations$Getiampolicy { + export interface Params$Resource$Projects$Regions$Operations$Getiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5087,7 +5223,8 @@ export namespace dataproc_v1beta2 { */ resource?: string; } - export interface Params$Resource$Projects$Regions$Operations$List { + export interface Params$Resource$Projects$Regions$Operations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5110,7 +5247,8 @@ export namespace dataproc_v1beta2 { */ pageToken?: string; } - export interface Params$Resource$Projects$Regions$Operations$Setiampolicy { + export interface Params$Resource$Projects$Regions$Operations$Setiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5127,7 +5265,8 @@ export namespace dataproc_v1beta2 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Regions$Operations$Testiampermissions { + export interface Params$Resource$Projects$Regions$Operations$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5894,7 +6033,8 @@ export namespace dataproc_v1beta2 { } } - export interface Params$Resource$Projects$Regions$Workflowtemplates$Create { + export interface Params$Resource$Projects$Regions$Workflowtemplates$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5912,7 +6052,8 @@ export namespace dataproc_v1beta2 { */ requestBody?: Schema$WorkflowTemplate; } - export interface Params$Resource$Projects$Regions$Workflowtemplates$Delete { + export interface Params$Resource$Projects$Regions$Workflowtemplates$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5931,7 +6072,8 @@ export namespace dataproc_v1beta2 { */ version?: number; } - export interface Params$Resource$Projects$Regions$Workflowtemplates$Get { + export interface Params$Resource$Projects$Regions$Workflowtemplates$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5950,7 +6092,8 @@ export namespace dataproc_v1beta2 { */ version?: number; } - export interface Params$Resource$Projects$Regions$Workflowtemplates$Getiampolicy { + export interface Params$Resource$Projects$Regions$Workflowtemplates$Getiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5962,7 +6105,8 @@ export namespace dataproc_v1beta2 { */ resource?: string; } - export interface Params$Resource$Projects$Regions$Workflowtemplates$Instantiate { + export interface Params$Resource$Projects$Regions$Workflowtemplates$Instantiate + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5980,7 +6124,8 @@ export namespace dataproc_v1beta2 { */ requestBody?: Schema$InstantiateWorkflowTemplateRequest; } - export interface Params$Resource$Projects$Regions$Workflowtemplates$Instantiateinline { + export interface Params$Resource$Projects$Regions$Workflowtemplates$Instantiateinline + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6011,7 +6156,8 @@ export namespace dataproc_v1beta2 { */ requestBody?: Schema$WorkflowTemplate; } - export interface Params$Resource$Projects$Regions$Workflowtemplates$List { + export interface Params$Resource$Projects$Regions$Workflowtemplates$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6033,7 +6179,8 @@ export namespace dataproc_v1beta2 { */ parent?: string; } - export interface Params$Resource$Projects$Regions$Workflowtemplates$Setiampolicy { + export interface Params$Resource$Projects$Regions$Workflowtemplates$Setiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6050,7 +6197,8 @@ export namespace dataproc_v1beta2 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Regions$Workflowtemplates$Testiampermissions { + export interface Params$Resource$Projects$Regions$Workflowtemplates$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6067,7 +6215,8 @@ export namespace dataproc_v1beta2 { */ requestBody?: Schema$TestIamPermissionsRequest; } - export interface Params$Resource$Projects$Regions$Workflowtemplates$Update { + export interface Params$Resource$Projects$Regions$Workflowtemplates$Update + extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/datastore/v1.ts b/src/apis/datastore/v1.ts index acd19b1535..256370af4e 100644 --- a/src/apis/datastore/v1.ts +++ b/src/apis/datastore/v1.ts @@ -29,6 +29,57 @@ export namespace datastore_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Datastore API * @@ -1910,7 +1961,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Import|BodyResponseCallback( + T = dfareporting_v3_0.Dfareporting | dfareporting_v3_1.Dfareporting | + dfareporting_v3_2.Dfareporting>( this: GoogleConfigurable, - versionOrOptions: 'v2_8'|dfareporting_v2_8.Options|'v3_0'| - dfareporting_v3_0.Options|'v3_1'| + versionOrOptions: 'v3_0'|dfareporting_v3_0.Options|'v3_1'| dfareporting_v3_1.Options|'v3_2'|dfareporting_v3_2.Options) { return getAPI('dfareporting', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/dfareporting/v2.8.ts b/src/apis/dfareporting/v2.8.ts deleted file mode 100644 index 0873cc9dfe..0000000000 --- a/src/apis/dfareporting/v2.8.ts +++ /dev/null @@ -1,38703 +0,0 @@ -/** - * 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 dfareporting_v2_8 { - export interface Options extends GlobalOptions { - version: 'v2_8'; - } - - /** - * DCM/DFA Reporting And Trafficking API - * - * Manages your DoubleClick Campaign Manager ad campaigns and reports. - * - * @example - * const {google} = require('googleapis'); - * const dfareporting = google.dfareporting('v2.8'); - * - * @namespace dfareporting - * @type {Function} - * @version v2.8 - * @variation v2.8 - * @param {object=} options Options for Dfareporting - */ - export class Dfareporting { - _options: GlobalOptions; - google?: GoogleConfigurable; - root = this; - - accountActiveAdSummaries: Resource$Accountactiveadsummaries; - accountPermissionGroups: Resource$Accountpermissiongroups; - accountPermissions: Resource$Accountpermissions; - accounts: Resource$Accounts; - accountUserProfiles: Resource$Accountuserprofiles; - ads: Resource$Ads; - advertiserGroups: Resource$Advertisergroups; - advertisers: Resource$Advertisers; - browsers: Resource$Browsers; - campaignCreativeAssociations: Resource$Campaigncreativeassociations; - campaigns: Resource$Campaigns; - changeLogs: Resource$Changelogs; - cities: Resource$Cities; - connectionTypes: Resource$Connectiontypes; - contentCategories: Resource$Contentcategories; - conversions: Resource$Conversions; - countries: Resource$Countries; - creativeAssets: Resource$Creativeassets; - creativeFields: Resource$Creativefields; - creativeFieldValues: Resource$Creativefieldvalues; - creativeGroups: Resource$Creativegroups; - creatives: Resource$Creatives; - dimensionValues: Resource$Dimensionvalues; - directorySiteContacts: Resource$Directorysitecontacts; - directorySites: Resource$Directorysites; - dynamicTargetingKeys: Resource$Dynamictargetingkeys; - eventTags: Resource$Eventtags; - files: Resource$Files; - floodlightActivities: Resource$Floodlightactivities; - floodlightActivityGroups: Resource$Floodlightactivitygroups; - floodlightConfigurations: Resource$Floodlightconfigurations; - inventoryItems: Resource$Inventoryitems; - landingPages: Resource$Landingpages; - languages: Resource$Languages; - metros: Resource$Metros; - mobileCarriers: Resource$Mobilecarriers; - operatingSystems: Resource$Operatingsystems; - operatingSystemVersions: Resource$Operatingsystemversions; - orderDocuments: Resource$Orderdocuments; - orders: Resource$Orders; - placementGroups: Resource$Placementgroups; - placements: Resource$Placements; - placementStrategies: Resource$Placementstrategies; - platformTypes: Resource$Platformtypes; - postalCodes: Resource$Postalcodes; - projects: Resource$Projects; - regions: Resource$Regions; - remarketingLists: Resource$Remarketinglists; - remarketingListShares: Resource$Remarketinglistshares; - reports: Resource$Reports; - sites: Resource$Sites; - sizes: Resource$Sizes; - subaccounts: Resource$Subaccounts; - targetableRemarketingLists: Resource$Targetableremarketinglists; - targetingTemplates: Resource$Targetingtemplates; - userProfiles: Resource$Userprofiles; - userRolePermissionGroups: Resource$Userrolepermissiongroups; - userRolePermissions: Resource$Userrolepermissions; - userRoles: Resource$Userroles; - videoFormats: Resource$Videoformats; - - constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this._options = options || {}; - this.google = google; - this.getRoot.bind(this); - - this.accountActiveAdSummaries = - new Resource$Accountactiveadsummaries(this); - this.accountPermissionGroups = new Resource$Accountpermissiongroups(this); - this.accountPermissions = new Resource$Accountpermissions(this); - this.accounts = new Resource$Accounts(this); - this.accountUserProfiles = new Resource$Accountuserprofiles(this); - this.ads = new Resource$Ads(this); - this.advertiserGroups = new Resource$Advertisergroups(this); - this.advertisers = new Resource$Advertisers(this); - this.browsers = new Resource$Browsers(this); - this.campaignCreativeAssociations = - new Resource$Campaigncreativeassociations(this); - this.campaigns = new Resource$Campaigns(this); - this.changeLogs = new Resource$Changelogs(this); - this.cities = new Resource$Cities(this); - this.connectionTypes = new Resource$Connectiontypes(this); - this.contentCategories = new Resource$Contentcategories(this); - this.conversions = new Resource$Conversions(this); - this.countries = new Resource$Countries(this); - this.creativeAssets = new Resource$Creativeassets(this); - this.creativeFields = new Resource$Creativefields(this); - this.creativeFieldValues = new Resource$Creativefieldvalues(this); - this.creativeGroups = new Resource$Creativegroups(this); - this.creatives = new Resource$Creatives(this); - this.dimensionValues = new Resource$Dimensionvalues(this); - this.directorySiteContacts = new Resource$Directorysitecontacts(this); - this.directorySites = new Resource$Directorysites(this); - this.dynamicTargetingKeys = new Resource$Dynamictargetingkeys(this); - this.eventTags = new Resource$Eventtags(this); - this.files = new Resource$Files(this); - this.floodlightActivities = new Resource$Floodlightactivities(this); - this.floodlightActivityGroups = - new Resource$Floodlightactivitygroups(this); - this.floodlightConfigurations = - new Resource$Floodlightconfigurations(this); - this.inventoryItems = new Resource$Inventoryitems(this); - this.landingPages = new Resource$Landingpages(this); - this.languages = new Resource$Languages(this); - this.metros = new Resource$Metros(this); - this.mobileCarriers = new Resource$Mobilecarriers(this); - this.operatingSystems = new Resource$Operatingsystems(this); - this.operatingSystemVersions = new Resource$Operatingsystemversions(this); - this.orderDocuments = new Resource$Orderdocuments(this); - this.orders = new Resource$Orders(this); - this.placementGroups = new Resource$Placementgroups(this); - this.placements = new Resource$Placements(this); - this.placementStrategies = new Resource$Placementstrategies(this); - this.platformTypes = new Resource$Platformtypes(this); - this.postalCodes = new Resource$Postalcodes(this); - this.projects = new Resource$Projects(this); - this.regions = new Resource$Regions(this); - this.remarketingLists = new Resource$Remarketinglists(this); - this.remarketingListShares = new Resource$Remarketinglistshares(this); - this.reports = new Resource$Reports(this); - this.sites = new Resource$Sites(this); - this.sizes = new Resource$Sizes(this); - this.subaccounts = new Resource$Subaccounts(this); - this.targetableRemarketingLists = - new Resource$Targetableremarketinglists(this); - this.targetingTemplates = new Resource$Targetingtemplates(this); - this.userProfiles = new Resource$Userprofiles(this); - this.userRolePermissionGroups = - new Resource$Userrolepermissiongroups(this); - this.userRolePermissions = new Resource$Userrolepermissions(this); - this.userRoles = new Resource$Userroles(this); - this.videoFormats = new Resource$Videoformats(this); - } - - getRoot() { - return this.root; - } - } - - /** - * Contains properties of a Campaign Manager account. - */ - export interface Schema$Account { - /** - * Account permissions assigned to this account. - */ - accountPermissionIds?: string[]; - /** - * Profile for this account. This is a read-only field that can be left - * blank. - */ - accountProfile?: string; - /** - * Whether this account is active. - */ - active?: boolean; - /** - * Maximum number of active ads allowed for this account. - */ - activeAdsLimitTier?: string; - /** - * Whether to serve creatives with Active View tags. If disabled, - * viewability data will not be available for any impressions. - */ - activeViewOptOut?: boolean; - /** - * User role permissions available to the user roles of this account. - */ - availablePermissionIds?: string[]; - /** - * ID of the country associated with this account. - */ - countryId?: string; - /** - * ID of currency associated with this account. This is a required field. - * Acceptable values are: - "1" for USD - "2" for GBP - * - "3" for ESP - "4" for SEK - "5" for CAD - * - "6" for JPY - "7" for DEM - "8" for AUD - * - "9" for FRF - "10" for ITL - "11" for - * DKK - "12" for NOK - "13" for FIM - "14" - * for ZAR - "15" for IEP - "16" for NLG - - * "17" for EUR - "18" for KRW - "19" for - * TWD - "20" for SGD - "21" for CNY - "22" - * for HKD - "23" for NZD - "24" for MYR - - * "25" for BRL - "26" for PTE - "27" for - * MXP - "28" for CLP - "29" for TRY - "30" - * for ARS - "31" for PEN - "32" for ILS - - * "33" for CHF - "34" for VEF - "35" for - * COP - "36" for GTQ - "37" for PLN - "39" - * for INR - "40" for THB - "41" for IDR - - * "42" for CZK - "43" for RON - "44" for - * HUF - "45" for RUB - "46" for AED - "47" - * for BGN - "48" for HRK - "49" for MXN - - * "50" for NGN - */ - currencyId?: string; - /** - * Default placement dimensions for this account. - */ - defaultCreativeSizeId?: string; - /** - * Description of this account. - */ - description?: string; - /** - * ID of this account. This is a read-only, auto-generated field. - */ - id?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#account". - */ - kind?: string; - /** - * Locale of this account. Acceptable values are: - "cs" (Czech) - * - "de" (German) - "en" (English) - - * "en-GB" (English United Kingdom) - "es" (Spanish) - - * "fr" (French) - "it" (Italian) - "ja" - * (Japanese) - "ko" (Korean) - "pl" (Polish) - - * "pt-BR" (Portuguese Brazil) - "ru" (Russian) - - * "sv" (Swedish) - "tr" (Turkish) - "zh-CN" - * (Chinese Simplified) - "zh-TW" (Chinese Traditional) - */ - locale?: string; - /** - * Maximum image size allowed for this account, in kilobytes. Value must be - * greater than or equal to 1. - */ - maximumImageSize?: string; - /** - * Name of this account. This is a required field, and must be less than 128 - * characters long and be globally unique. - */ - name?: string; - /** - * Whether campaigns created in this account will be enabled for Nielsen OCR - * reach ratings by default. - */ - nielsenOcrEnabled?: boolean; - /** - * Reporting configuration of this account. - */ - reportsConfiguration?: Schema$ReportsConfiguration; - /** - * Share Path to Conversion reports with Twitter. - */ - shareReportsWithTwitter?: boolean; - /** - * File size limit in kilobytes of Rich Media teaser creatives. Acceptable - * values are 1 to 10240, inclusive. - */ - teaserSizeLimit?: string; - } - /** - * Gets a summary of active ads in an account. - */ - export interface Schema$AccountActiveAdSummary { - /** - * ID of the account. - */ - accountId?: string; - /** - * Ads that have been activated for the account - */ - activeAds?: string; - /** - * Maximum number of active ads allowed for the account. - */ - activeAdsLimitTier?: string; - /** - * Ads that can be activated for the account. - */ - availableAds?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#accountActiveAdSummary". - */ - kind?: string; - } - /** - * AccountPermissions contains information about a particular account - * permission. Some features of Campaign Manager require an account permission - * to be present in the account. - */ - export interface Schema$AccountPermission { - /** - * Account profiles associated with this account permission. Possible - * values are: - "ACCOUNT_PROFILE_BASIC" - - * "ACCOUNT_PROFILE_STANDARD" - */ - accountProfiles?: string[]; - /** - * ID of this account permission. - */ - id?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#accountPermission". - */ - kind?: string; - /** - * Administrative level required to enable this account permission. - */ - level?: string; - /** - * Name of this account permission. - */ - name?: string; - /** - * Permission group of this account permission. - */ - permissionGroupId?: string; - } - /** - * AccountPermissionGroups contains a mapping of permission group IDs to - * names. A permission group is a grouping of account permissions. - */ - export interface Schema$AccountPermissionGroup { - /** - * ID of this account permission group. - */ - id?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#accountPermissionGroup". - */ - kind?: string; - /** - * Name of this account permission group. - */ - name?: string; - } - /** - * Account Permission Group List Response - */ - export interface Schema$AccountPermissionGroupsListResponse { - /** - * Account permission group collection. - */ - accountPermissionGroups?: Schema$AccountPermissionGroup[]; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#accountPermissionGroupsListResponse". - */ - kind?: string; - } - /** - * Account Permission List Response - */ - export interface Schema$AccountPermissionsListResponse { - /** - * Account permission collection. - */ - accountPermissions?: Schema$AccountPermission[]; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#accountPermissionsListResponse". - */ - kind?: string; - } - /** - * Account List Response - */ - export interface Schema$AccountsListResponse { - /** - * Account collection. - */ - accounts?: Schema$Account[]; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#accountsListResponse". - */ - kind?: string; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string; - } - /** - * AccountUserProfiles contains properties of a Campaign Manager user profile. - * This resource is specifically for managing user profiles, whereas - * UserProfiles is for accessing the API. - */ - export interface Schema$AccountUserProfile { - /** - * Account ID of the user profile. This is a read-only field that can be - * left blank. - */ - accountId?: string; - /** - * Whether this user profile is active. This defaults to false, and must be - * set true on insert for the user profile to be usable. - */ - active?: boolean; - /** - * Filter that describes which advertisers are visible to the user profile. - */ - advertiserFilter?: Schema$ObjectFilter; - /** - * Filter that describes which campaigns are visible to the user profile. - */ - campaignFilter?: Schema$ObjectFilter; - /** - * Comments for this user profile. - */ - comments?: string; - /** - * Email of the user profile. The email addresss must be linked to a Google - * Account. This field is required on insertion and is read-only after - * insertion. - */ - email?: string; - /** - * ID of the user profile. This is a read-only, auto-generated field. - */ - id?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#accountUserProfile". - */ - kind?: string; - /** - * Locale of the user profile. This is a required field. Acceptable values - * are: - "cs" (Czech) - "de" (German) - - * "en" (English) - "en-GB" (English United Kingdom) - - * "es" (Spanish) - "fr" (French) - "it" - * (Italian) - "ja" (Japanese) - "ko" (Korean) - - * "pl" (Polish) - "pt-BR" (Portuguese Brazil) - - * "ru" (Russian) - "sv" (Swedish) - "tr" - * (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" - * (Chinese Traditional) - */ - locale?: string; - /** - * Name of the user profile. This is a required field. Must be less than 64 - * characters long, must be globally unique, and cannot contain whitespace - * or any of the following characters: "&;"#%,". - */ - name?: string; - /** - * Filter that describes which sites are visible to the user profile. - */ - siteFilter?: Schema$ObjectFilter; - /** - * Subaccount ID of the user profile. This is a read-only field that can be - * left blank. - */ - subaccountId?: string; - /** - * Trafficker type of this user profile. This is a read-only field. - */ - traffickerType?: string; - /** - * User type of the user profile. This is a read-only field that can be left - * blank. - */ - userAccessType?: string; - /** - * Filter that describes which user roles are visible to the user profile. - */ - userRoleFilter?: Schema$ObjectFilter; - /** - * User role ID of the user profile. This is a required field. - */ - userRoleId?: string; - } - /** - * Account User Profile List Response - */ - export interface Schema$AccountUserProfilesListResponse { - /** - * Account user profile collection. - */ - accountUserProfiles?: Schema$AccountUserProfile[]; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#accountUserProfilesListResponse". - */ - kind?: string; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string; - } - /** - * Represents an activity group. - */ - export interface Schema$Activities { - /** - * List of activity filters. The dimension values need to be all either of - * type "dfa:activity" or "dfa:activityGroup". - */ - filters?: Schema$DimensionValue[]; - /** - * The kind of resource this is, in this case dfareporting#activities. - */ - kind?: string; - /** - * List of names of floodlight activity metrics. - */ - metricNames?: string[]; - } - /** - * Contains properties of a Campaign Manager ad. - */ - export interface Schema$Ad { - /** - * Account ID of this ad. This is a read-only field that can be left blank. - */ - accountId?: string; - /** - * Whether this ad is active. When true, archived must be false. - */ - active?: boolean; - /** - * Advertiser ID of this ad. This is a required field on insertion. - */ - advertiserId?: string; - /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Whether this ad is archived. When true, active must be false. - */ - archived?: boolean; - /** - * Audience segment ID that is being targeted for this ad. Applicable when - * type is AD_SERVING_STANDARD_AD. - */ - audienceSegmentId?: string; - /** - * Campaign ID of this ad. This is a required field on insertion. - */ - campaignId?: string; - /** - * Dimension value for the ID of the campaign. This is a read-only, - * auto-generated field. - */ - campaignIdDimensionValue?: Schema$DimensionValue; - /** - * Click-through URL for this ad. This is a required field on insertion. - * Applicable when type is AD_SERVING_CLICK_TRACKER. - */ - clickThroughUrl?: Schema$ClickThroughUrl; - /** - * Click-through URL suffix properties for this ad. Applies to the URL in - * the ad or (if overriding ad properties) the URL in the creative. - */ - clickThroughUrlSuffixProperties?: Schema$ClickThroughUrlSuffixProperties; - /** - * Comments for this ad. - */ - comments?: string; - /** - * Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. - * DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or - * on mobile devices or in mobile apps for regular or interstitial ads, - * respectively. APP and APP_INTERSTITIAL are only used for existing default - * ads. New mobile placements must be assigned DISPLAY or - * DISPLAY_INTERSTITIAL and default ads created for those placements will be - * limited to those compatibility types. IN_STREAM_VIDEO refers to rendering - * in-stream video ads developed with the VAST standard. - */ - compatibility?: string; - /** - * Information about the creation of this ad. This is a read-only field. - */ - createInfo?: Schema$LastModifiedInfo; - /** - * Creative group assignments for this ad. Applicable when type is - * AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number - * is allowed for a maximum of two assignments. - */ - creativeGroupAssignments?: Schema$CreativeGroupAssignment[]; - /** - * Creative rotation for this ad. Applicable when type is - * AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. - * When type is AD_SERVING_DEFAULT_AD, this field should have exactly one - * creativeAssignment. - */ - creativeRotation?: Schema$CreativeRotation; - /** - * Time and day targeting information for this ad. This field must be left - * blank if the ad is using a targeting template. Applicable when type is - * AD_SERVING_STANDARD_AD. - */ - dayPartTargeting?: Schema$DayPartTargeting; - /** - * Default click-through event tag properties for this ad. - */ - defaultClickThroughEventTagProperties?: - Schema$DefaultClickThroughEventTagProperties; - /** - * Delivery schedule information for this ad. Applicable when type is - * AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with - * subfields priority and impressionRatio are required on insertion when - * type is AD_SERVING_STANDARD_AD. - */ - deliverySchedule?: Schema$DeliverySchedule; - /** - * Whether this ad is a dynamic click tracker. Applicable when type is - * AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is - * read-only after insert. - */ - dynamicClickTracker?: boolean; - /** - * Date and time that this ad should stop serving. Must be later than the - * start time. This is a required field on insertion. - */ - endTime?: string; - /** - * Event tag overrides for this ad. - */ - eventTagOverrides?: Schema$EventTagOverride[]; - /** - * Geographical targeting information for this ad. This field must be left - * blank if the ad is using a targeting template. Applicable when type is - * AD_SERVING_STANDARD_AD. - */ - geoTargeting?: Schema$GeoTargeting; - /** - * ID of this ad. This is a read-only, auto-generated field. - */ - id?: string; - /** - * Dimension value for the ID of this ad. This is a read-only, - * auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Key-value targeting information for this ad. This field must be left - * blank if the ad is using a targeting template. Applicable when type is - * AD_SERVING_STANDARD_AD. - */ - keyValueTargetingExpression?: Schema$KeyValueTargetingExpression; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#ad". - */ - kind?: string; - /** - * Language targeting information for this ad. This field must be left blank - * if the ad is using a targeting template. Applicable when type is - * AD_SERVING_STANDARD_AD. - */ - languageTargeting?: Schema$LanguageTargeting; - /** - * Information about the most recent modification of this ad. This is a - * read-only field. - */ - lastModifiedInfo?: Schema$LastModifiedInfo; - /** - * Name of this ad. This is a required field and must be less than 256 - * characters long. - */ - name?: string; - /** - * Placement assignments for this ad. - */ - placementAssignments?: Schema$PlacementAssignment[]; - /** - * Remarketing list targeting expression for this ad. This field must be - * left blank if the ad is using a targeting template. Applicable when type - * is AD_SERVING_STANDARD_AD. - */ - remarketingListExpression?: Schema$ListTargetingExpression; - /** - * Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. - */ - size?: Schema$Size; - /** - * Whether this ad is ssl compliant. This is a read-only field that is - * auto-generated when the ad is inserted or updated. - */ - sslCompliant?: boolean; - /** - * Whether this ad requires ssl. This is a read-only field that is - * auto-generated when the ad is inserted or updated. - */ - sslRequired?: boolean; - /** - * Date and time that this ad should start serving. If creating an ad, this - * field must be a time in the future. This is a required field on - * insertion. - */ - startTime?: string; - /** - * Subaccount ID of this ad. This is a read-only field that can be left - * blank. - */ - subaccountId?: string; - /** - * Targeting template ID, used to apply preconfigured targeting information - * to this ad. This cannot be set while any of dayPartTargeting, - * geoTargeting, keyValueTargetingExpression, languageTargeting, - * remarketingListExpression, or technologyTargeting are set. Applicable - * when type is AD_SERVING_STANDARD_AD. - */ - targetingTemplateId?: string; - /** - * Technology platform targeting information for this ad. This field must be - * left blank if the ad is using a targeting template. Applicable when type - * is AD_SERVING_STANDARD_AD. - */ - technologyTargeting?: Schema$TechnologyTargeting; - /** - * Type of ad. This is a required field on insertion. Note that default ads - * (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative - * resource). - */ - type?: string; - } - /** - * Campaign ad blocking settings. - */ - export interface Schema$AdBlockingConfiguration { - /** - * Click-through URL used by brand-neutral ads. This is a required field - * when overrideClickThroughUrl is set to true. - */ - clickThroughUrl?: string; - /** - * ID of a creative bundle to use for this campaign. If set, brand-neutral - * ads will select creatives from this bundle. Otherwise, a default - * transparent pixel will be used. - */ - creativeBundleId?: string; - /** - * Whether this campaign has enabled ad blocking. When true, ad blocking is - * enabled for placements in the campaign, but this may be overridden by - * site and placement settings. When false, ad blocking is disabled for all - * placements under the campaign, regardless of site and placement settings. - */ - enabled?: boolean; - /** - * Whether the brand-neutral ad's click-through URL comes from the - * campaign's creative bundle or the override URL. Must be set to true - * if ad blocking is enabled and no creative bundle is configured. - */ - overrideClickThroughUrl?: boolean; - } - /** - * Ad List Response - */ - export interface Schema$AdsListResponse { - /** - * Ad collection. - */ - ads?: Schema$Ad[]; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#adsListResponse". - */ - kind?: string; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string; - } - /** - * Ad Slot - */ - export interface Schema$AdSlot { - /** - * Comment for this ad slot. - */ - comment?: string; - /** - * Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to - * rendering either on desktop, mobile devices or in mobile apps for regular - * or interstitial ads respectively. APP and APP_INTERSTITIAL are for - * rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in - * in-stream video ads developed with the VAST standard. - */ - compatibility?: string; - /** - * Height of this ad slot. - */ - height?: string; - /** - * ID of the placement from an external platform that is linked to this ad - * slot. - */ - linkedPlacementId?: string; - /** - * Name of this ad slot. - */ - name?: string; - /** - * Payment source type of this ad slot. - */ - paymentSourceType?: string; - /** - * Primary ad slot of a roadblock inventory item. - */ - primary?: boolean; - /** - * Width of this ad slot. - */ - width?: string; - } - /** - * Contains properties of a Campaign Manager advertiser. - */ - export interface Schema$Advertiser { - /** - * Account ID of this advertiser.This is a read-only field that can be left - * blank. - */ - accountId?: string; - /** - * ID of the advertiser group this advertiser belongs to. You can group - * advertisers for reporting purposes, allowing you to see aggregated - * information for all advertisers in each group. - */ - advertiserGroupId?: string; - /** - * Suffix added to click-through URL of ad creative associations under this - * advertiser. Must be less than 129 characters long. - */ - clickThroughUrlSuffix?: string; - /** - * ID of the click-through event tag to apply by default to the landing - * pages of this advertiser's campaigns. - */ - defaultClickThroughEventTagId?: string; - /** - * Default email address used in sender field for tag emails. - */ - defaultEmail?: string; - /** - * Floodlight configuration ID of this advertiser. The floodlight - * configuration ID will be created automatically, so on insert this field - * should be left blank. This field can be set to another advertiser's - * floodlight configuration ID in order to share that advertiser's - * floodlight configuration with this advertiser, so long as: - This - * advertiser's original floodlight configuration is not already - * associated with floodlight activities or floodlight activity groups. - - * This advertiser's original floodlight configuration is not already - * shared with another advertiser. - */ - floodlightConfigurationId?: string; - /** - * Dimension value for the ID of the floodlight configuration. This is a - * read-only, auto-generated field. - */ - floodlightConfigurationIdDimensionValue?: Schema$DimensionValue; - /** - * ID of this advertiser. This is a read-only, auto-generated field. - */ - id?: string; - /** - * Dimension value for the ID of this advertiser. This is a read-only, - * auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#advertiser". - */ - kind?: string; - /** - * Name of this advertiser. This is a required field and must be less than - * 256 characters long and unique among advertisers of the same account. - */ - name?: string; - /** - * Original floodlight configuration before any sharing occurred. Set the - * floodlightConfigurationId of this advertiser to - * originalFloodlightConfigurationId to unshare the advertiser's current - * floodlight configuration. You cannot unshare an advertiser's - * floodlight configuration if the shared configuration has activities - * associated with any campaign or placement. - */ - originalFloodlightConfigurationId?: string; - /** - * Status of this advertiser. - */ - status?: string; - /** - * Subaccount ID of this advertiser.This is a read-only field that can be - * left blank. - */ - subaccountId?: string; - /** - * Suspension status of this advertiser. - */ - suspended?: boolean; - } - /** - * Groups advertisers together so that reports can be generated for the entire - * group at once. - */ - export interface Schema$AdvertiserGroup { - /** - * Account ID of this advertiser group. This is a read-only field that can - * be left blank. - */ - accountId?: string; - /** - * ID of this advertiser group. This is a read-only, auto-generated field. - */ - id?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#advertiserGroup". - */ - kind?: string; - /** - * Name of this advertiser group. This is a required field and must be less - * than 256 characters long and unique among advertiser groups of the same - * account. - */ - name?: string; - } - /** - * Advertiser Group List Response - */ - export interface Schema$AdvertiserGroupsListResponse { - /** - * Advertiser group collection. - */ - advertiserGroups?: Schema$AdvertiserGroup[]; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#advertiserGroupsListResponse". - */ - kind?: string; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string; - } - /** - * Advertiser List Response - */ - export interface Schema$AdvertisersListResponse { - /** - * Advertiser collection. - */ - advertisers?: Schema$Advertiser[]; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#advertisersListResponse". - */ - kind?: string; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string; - } - /** - * Audience Segment. - */ - export interface Schema$AudienceSegment { - /** - * Weight allocated to this segment. The weight assigned will be understood - * in proportion to the weights assigned to other segments in the same - * segment group. Acceptable values are 1 to 1000, inclusive. - */ - allocation?: number; - /** - * ID of this audience segment. This is a read-only, auto-generated field. - */ - id?: string; - /** - * Name of this audience segment. This is a required field and must be less - * than 65 characters long. - */ - name?: string; - } - /** - * Audience Segment Group. - */ - export interface Schema$AudienceSegmentGroup { - /** - * Audience segments assigned to this group. The number of segments must be - * between 2 and 100. - */ - audienceSegments?: Schema$AudienceSegment[]; - /** - * ID of this audience segment group. This is a read-only, auto-generated - * field. - */ - id?: string; - /** - * Name of this audience segment group. This is a required field and must be - * less than 65 characters long. - */ - name?: string; - } - /** - * Contains information about a browser that can be targeted by ads. - */ - export interface Schema$Browser { - /** - * ID referring to this grouping of browser and version numbers. This is the - * ID used for targeting. - */ - browserVersionId?: string; - /** - * DART ID of this browser. This is the ID used when generating reports. - */ - dartId?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#browser". - */ - kind?: string; - /** - * Major version number (leftmost number) of this browser. For example, for - * Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) - * may be used to target any version number, and a question mark (?) may be - * used to target cases where the version number cannot be identified. For - * example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so - * on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets - * cases where the ad server knows the browser is Firefox but can't tell - * which version it is. - */ - majorVersion?: string; - /** - * Minor version number (number after first dot on left) of this browser. - * For example, for Chrome 5.0.375.86 beta, this field should be set to 0. - * An asterisk (*) may be used to target any version number, and a question - * mark (?) may be used to target cases where the version number cannot be - * identified. For example, Chrome *.* targets any version of Chrome: - * 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but - * not 4.0. Firefox ?.? targets cases where the ad server knows the browser - * is Firefox but can't tell which version it is. - */ - minorVersion?: string; - /** - * Name of this browser. - */ - name?: string; - } - /** - * Browser List Response - */ - export interface Schema$BrowsersListResponse { - /** - * Browser collection. - */ - browsers?: Schema$Browser[]; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#browsersListResponse". - */ - kind?: string; - } - /** - * Contains properties of a Campaign Manager campaign. - */ - export interface Schema$Campaign { - /** - * Account ID of this campaign. This is a read-only field that can be left - * blank. - */ - accountId?: string; - /** - * Ad blocking settings for this campaign. - */ - adBlockingConfiguration?: Schema$AdBlockingConfiguration; - /** - * Additional creative optimization configurations for the campaign. - */ - additionalCreativeOptimizationConfigurations?: - Schema$CreativeOptimizationConfiguration[]; - /** - * Advertiser group ID of the associated advertiser. - */ - advertiserGroupId?: string; - /** - * Advertiser ID of this campaign. This is a required field. - */ - advertiserId?: string; - /** - * Dimension value for the advertiser ID of this campaign. This is a - * read-only, auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Whether this campaign has been archived. - */ - archived?: boolean; - /** - * Audience segment groups assigned to this campaign. Cannot have more than - * 300 segment groups. - */ - audienceSegmentGroups?: Schema$AudienceSegmentGroup[]; - /** - * Billing invoice code included in the Campaign Manager client billing - * invoices associated with the campaign. - */ - billingInvoiceCode?: string; - /** - * Click-through URL suffix override properties for this campaign. - */ - clickThroughUrlSuffixProperties?: Schema$ClickThroughUrlSuffixProperties; - /** - * Arbitrary comments about this campaign. Must be less than 256 characters - * long. - */ - comment?: string; - /** - * Information about the creation of this campaign. This is a read-only - * field. - */ - createInfo?: Schema$LastModifiedInfo; - /** - * List of creative group IDs that are assigned to the campaign. - */ - creativeGroupIds?: string[]; - /** - * Creative optimization configuration for the campaign. - */ - creativeOptimizationConfiguration?: - Schema$CreativeOptimizationConfiguration; - /** - * Click-through event tag ID override properties for this campaign. - */ - defaultClickThroughEventTagProperties?: - Schema$DefaultClickThroughEventTagProperties; - /** - * Date on which the campaign will stop running. On insert, the end date - * must be today or a future date. The end date must be later than or be the - * same as the start date. If, for example, you set 6/25/2015 as both the - * start and end dates, the effective campaign run date is just that day - * only, 6/25/2015. The hours, minutes, and seconds of the end date should - * not be set, as doing so will result in an error. This is a required - * field. - */ - endDate?: string; - /** - * Overrides that can be used to activate or deactivate advertiser event - * tags. - */ - eventTagOverrides?: Schema$EventTagOverride[]; - /** - * External ID for this campaign. - */ - externalId?: string; - /** - * ID of this campaign. This is a read-only auto-generated field. - */ - id?: string; - /** - * Dimension value for the ID of this campaign. This is a read-only, - * auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#campaign". - */ - kind?: string; - /** - * Information about the most recent modification of this campaign. This is - * a read-only field. - */ - lastModifiedInfo?: Schema$LastModifiedInfo; - /** - * Lookback window settings for the campaign. - */ - lookbackConfiguration?: Schema$LookbackConfiguration; - /** - * Name of this campaign. This is a required field and must be less than 256 - * characters long and unique among campaigns of the same advertiser. - */ - name?: string; - /** - * Whether Nielsen reports are enabled for this campaign. - */ - nielsenOcrEnabled?: boolean; - /** - * Date on which the campaign starts running. The start date can be any - * date. The hours, minutes, and seconds of the start date should not be - * set, as doing so will result in an error. This is a required field. - */ - startDate?: string; - /** - * Subaccount ID of this campaign. This is a read-only field that can be - * left blank. - */ - subaccountId?: string; - /** - * Campaign trafficker contact emails. - */ - traffickerEmails?: string[]; - } - /** - * Identifies a creative which has been associated with a given campaign. - */ - export interface Schema$CampaignCreativeAssociation { - /** - * ID of the creative associated with the campaign. This is a required - * field. - */ - creativeId?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#campaignCreativeAssociation". - */ - kind?: string; - } - /** - * Campaign Creative Association List Response - */ - export interface Schema$CampaignCreativeAssociationsListResponse { - /** - * Campaign creative association collection - */ - campaignCreativeAssociations?: Schema$CampaignCreativeAssociation[]; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#campaignCreativeAssociationsListResponse". - */ - kind?: string; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string; - } - /** - * Campaign List Response - */ - export interface Schema$CampaignsListResponse { - /** - * Campaign collection. - */ - campaigns?: Schema$Campaign[]; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#campaignsListResponse". - */ - kind?: string; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string; - } - /** - * Describes a change that a user has made to a resource. - */ - export interface Schema$ChangeLog { - /** - * Account ID of the modified object. - */ - accountId?: string; - /** - * Action which caused the change. - */ - action?: string; - /** - * Time when the object was modified. - */ - changeTime?: string; - /** - * Field name of the object which changed. - */ - fieldName?: string; - /** - * ID of this change log. - */ - id?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#changeLog". - */ - kind?: string; - /** - * New value of the object field. - */ - newValue?: string; - /** - * ID of the object of this change log. The object could be a campaign, - * placement, ad, or other type. - */ - objectId?: string; - /** - * Object type of the change log. - */ - objectType?: string; - /** - * Old value of the object field. - */ - oldValue?: string; - /** - * Subaccount ID of the modified object. - */ - subaccountId?: string; - /** - * Transaction ID of this change log. When a single API call results in many - * changes, each change will have a separate ID in the change log but will - * share the same transactionId. - */ - transactionId?: string; - /** - * ID of the user who modified the object. - */ - userProfileId?: string; - /** - * User profile name of the user who modified the object. - */ - userProfileName?: string; - } - /** - * Change Log List Response - */ - export interface Schema$ChangeLogsListResponse { - /** - * Change log collection. - */ - changeLogs?: Schema$ChangeLog[]; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#changeLogsListResponse". - */ - kind?: string; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string; - } - /** - * City List Response - */ - export interface Schema$CitiesListResponse { - /** - * City collection. - */ - cities?: Schema$City[]; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#citiesListResponse". - */ - kind?: string; - } - /** - * Contains information about a city that can be targeted by ads. - */ - export interface Schema$City { - /** - * Country code of the country to which this city belongs. - */ - countryCode?: string; - /** - * DART ID of the country to which this city belongs. - */ - countryDartId?: string; - /** - * DART ID of this city. This is the ID used for targeting and generating - * reports. - */ - dartId?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#city". - */ - kind?: string; - /** - * Metro region code of the metro region (DMA) to which this city belongs. - */ - metroCode?: string; - /** - * ID of the metro region (DMA) to which this city belongs. - */ - metroDmaId?: string; - /** - * Name of this city. - */ - name?: string; - /** - * Region code of the region to which this city belongs. - */ - regionCode?: string; - /** - * DART ID of the region to which this city belongs. - */ - regionDartId?: string; - } - /** - * Creative Click Tag. - */ - export interface Schema$ClickTag { - /** - * Advertiser event name associated with the click tag. This field is used - * by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to - * DISPLAY when the primary asset type is not HTML_IMAGE. - */ - eventName?: string; - /** - * Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY - * creative assets, this field must match the value of the creative - * asset's creativeAssetId.name field. - */ - name?: string; - /** - * Parameter value for the specified click tag. This field contains a - * click-through url. - */ - value?: string; - } - /** - * Click-through URL - */ - export interface Schema$ClickThroughUrl { - /** - * Read-only convenience field representing the actual URL that will be used - * for this click-through. The URL is computed as follows: - If - * defaultLandingPage is enabled then the campaign's default landing - * page URL is assigned to this field. - If defaultLandingPage is not - * enabled and a landingPageId is specified then that landing page's URL - * is assigned to this field. - If neither of the above cases apply, then - * the customClickThroughUrl is assigned to this field. - */ - computedClickThroughUrl?: string; - /** - * Custom click-through URL. Applicable if the defaultLandingPage field is - * set to false and the landingPageId field is left unset. - */ - customClickThroughUrl?: string; - /** - * Whether the campaign default landing page is used. - */ - defaultLandingPage?: boolean; - /** - * ID of the landing page for the click-through URL. Applicable if the - * defaultLandingPage field is set to false. - */ - landingPageId?: string; - } - /** - * Click Through URL Suffix settings. - */ - export interface Schema$ClickThroughUrlSuffixProperties { - /** - * Click-through URL suffix to apply to all ads in this entity's scope. - * Must be less than 128 characters long. - */ - clickThroughUrlSuffix?: string; - /** - * Whether this entity should override the inherited click-through URL - * suffix with its own defined value. - */ - overrideInheritedSuffix?: boolean; - } - /** - * Companion Click-through override. - */ - export interface Schema$CompanionClickThroughOverride { - /** - * Click-through URL of this companion click-through override. - */ - clickThroughUrl?: Schema$ClickThroughUrl; - /** - * ID of the creative for this companion click-through override. - */ - creativeId?: string; - } - /** - * Companion Settings - */ - export interface Schema$CompanionSetting { - /** - * Whether companions are disabled for this placement. - */ - companionsDisabled?: boolean; - /** - * Whitelist of companion sizes to be served to this placement. Set this - * list to null or empty to serve all companion sizes. - */ - enabledSizes?: Schema$Size[]; - /** - * Whether to serve only static images as companions. - */ - imageOnly?: boolean; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#companionSetting". - */ - kind?: string; - } - /** - * Represents a response to the queryCompatibleFields method. - */ - export interface Schema$CompatibleFields { - /** - * Contains items that are compatible to be selected for a report of type - * "CROSS_DIMENSION_REACH". - */ - crossDimensionReachReportCompatibleFields?: - Schema$CrossDimensionReachReportCompatibleFields; - /** - * Contains items that are compatible to be selected for a report of type - * "FLOODLIGHT". - */ - floodlightReportCompatibleFields?: Schema$FloodlightReportCompatibleFields; - /** - * The kind of resource this is, in this case dfareporting#compatibleFields. - */ - kind?: string; - /** - * Contains items that are compatible to be selected for a report of type - * "PATH_TO_CONVERSION". - */ - pathToConversionReportCompatibleFields?: - Schema$PathToConversionReportCompatibleFields; - /** - * Contains items that are compatible to be selected for a report of type - * "REACH". - */ - reachReportCompatibleFields?: Schema$ReachReportCompatibleFields; - /** - * Contains items that are compatible to be selected for a report of type - * "STANDARD". - */ - reportCompatibleFields?: Schema$ReportCompatibleFields; - } - /** - * Contains information about an internet connection type that can be targeted - * by ads. Clients can use the connection type to target mobile vs. broadband - * users. - */ - export interface Schema$ConnectionType { - /** - * ID of this connection type. - */ - id?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#connectionType". - */ - kind?: string; - /** - * Name of this connection type. - */ - name?: string; - } - /** - * Connection Type List Response - */ - export interface Schema$ConnectionTypesListResponse { - /** - * Collection of connection types such as broadband and mobile. - */ - connectionTypes?: Schema$ConnectionType[]; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#connectionTypesListResponse". - */ - kind?: string; - } - /** - * Content Category List Response - */ - export interface Schema$ContentCategoriesListResponse { - /** - * Content category collection. - */ - contentCategories?: Schema$ContentCategory[]; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#contentCategoriesListResponse". - */ - kind?: string; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string; - } - /** - * Organizes placements according to the contents of their associated - * webpages. - */ - export interface Schema$ContentCategory { - /** - * Account ID of this content category. This is a read-only field that can - * be left blank. - */ - accountId?: string; - /** - * ID of this content category. This is a read-only, auto-generated field. - */ - id?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#contentCategory". - */ - kind?: string; - /** - * Name of this content category. This is a required field and must be less - * than 256 characters long and unique among content categories of the same - * account. - */ - name?: string; - } - /** - * A Conversion represents when a user successfully performs a desired action - * after seeing an ad. - */ - export interface Schema$Conversion { - /** - * Whether the conversion was directed toward children. - */ - childDirectedTreatment?: boolean; - /** - * Custom floodlight variables. - */ - customVariables?: Schema$CustomFloodlightVariable[]; - /** - * The alphanumeric encrypted user ID. When set, encryptionInfo should also - * be specified. This field is mutually exclusive with - * encryptedUserIdCandidates[], mobileDeviceId and gclid. This or - * encryptedUserIdCandidates[] or mobileDeviceId or gclid is a required - * field. - */ - encryptedUserId?: string; - /** - * A list of the alphanumeric encrypted user IDs. Any user ID with exposure - * prior to the conversion timestamp will be used in the inserted - * conversion. If no such user ID is found then the conversion will be - * rejected with NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo - * should also be specified. This field may only be used when calling - * batchinsert; it is not supported by batchupdate. This field is mutually - * exclusive with encryptedUserId, mobileDeviceId and gclid. This or - * encryptedUserId or mobileDeviceId or gclid is a required field. - */ - encryptedUserIdCandidates?: string[]; - /** - * Floodlight Activity ID of this conversion. This is a required field. - */ - floodlightActivityId?: string; - /** - * Floodlight Configuration ID of this conversion. This is a required field. - */ - floodlightConfigurationId?: string; - /** - * The Google click ID. This field is mutually exclusive with - * encryptedUserId, encryptedUserIdCandidates[] and mobileDeviceId. This or - * encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId is a - * required field. - */ - gclid?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#conversion". - */ - kind?: string; - /** - * Whether Limit Ad Tracking is enabled. When set to true, the conversion - * will be used for reporting but not targeting. This will prevent - * remarketing. - */ - limitAdTracking?: boolean; - /** - * The mobile device ID. This field is mutually exclusive with - * encryptedUserId, encryptedUserIdCandidates[] and gclid. This or - * encryptedUserId or encryptedUserIdCandidates[] or gclid is a required - * field. - */ - mobileDeviceId?: string; - /** - * The ordinal of the conversion. Use this field to control how conversions - * of the same user and day are de-duplicated. This is a required field. - */ - ordinal?: string; - /** - * The quantity of the conversion. - */ - quantity?: string; - /** - * The timestamp of conversion, in Unix epoch micros. This is a required - * field. - */ - timestampMicros?: string; - /** - * The value of the conversion. - */ - value?: number; - } - /** - * The error code and description for a conversion that failed to insert or - * update. - */ - export interface Schema$ConversionError { - /** - * The error code. - */ - code?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#conversionError". - */ - kind?: string; - /** - * A description of the error. - */ - message?: string; - } - /** - * Insert Conversions Request. - */ - export interface Schema$ConversionsBatchInsertRequest { - /** - * The set of conversions to insert. - */ - conversions?: Schema$Conversion[]; - /** - * Describes how encryptedUserId or encryptedUserIdCandidates[] is - * encrypted. This is a required field if encryptedUserId or - * encryptedUserIdCandidates[] is used. - */ - encryptionInfo?: Schema$EncryptionInfo; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#conversionsBatchInsertRequest". - */ - kind?: string; - } - /** - * Insert Conversions Response. - */ - export interface Schema$ConversionsBatchInsertResponse { - /** - * Indicates that some or all conversions failed to insert. - */ - hasFailures?: boolean; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#conversionsBatchInsertResponse". - */ - kind?: string; - /** - * The insert status of each conversion. Statuses are returned in the same - * order that conversions are inserted. - */ - status?: Schema$ConversionStatus[]; - } - /** - * Update Conversions Request. - */ - export interface Schema$ConversionsBatchUpdateRequest { - /** - * The set of conversions to update. - */ - conversions?: Schema$Conversion[]; - /** - * Describes how encryptedUserId is encrypted. This is a required field if - * encryptedUserId is used. - */ - encryptionInfo?: Schema$EncryptionInfo; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#conversionsBatchUpdateRequest". - */ - kind?: string; - } - /** - * Update Conversions Response. - */ - export interface Schema$ConversionsBatchUpdateResponse { - /** - * Indicates that some or all conversions failed to update. - */ - hasFailures?: boolean; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#conversionsBatchUpdateResponse". - */ - kind?: string; - /** - * The update status of each conversion. Statuses are returned in the same - * order that conversions are updated. - */ - status?: Schema$ConversionStatus[]; - } - /** - * The original conversion that was inserted or updated and whether there were - * any errors. - */ - export interface Schema$ConversionStatus { - /** - * The original conversion that was inserted or updated. - */ - conversion?: Schema$Conversion; - /** - * A list of errors related to this conversion. - */ - errors?: Schema$ConversionError[]; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#conversionStatus". - */ - kind?: string; - } - /** - * Country List Response - */ - export interface Schema$CountriesListResponse { - /** - * Country collection. - */ - countries?: Schema$Country[]; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#countriesListResponse". - */ - kind?: string; - } - /** - * Contains information about a country that can be targeted by ads. - */ - export interface Schema$Country { - /** - * Country code. - */ - countryCode?: string; - /** - * DART ID of this country. This is the ID used for targeting and generating - * reports. - */ - dartId?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#country". - */ - kind?: string; - /** - * Name of this country. - */ - name?: string; - /** - * Whether ad serving supports secure servers in this country. - */ - sslEnabled?: boolean; - } - /** - * Contains properties of a Creative. - */ - export interface Schema$Creative { - /** - * Account ID of this creative. This field, if left unset, will be - * auto-generated for both insert and update operations. Applicable to all - * creative types. - */ - accountId?: string; - /** - * Whether the creative is active. Applicable to all creative types. - */ - active?: boolean; - /** - * Ad parameters user for VPAID creative. This is a read-only field. - * Applicable to the following creative types: all VPAID. - */ - adParameters?: string; - /** - * Keywords for a Rich Media creative. Keywords let you customize the - * creative settings of a Rich Media ad running on your site without having - * to contact the advertiser. You can use keywords to dynamically change the - * look or functionality of a creative. Applicable to the following creative - * types: all RICH_MEDIA, and all VPAID. - */ - adTagKeys?: string[]; - /** - * Advertiser ID of this creative. This is a required field. Applicable to - * all creative types. - */ - advertiserId?: string; - /** - * Whether script access is allowed for this creative. This is a read-only - * and deprecated field which will automatically be set to true on update. - * Applicable to the following creative types: FLASH_INPAGE. - */ - allowScriptAccess?: boolean; - /** - * Whether the creative is archived. Applicable to all creative types. - */ - archived?: boolean; - /** - * Type of artwork used for the creative. This is a read-only field. - * Applicable to the following creative types: all RICH_MEDIA, and all - * VPAID. - */ - artworkType?: string; - /** - * Source application where creative was authored. Presently, only DBM - * authored creatives will have this field set. Applicable to all creative - * types. - */ - authoringSource?: string; - /** - * Authoring tool for HTML5 banner creatives. This is a read-only field. - * Applicable to the following creative types: HTML5_BANNER. - */ - authoringTool?: string; - /** - * Whether images are automatically advanced for image gallery creatives. - * Applicable to the following creative types: DISPLAY_IMAGE_GALLERY. - */ - autoAdvanceImages?: boolean; - /** - * The 6-character HTML color code, beginning with #, for the background of - * the window area where the Flash file is displayed. Default is white. - * Applicable to the following creative types: FLASH_INPAGE. - */ - backgroundColor?: string; - /** - * Click-through URL for backup image. Applicable to the following creative - * types: FLASH_INPAGE, and HTML5_BANNER. Applicable to DISPLAY when the - * primary asset type is not HTML_IMAGE. - */ - backupImageClickThroughUrl?: string; - /** - * List of feature dependencies that will cause a backup image to be served - * if the browser that serves the ad does not support them. Feature - * dependencies are features that a browser must be able to support in order - * to render your HTML5 creative asset correctly. This field is initially - * auto-generated to contain all features detected by Campaign Manager for - * all the assets of this creative and can then be modified by the client. - * To reset this field, copy over all the creativeAssets' detected - * features. Applicable to the following creative types: HTML5_BANNER. - * Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - */ - backupImageFeatures?: string[]; - /** - * Reporting label used for HTML5 banner backup image. Applicable to the - * following creative types: DISPLAY when the primary asset type is not - * HTML_IMAGE. - */ - backupImageReportingLabel?: string; - /** - * Target window for backup image. Applicable to the following creative - * types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the - * primary asset type is not HTML_IMAGE. - */ - backupImageTargetWindow?: Schema$TargetWindow; - /** - * Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER - * creatives, this is a subset of detected click tags for the assets - * associated with this creative. After creating a flash asset, detected - * click tags will be returned in the creativeAssetMetadata. When inserting - * the creative, populate the creative clickTags field using the - * creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY - * creatives, there should be exactly one entry in this list for each image - * creative asset. A click tag is matched with a corresponding creative - * asset by matching the clickTag.name field with the - * creativeAsset.assetIdentifier.name field. Applicable to the following - * creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. - * Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - */ - clickTags?: Schema$ClickTag[]; - /** - * Industry standard ID assigned to creative for reach and frequency. - * Applicable to INSTREAM_VIDEO_REDIRECT creatives. - */ - commercialId?: string; - /** - * List of companion creatives assigned to an in-Stream video creative. - * Acceptable values include IDs of existing flash and image creatives. - * Applicable to the following creative types: all VPAID and all - * INSTREAM_VIDEO with dynamicAssetSelection set to false. - */ - companionCreatives?: string[]; - /** - * Compatibilities associated with this creative. This is a read-only field. - * DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or - * on mobile devices or in mobile apps for regular or interstitial ads, - * respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. - * Only pre-existing creatives may have these compatibilities since new - * creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL - * instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads - * developed with the VAST standard. Applicable to all creative types. - * Acceptable values are: - "APP" - "APP_INTERSTITIAL" - - * "IN_STREAM_VIDEO" - "DISPLAY" - - * "DISPLAY_INTERSTITIAL" - */ - compatibility?: string[]; - /** - * Whether Flash assets associated with the creative need to be - * automatically converted to HTML5. This flag is enabled by default and - * users can choose to disable it if they don't want the system to - * generate and use HTML5 asset for this creative. Applicable to the - * following creative type: FLASH_INPAGE. Applicable to DISPLAY when the - * primary asset type is not HTML_IMAGE. - */ - convertFlashToHtml5?: boolean; - /** - * List of counter events configured for the creative. For - * DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated - * from clickTags. Applicable to the following creative types: - * DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. - */ - counterCustomEvents?: Schema$CreativeCustomEvent[]; - /** - * Assets associated with a creative. Applicable to all but the following - * creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and - * REDIRECT - */ - creativeAssets?: Schema$CreativeAsset[]; - /** - * Required if dynamicAssetSelection is true. - */ - creativeAssetSelection?: Schema$CreativeAssetSelection; - /** - * Creative field assignments for this creative. Applicable to all creative - * types. - */ - creativeFieldAssignments?: Schema$CreativeFieldAssignment[]; - /** - * Custom key-values for a Rich Media creative. Key-values let you customize - * the creative settings of a Rich Media ad running on your site without - * having to contact the advertiser. You can use key-values to dynamically - * change the look or functionality of a creative. Applicable to the - * following creative types: all RICH_MEDIA, and all VPAID. - */ - customKeyValues?: string[]; - /** - * Set this to true to enable the use of rules to target individual assets - * in this creative. When set to true creativeAssetSelection must be set. - * This also controls asset-level companions. When this is true, companion - * creatives should be assigned to creative assets. Learn more. Applicable - * to INSTREAM_VIDEO creatives. - */ - dynamicAssetSelection?: boolean; - /** - * List of exit events configured for the creative. For DISPLAY and - * DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated - * from clickTags, For DISPLAY, an event is also created from the - * backupImageReportingLabel. Applicable to the following creative types: - * DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to - * DISPLAY when the primary asset type is not HTML_IMAGE. - */ - exitCustomEvents?: Schema$CreativeCustomEvent[]; - /** - * OpenWindow FSCommand of this creative. This lets the SWF file communicate - * with either Flash Player or the program hosting Flash Player, such as a - * web browser. This is only triggered if allowScriptAccess field is true. - * Applicable to the following creative types: FLASH_INPAGE. - */ - fsCommand?: Schema$FsCommand; - /** - * HTML code for the creative. This is a required field when applicable. - * This field is ignored if htmlCodeLocked is true. Applicable to the - * following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and - * all RICH_MEDIA. - */ - htmlCode?: string; - /** - * Whether HTML code is generated by Campaign Manager or manually entered. - * Set to true to ignore changes to htmlCode. Applicable to the following - * creative types: FLASH_INPAGE and HTML5_BANNER. - */ - htmlCodeLocked?: boolean; - /** - * ID of this creative. This is a read-only, auto-generated field. - * Applicable to all creative types. - */ - id?: string; - /** - * Dimension value for the ID of this creative. This is a read-only field. - * Applicable to all creative types. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creative". - */ - kind?: string; - /** - * Creative last modification information. This is a read-only field. - * Applicable to all creative types. - */ - lastModifiedInfo?: Schema$LastModifiedInfo; - /** - * Latest Studio trafficked creative ID associated with rich media and VPAID - * creatives. This is a read-only field. Applicable to the following - * creative types: all RICH_MEDIA, and all VPAID. - */ - latestTraffickedCreativeId?: string; - /** - * Name of the creative. This is a required field and must be less than 256 - * characters long. Applicable to all creative types. - */ - name?: string; - /** - * Override CSS value for rich media creatives. Applicable to the following - * creative types: all RICH_MEDIA. - */ - overrideCss?: string; - /** - * Amount of time to play the video before counting a view. Applicable to - * the following creative types: all INSTREAM_VIDEO. - */ - progressOffset?: Schema$VideoOffset; - /** - * URL of hosted image or hosted video or another ad tag. For - * INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect - * URL. The standard for a VAST (Video Ad Serving Template) ad response - * allows for a redirect link to another VAST 2.0 or 3.0 call. This is a - * required field when applicable. Applicable to the following creative - * types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, - * INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT - */ - redirectUrl?: string; - /** - * ID of current rendering version. This is a read-only field. Applicable to - * all creative types. - */ - renderingId?: string; - /** - * Dimension value for the rendering ID of this creative. This is a - * read-only field. Applicable to all creative types. - */ - renderingIdDimensionValue?: Schema$DimensionValue; - /** - * The minimum required Flash plugin version for this creative. For - * example, 11.2.202.235. This is a read-only field. Applicable to the - * following creative types: all RICH_MEDIA, and all VPAID. - */ - requiredFlashPluginVersion?: string; - /** - * The internal Flash version for this creative as calculated by Studio. - * This is a read-only field. Applicable to the following creative types: - * FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when - * the primary asset type is not HTML_IMAGE. - */ - requiredFlashVersion?: number; - /** - * Size associated with this creative. When inserting or updating a creative - * either the size ID field or size width and height fields can be used. - * This is a required field when applicable; however for IMAGE, FLASH_INPAGE - * creatives, and for DISPLAY creatives with a primary asset of type - * HTML_IMAGE, if left blank, this field will be automatically set using the - * actual size of the associated image assets. Applicable to the following - * creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, - * HTML5_BANNER, IMAGE, and all RICH_MEDIA. - */ - size?: Schema$Size; - /** - * Amount of time to play the video before the skip button appears. - * Applicable to the following creative types: all INSTREAM_VIDEO. - */ - skipOffset?: Schema$VideoOffset; - /** - * Whether the user can choose to skip the creative. Applicable to the - * following creative types: all INSTREAM_VIDEO and all VPAID. - */ - skippable?: boolean; - /** - * Whether the creative is SSL-compliant. This is a read-only field. - * Applicable to all creative types. - */ - sslCompliant?: boolean; - /** - * Whether creative should be treated as SSL compliant even if the system - * scan shows it's not. Applicable to all creative types. - */ - sslOverride?: boolean; - /** - * Studio advertiser ID associated with rich media and VPAID creatives. This - * is a read-only field. Applicable to the following creative types: all - * RICH_MEDIA, and all VPAID. - */ - studioAdvertiserId?: string; - /** - * Studio creative ID associated with rich media and VPAID creatives. This - * is a read-only field. Applicable to the following creative types: all - * RICH_MEDIA, and all VPAID. - */ - studioCreativeId?: string; - /** - * Studio trafficked creative ID associated with rich media and VPAID - * creatives. This is a read-only field. Applicable to the following - * creative types: all RICH_MEDIA, and all VPAID. - */ - studioTraffickedCreativeId?: string; - /** - * Subaccount ID of this creative. This field, if left unset, will be - * auto-generated for both insert and update operations. Applicable to all - * creative types. - */ - subaccountId?: string; - /** - * Third-party URL used to record backup image impressions. Applicable to - * the following creative types: all RICH_MEDIA. - */ - thirdPartyBackupImageImpressionsUrl?: string; - /** - * Third-party URL used to record rich media impressions. Applicable to the - * following creative types: all RICH_MEDIA. - */ - thirdPartyRichMediaImpressionsUrl?: string; - /** - * Third-party URLs for tracking in-stream video creative events. Applicable - * to the following creative types: all INSTREAM_VIDEO and all VPAID. - */ - thirdPartyUrls?: Schema$ThirdPartyTrackingUrl[]; - /** - * List of timer events configured for the creative. For - * DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated - * from clickTags. Applicable to the following creative types: - * DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to - * DISPLAY when the primary asset is not HTML_IMAGE. - */ - timerCustomEvents?: Schema$CreativeCustomEvent[]; - /** - * Combined size of all creative assets. This is a read-only field. - * Applicable to the following creative types: all RICH_MEDIA, and all - * VPAID. - */ - totalFileSize?: string; - /** - * Type of this creative. This is a required field. Applicable to all - * creative types. Note: FLASH_INPAGE, HTML5_BANNER, and IMAGE are only - * used for existing creatives. New creatives should use DISPLAY as a - * replacement for these types. - */ - type?: string; - /** - * A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following - * creative types: INSTREAM_VIDEO and VPAID. - */ - universalAdId?: Schema$UniversalAdId; - /** - * The version number helps you keep track of multiple versions of your - * creative in your reports. The version number will always be - * auto-generated during insert operations to start at 1. For tracking - * creatives the version cannot be incremented and will always remain at 1. - * For all other creative types the version can be incremented only by 1 - * during update operations. In addition, the version will be automatically - * incremented by 1 when undergoing Rich Media creative merging. Applicable - * to all creative types. - */ - version?: number; - /** - * Description of the video ad. Applicable to the following creative types: - * all INSTREAM_VIDEO and all VPAID. - */ - videoDescription?: string; - /** - * Creative video duration in seconds. This is a read-only field. Applicable - * to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all - * VPAID. - */ - videoDuration?: number; - } - /** - * Creative Asset. - */ - export interface Schema$CreativeAsset { - /** - * Whether ActionScript3 is enabled for the flash asset. This is a read-only - * field. Applicable to the following creative type: FLASH_INPAGE. - * Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - */ - actionScript3?: boolean; - /** - * Whether the video asset is active. This is a read-only field for - * VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative - * types: INSTREAM_VIDEO and all VPAID. - */ - active?: boolean; - /** - * Possible alignments for an asset. This is a read-only field. Applicable - * to the following creative types: - * RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL. - */ - alignment?: string; - /** - * Artwork type of rich media creative. This is a read-only field. - * Applicable to the following creative types: all RICH_MEDIA. - */ - artworkType?: string; - /** - * Identifier of this asset. This is the same identifier returned during - * creative asset insert operation. This is a required field. Applicable to - * all but the following creative types: all REDIRECT and TRACKING_TEXT. - */ - assetIdentifier?: Schema$CreativeAssetId; - /** - * Exit event configured for the backup image. Applicable to the following - * creative types: all RICH_MEDIA. - */ - backupImageExit?: Schema$CreativeCustomEvent; - /** - * Detected bit-rate for video asset. This is a read-only field. Applicable - * to the following creative types: INSTREAM_VIDEO and all VPAID. - */ - bitRate?: number; - /** - * Rich media child asset type. This is a read-only field. Applicable to the - * following creative types: all VPAID. - */ - childAssetType?: string; - /** - * Size of an asset when collapsed. This is a read-only field. Applicable to - * the following creative types: all RICH_MEDIA and all VPAID. Additionally, - * applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or - * ASSET_DISPLAY_TYPE_PEEL_DOWN. - */ - collapsedSize?: Schema$Size; - /** - * List of companion creatives assigned to an in-stream video creative - * asset. Acceptable values include IDs of existing flash and image - * creatives. Applicable to INSTREAM_VIDEO creative type with - * dynamicAssetSelection set to true. - */ - companionCreativeIds?: string[]; - /** - * Custom start time in seconds for making the asset visible. Applicable to - * the following creative types: all RICH_MEDIA. Value must be greater than - * or equal to 0. - */ - customStartTimeValue?: number; - /** - * List of feature dependencies for the creative asset that are detected by - * Campaign Manager. Feature dependencies are features that a browser must - * be able to support in order to render your HTML5 creative correctly. This - * is a read-only, auto-generated field. Applicable to the following - * creative types: HTML5_BANNER. Applicable to DISPLAY when the primary - * asset type is not HTML_IMAGE. - */ - detectedFeatures?: string[]; - /** - * Type of rich media asset. This is a read-only field. Applicable to the - * following creative types: all RICH_MEDIA. - */ - displayType?: string; - /** - * Duration in seconds for which an asset will be displayed. Applicable to - * the following creative types: INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. - * Value must be greater than or equal to 1. - */ - duration?: number; - /** - * Duration type for which an asset will be displayed. Applicable to the - * following creative types: all RICH_MEDIA. - */ - durationType?: string; - /** - * Detected expanded dimension for video asset. This is a read-only field. - * Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. - */ - expandedDimension?: Schema$Size; - /** - * File size associated with this creative asset. This is a read-only field. - * Applicable to all but the following creative types: all REDIRECT and - * TRACKING_TEXT. - */ - fileSize?: string; - /** - * Flash version of the asset. This is a read-only field. Applicable to the - * following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. - * Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - */ - flashVersion?: number; - /** - * Whether to hide Flash objects flag for an asset. Applicable to the - * following creative types: all RICH_MEDIA. - */ - hideFlashObjects?: boolean; - /** - * Whether to hide selection boxes flag for an asset. Applicable to the - * following creative types: all RICH_MEDIA. - */ - hideSelectionBoxes?: boolean; - /** - * Whether the asset is horizontally locked. This is a read-only field. - * Applicable to the following creative types: all RICH_MEDIA. - */ - horizontallyLocked?: boolean; - /** - * Numeric ID of this creative asset. This is a required field and should - * not be modified. Applicable to all but the following creative types: all - * REDIRECT and TRACKING_TEXT. - */ - id?: string; - /** - * Dimension value for the ID of the asset. This is a read-only, - * auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Detected MIME type for video asset. This is a read-only field. Applicable - * to the following creative types: INSTREAM_VIDEO and all VPAID. - */ - mimeType?: string; - /** - * Offset position for an asset in collapsed mode. This is a read-only - * field. Applicable to the following creative types: all RICH_MEDIA and all - * VPAID. Additionally, only applicable to assets whose displayType is - * ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN. - */ - offset?: Schema$OffsetPosition; - /** - * Whether the backup asset is original or changed by the user in Campaign - * Manager. Applicable to the following creative types: all RICH_MEDIA. - */ - originalBackup?: boolean; - /** - * Offset position for an asset. Applicable to the following creative types: - * all RICH_MEDIA. - */ - position?: Schema$OffsetPosition; - /** - * Offset left unit for an asset. This is a read-only field. Applicable to - * the following creative types: all RICH_MEDIA. - */ - positionLeftUnit?: string; - /** - * Offset top unit for an asset. This is a read-only field if the asset - * displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following - * creative types: all RICH_MEDIA. - */ - positionTopUnit?: string; - /** - * Progressive URL for video asset. This is a read-only field. Applicable to - * the following creative types: INSTREAM_VIDEO and all VPAID. - */ - progressiveServingUrl?: string; - /** - * Whether the asset pushes down other content. Applicable to the following - * creative types: all RICH_MEDIA. Additionally, only applicable when the - * asset offsets are 0, the collapsedSize.width matches size.width, and the - * collapsedSize.height is less than size.height. - */ - pushdown?: boolean; - /** - * Pushdown duration in seconds for an asset. Applicable to the following - * creative types: all RICH_MEDIA.Additionally, only applicable when the - * asset pushdown field is true, the offsets are 0, the collapsedSize.width - * matches size.width, and the collapsedSize.height is less than - * size.height. Acceptable values are 0 to 9.99, inclusive. - */ - pushdownDuration?: number; - /** - * Role of the asset in relation to creative. Applicable to all but the - * following creative types: all REDIRECT and TRACKING_TEXT. This is a - * required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, - * IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple - * primary assets), and all VPAID creatives. BACKUP_IMAGE applies to - * FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. - * Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - * ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. - * OTHER refers to assets from sources other than Campaign Manager, such as - * Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID - * creatives. PARENT_VIDEO refers to videos uploaded by the user in Campaign - * Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO - * creatives. TRANSCODED_VIDEO refers to videos transcoded by Campaign - * Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and - * VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the Campaign - * Manager representation of child asset videos from Studio, and is - * applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or - * removed within Campaign Manager. For VPAID_LINEAR_VIDEO creatives, - * PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked - * active serve as backup in case the VPAID creative cannot be served. Only - * PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or - * VPAID_LINEAR_VIDEO creative. - */ - role?: string; - /** - * Size associated with this creative asset. This is a required field when - * applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, - * this field will be automatically set using the actual size of the - * associated image asset. Applicable to the following creative types: - * DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all - * RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not - * HTML_IMAGE. - */ - size?: Schema$Size; - /** - * Whether the asset is SSL-compliant. This is a read-only field. Applicable - * to all but the following creative types: all REDIRECT and TRACKING_TEXT. - */ - sslCompliant?: boolean; - /** - * Initial wait time type before making the asset visible. Applicable to the - * following creative types: all RICH_MEDIA. - */ - startTimeType?: string; - /** - * Streaming URL for video asset. This is a read-only field. Applicable to - * the following creative types: INSTREAM_VIDEO and all VPAID. - */ - streamingServingUrl?: string; - /** - * Whether the asset is transparent. Applicable to the following creative - * types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets. - */ - transparency?: boolean; - /** - * Whether the asset is vertically locked. This is a read-only field. - * Applicable to the following creative types: all RICH_MEDIA. - */ - verticallyLocked?: boolean; - /** - * Detected video duration for video asset. This is a read-only field. - * Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. - */ - videoDuration?: number; - /** - * Window mode options for flash assets. Applicable to the following - * creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, - * RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and - * RICH_MEDIA_INPAGE_FLOATING. - */ - windowMode?: string; - /** - * zIndex value of an asset. Applicable to the following creative types: all - * RICH_MEDIA.Additionally, only applicable to assets whose displayType is - * NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or - * ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to - * 999999999, inclusive. - */ - zIndex?: number; - /** - * File name of zip file. This is a read-only field. Applicable to the - * following creative types: HTML5_BANNER. - */ - zipFilename?: string; - /** - * Size of zip file. This is a read-only field. Applicable to the following - * creative types: HTML5_BANNER. - */ - zipFilesize?: string; - } - /** - * Creative Asset ID. - */ - export interface Schema$CreativeAssetId { - /** - * Name of the creative asset. This is a required field while inserting an - * asset. After insertion, this assetIdentifier is used to identify the - * uploaded asset. Characters in the name must be alphanumeric or one of the - * following: ".-_ ". Spaces are allowed. - */ - name?: string; - /** - * Type of asset to upload. This is a required field. FLASH and IMAGE are no - * longer supported for new uploads. All image assets should use HTML_IMAGE. - */ - type?: string; - } - /** - * CreativeAssets contains properties of a creative asset file which will be - * uploaded or has already been uploaded. Refer to the creative sample code - * for how to upload assets and insert a creative. - */ - export interface Schema$CreativeAssetMetadata { - /** - * ID of the creative asset. This is a required field. - */ - assetIdentifier?: Schema$CreativeAssetId; - /** - * List of detected click tags for assets. This is a read-only - * auto-generated field. - */ - clickTags?: Schema$ClickTag[]; - /** - * List of feature dependencies for the creative asset that are detected by - * Campaign Manager. Feature dependencies are features that a browser must - * be able to support in order to render your HTML5 creative correctly. This - * is a read-only, auto-generated field. - */ - detectedFeatures?: string[]; - /** - * Numeric ID of the asset. This is a read-only, auto-generated field. - */ - id?: string; - /** - * Dimension value for the numeric ID of the asset. This is a read-only, - * auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creativeAssetMetadata". - */ - kind?: string; - /** - * Rules validated during code generation that generated a warning. This is - * a read-only, auto-generated field. Possible values are: - - * "ADMOB_REFERENCED" - "ASSET_FORMAT_UNSUPPORTED_DCM" - - * "ASSET_INVALID" - "CLICK_TAG_HARD_CODED" - - * "CLICK_TAG_INVALID" - "CLICK_TAG_IN_GWD" - - * "CLICK_TAG_MISSING" - "CLICK_TAG_MORE_THAN_ONE" - - * "CLICK_TAG_NON_TOP_LEVEL" - - * "COMPONENT_UNSUPPORTED_DCM" - - * "ENABLER_UNSUPPORTED_METHOD_DCM" - - * "EXTERNAL_FILE_REFERENCED" - "FILE_DETAIL_EMPTY" - - * "FILE_TYPE_INVALID" - "GWD_PROPERTIES_INVALID" - - * "HTML5_FEATURE_UNSUPPORTED" - "LINKED_FILE_NOT_FOUND" - * - "MAX_FLASH_VERSION_11" - "MRAID_REFERENCED" - - * "NOT_SSL_COMPLIANT" - "ORPHANED_ASSET" - - * "PRIMARY_HTML_MISSING" - "SVG_INVALID" - - * "ZIP_INVALID" - */ - warnedValidationRules?: string[]; - } - /** - * Encapsulates the list of rules for asset selection and a default asset in - * case none of the rules match. Applicable to INSTREAM_VIDEO creatives. - */ - export interface Schema$CreativeAssetSelection { - /** - * A creativeAssets[].id. This should refer to one of the parent assets in - * this creative, and will be served if none of the rules match. This is a - * required field. - */ - defaultAssetId?: string; - /** - * Rules determine which asset will be served to a viewer. Rules will be - * evaluated in the order in which they are stored in this list. This list - * must contain at least one rule. Applicable to INSTREAM_VIDEO creatives. - */ - rules?: Schema$Rule[]; - } - /** - * Creative Assignment. - */ - export interface Schema$CreativeAssignment { - /** - * Whether this creative assignment is active. When true, the creative will - * be included in the ad's rotation. - */ - active?: boolean; - /** - * Whether applicable event tags should fire when this creative assignment - * is rendered. If this value is unset when the ad is inserted or updated, - * it will default to true for all creative types EXCEPT for - * INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO. - */ - applyEventTags?: boolean; - /** - * Click-through URL of the creative assignment. - */ - clickThroughUrl?: Schema$ClickThroughUrl; - /** - * Companion creative overrides for this creative assignment. Applicable to - * video ads. - */ - companionCreativeOverrides?: Schema$CompanionClickThroughOverride[]; - /** - * Creative group assignments for this creative assignment. Only one - * assignment per creative group number is allowed for a maximum of two - * assignments. - */ - creativeGroupAssignments?: Schema$CreativeGroupAssignment[]; - /** - * ID of the creative to be assigned. This is a required field. - */ - creativeId?: string; - /** - * Dimension value for the ID of the creative. This is a read-only, - * auto-generated field. - */ - creativeIdDimensionValue?: Schema$DimensionValue; - /** - * Date and time that the assigned creative should stop serving. Must be - * later than the start time. - */ - endTime?: string; - /** - * Rich media exit overrides for this creative assignment. Applicable when - * the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE - * - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - - * RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - - * RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - - * RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR - */ - richMediaExitOverrides?: Schema$RichMediaExitOverride[]; - /** - * Sequence number of the creative assignment, applicable when the rotation - * type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to - * 65535, inclusive. - */ - sequence?: number; - /** - * Whether the creative to be assigned is SSL-compliant. This is a read-only - * field that is auto-generated when the ad is inserted or updated. - */ - sslCompliant?: boolean; - /** - * Date and time that the assigned creative should start serving. - */ - startTime?: string; - /** - * Weight of the creative assignment, applicable when the rotation type is - * CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1. - */ - weight?: number; - } - /** - * Creative Custom Event. - */ - export interface Schema$CreativeCustomEvent { - /** - * Unique ID of this event used by Reporting and Data Transfer. This is a - * read-only field. - */ - advertiserCustomEventId?: string; - /** - * User-entered name for the event. - */ - advertiserCustomEventName?: string; - /** - * Type of the event. This is a read-only field. - */ - advertiserCustomEventType?: string; - /** - * Artwork label column, used to link events in Campaign Manager back to - * events in Studio. This is a required field and should not be modified - * after insertion. - */ - artworkLabel?: string; - /** - * Artwork type used by the creative.This is a read-only field. - */ - artworkType?: string; - /** - * Exit URL of the event. This field is used only for exit events. - */ - exitUrl?: string; - /** - * ID of this event. This is a required field and should not be modified - * after insertion. - */ - id?: string; - /** - * Properties for rich media popup windows. This field is used only for exit - * events. - */ - popupWindowProperties?: Schema$PopupWindowProperties; - /** - * Target type used by the event. - */ - targetType?: string; - /** - * Video reporting ID, used to differentiate multiple videos in a single - * creative. This is a read-only field. - */ - videoReportingId?: string; - } - /** - * Contains properties of a creative field. - */ - export interface Schema$CreativeField { - /** - * Account ID of this creative field. This is a read-only field that can be - * left blank. - */ - accountId?: string; - /** - * Advertiser ID of this creative field. This is a required field on - * insertion. - */ - advertiserId?: string; - /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * ID of this creative field. This is a read-only, auto-generated field. - */ - id?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creativeField". - */ - kind?: string; - /** - * Name of this creative field. This is a required field and must be less - * than 256 characters long and unique among creative fields of the same - * advertiser. - */ - name?: string; - /** - * Subaccount ID of this creative field. This is a read-only field that can - * be left blank. - */ - subaccountId?: string; - } - /** - * Creative Field Assignment. - */ - export interface Schema$CreativeFieldAssignment { - /** - * ID of the creative field. - */ - creativeFieldId?: string; - /** - * ID of the creative field value. - */ - creativeFieldValueId?: string; - } - /** - * Creative Field List Response - */ - export interface Schema$CreativeFieldsListResponse { - /** - * Creative field collection. - */ - creativeFields?: Schema$CreativeField[]; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creativeFieldsListResponse". - */ - kind?: string; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string; - } - /** - * Contains properties of a creative field value. - */ - export interface Schema$CreativeFieldValue { - /** - * ID of this creative field value. This is a read-only, auto-generated - * field. - */ - id?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creativeFieldValue". - */ - kind?: string; - /** - * Value of this creative field value. It needs to be less than 256 - * characters in length and unique per creative field. - */ - value?: string; - } - /** - * Creative Field Value List Response - */ - export interface Schema$CreativeFieldValuesListResponse { - /** - * Creative field value collection. - */ - creativeFieldValues?: Schema$CreativeFieldValue[]; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creativeFieldValuesListResponse". - */ - kind?: string; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string; - } - /** - * Contains properties of a creative group. - */ - export interface Schema$CreativeGroup { - /** - * Account ID of this creative group. This is a read-only field that can be - * left blank. - */ - accountId?: string; - /** - * Advertiser ID of this creative group. This is a required field on - * insertion. - */ - advertiserId?: string; - /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Subgroup of the creative group. Assign your creative groups to a subgroup - * in order to filter or manage them more easily. This field is required on - * insertion and is read-only after insertion. Acceptable values are 1 to 2, - * inclusive. - */ - groupNumber?: number; - /** - * ID of this creative group. This is a read-only, auto-generated field. - */ - id?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creativeGroup". - */ - kind?: string; - /** - * Name of this creative group. This is a required field and must be less - * than 256 characters long and unique among creative groups of the same - * advertiser. - */ - name?: string; - /** - * Subaccount ID of this creative group. This is a read-only field that can - * be left blank. - */ - subaccountId?: string; - } - /** - * Creative Group Assignment. - */ - export interface Schema$CreativeGroupAssignment { - /** - * ID of the creative group to be assigned. - */ - creativeGroupId?: string; - /** - * Creative group number of the creative group assignment. - */ - creativeGroupNumber?: string; - } - /** - * Creative Group List Response - */ - export interface Schema$CreativeGroupsListResponse { - /** - * Creative group collection. - */ - creativeGroups?: Schema$CreativeGroup[]; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creativeGroupsListResponse". - */ - kind?: string; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string; - } - /** - * Creative optimization settings. - */ - export interface Schema$CreativeOptimizationConfiguration { - /** - * ID of this creative optimization config. This field is auto-generated - * when the campaign is inserted or updated. It can be null for existing - * campaigns. - */ - id?: string; - /** - * Name of this creative optimization config. This is a required field and - * must be less than 129 characters long. - */ - name?: string; - /** - * List of optimization activities associated with this configuration. - */ - optimizationActivitys?: Schema$OptimizationActivity[]; - /** - * Optimization model for this configuration. - */ - optimizationModel?: string; - } - /** - * Creative Rotation. - */ - export interface Schema$CreativeRotation { - /** - * Creative assignments in this creative rotation. - */ - creativeAssignments?: Schema$CreativeAssignment[]; - /** - * Creative optimization configuration that is used by this ad. It should - * refer to one of the existing optimization configurations in the ad's - * campaign. If it is unset or set to 0, then the campaign's default - * optimization configuration will be used for this ad. - */ - creativeOptimizationConfigurationId?: string; - /** - * Type of creative rotation. Can be used to specify whether to use - * sequential or random rotation. - */ - type?: string; - /** - * Strategy for calculating weights. Used with - * CREATIVE_ROTATION_TYPE_RANDOM. - */ - weightCalculationStrategy?: string; - } - /** - * Creative Settings - */ - export interface Schema$CreativeSettings { - /** - * Header text for iFrames for this site. Must be less than or equal to 2000 - * characters long. - */ - iFrameFooter?: string; - /** - * Header text for iFrames for this site. Must be less than or equal to 2000 - * characters long. - */ - iFrameHeader?: string; - } - /** - * Creative List Response - */ - export interface Schema$CreativesListResponse { - /** - * Creative collection. - */ - creatives?: Schema$Creative[]; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#creativesListResponse". - */ - kind?: string; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string; - } - /** - * Represents fields that are compatible to be selected for a report of type - * "CROSS_DIMENSION_REACH". - */ - export interface Schema$CrossDimensionReachReportCompatibleFields { - /** - * Dimensions which are compatible to be selected in the - * "breakdown" section of the report. - */ - breakdown?: Schema$Dimension[]; - /** - * Dimensions which are compatible to be selected in the - * "dimensionFilters" section of the report. - */ - dimensionFilters?: Schema$Dimension[]; - /** - * The kind of resource this is, in this case - * dfareporting#crossDimensionReachReportCompatibleFields. - */ - kind?: string; - /** - * Metrics which are compatible to be selected in the - * "metricNames" section of the report. - */ - metrics?: Schema$Metric[]; - /** - * Metrics which are compatible to be selected in the - * "overlapMetricNames" section of the report. - */ - overlapMetrics?: Schema$Metric[]; - } - /** - * A custom floodlight variable. - */ - export interface Schema$CustomFloodlightVariable { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#customFloodlightVariable". - */ - kind?: string; - /** - * The type of custom floodlight variable to supply a value for. These map - * to the "u[1-20]=" in the tags. - */ - type?: string; - /** - * The value of the custom floodlight variable. The length of string must - * not exceed 50 characters. - */ - value?: string; - } - /** - * Represents a Custom Rich Media Events group. - */ - export interface Schema$CustomRichMediaEvents { - /** - * List of custom rich media event IDs. Dimension values must be all of type - * dfa:richMediaEventTypeIdAndName. - */ - filteredEventIds?: Schema$DimensionValue[]; - /** - * The kind of resource this is, in this case - * dfareporting#customRichMediaEvents. - */ - kind?: string; - } - /** - * Represents a date range. - */ - export interface Schema$DateRange { - /** - * The end date of the date range, inclusive. A string of the format: - * "yyyy-MM-dd". - */ - endDate?: string; - /** - * The kind of resource this is, in this case dfareporting#dateRange. - */ - kind?: string; - /** - * The date range relative to the date of when the report is run. - */ - relativeDateRange?: string; - /** - * The start date of the date range, inclusive. A string of the format: - * "yyyy-MM-dd". - */ - startDate?: string; - } - /** - * Day Part Targeting. - */ - export interface Schema$DayPartTargeting { - /** - * Days of the week when the ad will serve. Acceptable values are: - - * "SUNDAY" - "MONDAY" - "TUESDAY" - - * "WEDNESDAY" - "THURSDAY" - "FRIDAY" - - * "SATURDAY" - */ - daysOfWeek?: string[]; - /** - * Hours of the day when the ad will serve, where 0 is midnight to 1 AM and - * 23 is 11 PM to midnight. Can be specified with days of week, in which - * case the ad would serve during these hours on the specified days. For - * example if Monday, Wednesday, Friday are the days of week specified and - * 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve - * Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values - * are 0 to 23, inclusive. - */ - hoursOfDay?: number[]; - /** - * Whether or not to use the user's local time. If false, the - * America/New York time zone applies. - */ - userLocalTime?: boolean; - } - /** - * Properties of inheriting and overriding the default click-through event - * tag. A campaign may override the event tag defined at the advertiser level, - * and an ad may also override the campaign's setting further. - */ - export interface Schema$DefaultClickThroughEventTagProperties { - /** - * ID of the click-through event tag to apply to all ads in this - * entity's scope. - */ - defaultClickThroughEventTagId?: string; - /** - * Whether this entity should override the inherited default click-through - * event tag with its own defined value. - */ - overrideInheritedEventTag?: boolean; - } - /** - * Delivery Schedule. - */ - export interface Schema$DeliverySchedule { - /** - * Limit on the number of times an individual user can be served the ad - * within a specified period of time. - */ - frequencyCap?: Schema$FrequencyCap; - /** - * Whether or not hard cutoff is enabled. If true, the ad will not serve - * after the end date and time. Otherwise the ad will continue to be served - * until it has reached its delivery goals. - */ - hardCutoff?: boolean; - /** - * Impression ratio for this ad. This ratio determines how often each ad is - * served relative to the others. For example, if ad A has an impression - * ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager - * will serve ad B three times as often as ad A. Acceptable values are 1 to - * 10, inclusive. - */ - impressionRatio?: string; - /** - * Serving priority of an ad, with respect to other ads. The lower the - * priority number, the greater the priority with which it is served. - */ - priority?: string; - } - /** - * Google Ad Manager Settings - */ - export interface Schema$DfpSettings { - /** - * Ad Manager network code for this directory site. - */ - dfpNetworkCode?: string; - /** - * Ad Manager network name for this directory site. - */ - dfpNetworkName?: string; - /** - * Whether this directory site accepts programmatic placements. - */ - programmaticPlacementAccepted?: boolean; - /** - * Whether this directory site is available only via Publisher Portal. - */ - publisherPortalOnly?: boolean; - /** - * Whether this directory site accepts publisher-paid tags. - */ - pubPaidPlacementAccepted?: boolean; - } - /** - * Represents a dimension. - */ - export interface Schema$Dimension { - /** - * The kind of resource this is, in this case dfareporting#dimension. - */ - kind?: string; - /** - * The dimension name, e.g. dfa:advertiser - */ - name?: string; - } - /** - * Represents a dimension filter. - */ - export interface Schema$DimensionFilter { - /** - * The name of the dimension to filter. - */ - dimensionName?: string; - /** - * The kind of resource this is, in this case dfareporting#dimensionFilter. - */ - kind?: string; - /** - * The value of the dimension to filter. - */ - value?: string; - } - /** - * Represents a DimensionValue resource. - */ - export interface Schema$DimensionValue { - /** - * The name of the dimension. - */ - dimensionName?: string; - /** - * The eTag of this response for caching purposes. - */ - etag?: string; - /** - * The ID associated with the value if available. - */ - id?: string; - /** - * The kind of resource this is, in this case dfareporting#dimensionValue. - */ - kind?: string; - /** - * Determines how the 'value' field is matched when filtering. If - * not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, - * '*' is allowed as a placeholder for variable length character - * sequences, and it can be escaped with a backslash. Note, only paid search - * dimensions ('dfa:paidSearch*') allow a matchType other than - * EXACT. - */ - matchType?: string; - /** - * The value of the dimension. - */ - value?: string; - } - /** - * Represents the list of DimensionValue resources. - */ - export interface Schema$DimensionValueList { - /** - * The eTag of this response for caching purposes. - */ - etag?: string; - /** - * The dimension values returned in this response. - */ - items?: Schema$DimensionValue[]; - /** - * The kind of list this is, in this case dfareporting#dimensionValueList. - */ - kind?: string; - /** - * Continuation token used to page through dimension values. To retrieve the - * next page of results, set the next request's "pageToken" to - * the value of this field. The page token is only valid for a limited - * amount of time and should not be persisted. - */ - nextPageToken?: string; - } - /** - * Represents a DimensionValuesRequest. - */ - export interface Schema$DimensionValueRequest { - /** - * The name of the dimension for which values should be requested. - */ - dimensionName?: string; - /** - * The end date of the date range for which to retrieve dimension values. A - * string of the format "yyyy-MM-dd". - */ - endDate?: string; - /** - * The list of filters by which to filter values. The filters are ANDed. - */ - filters?: Schema$DimensionFilter[]; - /** - * The kind of request this is, in this case - * dfareporting#dimensionValueRequest. - */ - kind?: string; - /** - * The start date of the date range for which to retrieve dimension values. - * A string of the format "yyyy-MM-dd". - */ - startDate?: string; - } - /** - * DirectorySites contains properties of a website from the Site Directory. - * Sites need to be added to an account via the Sites resource before they can - * be assigned to a placement. - */ - export interface Schema$DirectorySite { - /** - * Whether this directory site is active. - */ - active?: boolean; - /** - * Directory site contacts. - */ - contactAssignments?: Schema$DirectorySiteContactAssignment[]; - /** - * Country ID of this directory site. This is a read-only field. - */ - countryId?: string; - /** - * Currency ID of this directory site. This is a read-only field. Possible - * values are: - "1" for USD - "2" for GBP - - * "3" for ESP - "4" for SEK - "5" for CAD - * - "6" for JPY - "7" for DEM - "8" for AUD - * - "9" for FRF - "10" for ITL - "11" for - * DKK - "12" for NOK - "13" for FIM - "14" - * for ZAR - "15" for IEP - "16" for NLG - - * "17" for EUR - "18" for KRW - "19" for - * TWD - "20" for SGD - "21" for CNY - "22" - * for HKD - "23" for NZD - "24" for MYR - - * "25" for BRL - "26" for PTE - "27" for - * MXP - "28" for CLP - "29" for TRY - "30" - * for ARS - "31" for PEN - "32" for ILS - - * "33" for CHF - "34" for VEF - "35" for - * COP - "36" for GTQ - "37" for PLN - "39" - * for INR - "40" for THB - "41" for IDR - - * "42" for CZK - "43" for RON - "44" for - * HUF - "45" for RUB - "46" for AED - "47" - * for BGN - "48" for HRK - "49" for MXN - - * "50" for NGN - */ - currencyId?: string; - /** - * Description of this directory site. This is a read-only field. - */ - description?: string; - /** - * ID of this directory site. This is a read-only, auto-generated field. - */ - id?: string; - /** - * Dimension value for the ID of this directory site. This is a read-only, - * auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Tag types for regular placements. Acceptable values are: - - * "STANDARD" - "IFRAME_JAVASCRIPT_INPAGE" - - * "INTERNAL_REDIRECT_INPAGE" - "JAVASCRIPT_INPAGE" - */ - inpageTagFormats?: string[]; - /** - * Tag types for interstitial placements. Acceptable values are: - - * "IFRAME_JAVASCRIPT_INTERSTITIAL" - - * "INTERNAL_REDIRECT_INTERSTITIAL" - - * "JAVASCRIPT_INTERSTITIAL" - */ - interstitialTagFormats?: string[]; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#directorySite". - */ - kind?: string; - /** - * Name of this directory site. - */ - name?: string; - /** - * Parent directory site ID. - */ - parentId?: string; - /** - * Directory site settings. - */ - settings?: Schema$DirectorySiteSettings; - /** - * URL of this directory site. - */ - url?: string; - } - /** - * Contains properties of a Site Directory contact. - */ - export interface Schema$DirectorySiteContact { - /** - * Address of this directory site contact. - */ - address?: string; - /** - * Email address of this directory site contact. - */ - email?: string; - /** - * First name of this directory site contact. - */ - firstName?: string; - /** - * ID of this directory site contact. This is a read-only, auto-generated - * field. - */ - id?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#directorySiteContact". - */ - kind?: string; - /** - * Last name of this directory site contact. - */ - lastName?: string; - /** - * Phone number of this directory site contact. - */ - phone?: string; - /** - * Directory site contact role. - */ - role?: string; - /** - * Title or designation of this directory site contact. - */ - title?: string; - /** - * Directory site contact type. - */ - type?: string; - } - /** - * Directory Site Contact Assignment - */ - export interface Schema$DirectorySiteContactAssignment { - /** - * ID of this directory site contact. This is a read-only, auto-generated - * field. - */ - contactId?: string; - /** - * Visibility of this directory site contact assignment. When set to PUBLIC - * this contact assignment is visible to all account and agency users; when - * set to PRIVATE it is visible only to the site. - */ - visibility?: string; - } - /** - * Directory Site Contact List Response - */ - export interface Schema$DirectorySiteContactsListResponse { - /** - * Directory site contact collection - */ - directorySiteContacts?: Schema$DirectorySiteContact[]; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#directorySiteContactsListResponse". - */ - kind?: string; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string; - } - /** - * Directory Site Settings - */ - export interface Schema$DirectorySiteSettings { - /** - * Whether this directory site has disabled active view creatives. - */ - activeViewOptOut?: boolean; - /** - * Directory site Ad Manager settings. - */ - dfpSettings?: Schema$DfpSettings; - /** - * Whether this site accepts in-stream video ads. - */ - instreamVideoPlacementAccepted?: boolean; - /** - * Whether this site accepts interstitial ads. - */ - interstitialPlacementAccepted?: boolean; - /** - * Whether this directory site has disabled Nielsen OCR reach ratings. - */ - nielsenOcrOptOut?: boolean; - /** - * Whether this directory site has disabled generation of Verification ins - * tags. - */ - verificationTagOptOut?: boolean; - /** - * Whether this directory site has disabled active view for in-stream video - * creatives. This is a read-only field. - */ - videoActiveViewOptOut?: boolean; - } - /** - * Directory Site List Response - */ - export interface Schema$DirectorySitesListResponse { - /** - * Directory site collection. - */ - directorySites?: Schema$DirectorySite[]; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#directorySitesListResponse". - */ - kind?: string; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string; - } - /** - * Contains properties of a dynamic targeting key. Dynamic targeting keys are - * unique, user-friendly labels, created at the advertiser level in DCM, that - * can be assigned to ads, creatives, and placements and used for targeting - * with Studio dynamic creatives. Use these labels instead of numeric Campaign - * Manager IDs (such as placement IDs) to save time and avoid errors in your - * dynamic feeds. - */ - export interface Schema$DynamicTargetingKey { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#dynamicTargetingKey". - */ - kind?: string; - /** - * Name of this dynamic targeting key. This is a required field. Must be - * less than 256 characters long and cannot contain commas. All characters - * are converted to lowercase. - */ - name?: string; - /** - * ID of the object of this dynamic targeting key. This is a required field. - */ - objectId?: string; - /** - * Type of the object of this dynamic targeting key. This is a required - * field. - */ - objectType?: string; - } - /** - * Dynamic Targeting Key List Response - */ - export interface Schema$DynamicTargetingKeysListResponse { - /** - * Dynamic targeting key collection. - */ - dynamicTargetingKeys?: Schema$DynamicTargetingKey[]; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#dynamicTargetingKeysListResponse". - */ - kind?: string; - } - /** - * A description of how user IDs are encrypted. - */ - export interface Schema$EncryptionInfo { - /** - * The encryption entity ID. This should match the encryption configuration - * for ad serving or Data Transfer. - */ - encryptionEntityId?: string; - /** - * The encryption entity type. This should match the encryption - * configuration for ad serving or Data Transfer. - */ - encryptionEntityType?: string; - /** - * Describes whether the encrypted cookie was received from ad serving (the - * %m macro) or from Data Transfer. - */ - encryptionSource?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#encryptionInfo". - */ - kind?: string; - } - /** - * Contains properties of an event tag. - */ - export interface Schema$EventTag { - /** - * Account ID of this event tag. This is a read-only field that can be left - * blank. - */ - accountId?: string; - /** - * Advertiser ID of this event tag. This field or the campaignId field is - * required on insertion. - */ - advertiserId?: string; - /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Campaign ID of this event tag. This field or the advertiserId field is - * required on insertion. - */ - campaignId?: string; - /** - * Dimension value for the ID of the campaign. This is a read-only, - * auto-generated field. - */ - campaignIdDimensionValue?: Schema$DimensionValue; - /** - * Whether this event tag should be automatically enabled for all of the - * advertiser's campaigns and ads. - */ - enabledByDefault?: boolean; - /** - * Whether to remove this event tag from ads that are trafficked through - * Display & Video 360 to Ad Exchange. This may be useful if the event - * tag uses a pixel that is unapproved for Ad Exchange bids on one or more - * networks, such as the Google Display Network. - */ - excludeFromAdxRequests?: boolean; - /** - * ID of this event tag. This is a read-only, auto-generated field. - */ - id?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#eventTag". - */ - kind?: string; - /** - * Name of this event tag. This is a required field and must be less than - * 256 characters long. - */ - name?: string; - /** - * Site filter type for this event tag. If no type is specified then the - * event tag will be applied to all sites. - */ - siteFilterType?: string; - /** - * Filter list of site IDs associated with this event tag. The - * siteFilterType determines whether this is a whitelist or blacklist - * filter. - */ - siteIds?: string[]; - /** - * Whether this tag is SSL-compliant or not. This is a read-only field. - */ - sslCompliant?: boolean; - /** - * Status of this event tag. Must be ENABLED for this event tag to fire. - * This is a required field. - */ - status?: string; - /** - * Subaccount ID of this event tag. This is a read-only field that can be - * left blank. - */ - subaccountId?: string; - /** - * Event tag type. Can be used to specify whether to use a third-party - * pixel, a third-party JavaScript URL, or a third-party click-through URL - * for either impression or click tracking. This is a required field. - */ - type?: string; - /** - * Payload URL for this event tag. The URL on a click-through event tag - * should have a landing page URL appended to the end of it. This field is - * required on insertion. - */ - url?: string; - /** - * Number of times the landing page URL should be URL-escaped before being - * appended to the click-through event tag URL. Only applies to - * click-through event tags as specified by the event tag type. - */ - urlEscapeLevels?: number; - } - /** - * Event tag override information. - */ - export interface Schema$EventTagOverride { - /** - * Whether this override is enabled. - */ - enabled?: boolean; - /** - * ID of this event tag override. This is a read-only, auto-generated field. - */ - id?: string; - } - /** - * Event Tag List Response - */ - export interface Schema$EventTagsListResponse { - /** - * Event tag collection. - */ - eventTags?: Schema$EventTag[]; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#eventTagsListResponse". - */ - kind?: string; - } - /** - * Represents a File resource. A file contains the metadata for a report run. - * It shows the status of the run and holds the URLs to the generated report - * data if the run is finished and the status is "REPORT_AVAILABLE". - */ - export interface Schema$File { - /** - * The date range for which the file has report data. The date range will - * always be the absolute date range for which the report is run. - */ - dateRange?: Schema$DateRange; - /** - * The eTag of this response for caching purposes. - */ - etag?: string; - /** - * The filename of the file. - */ - fileName?: string; - /** - * The output format of the report. Only available once the file is - * available. - */ - format?: string; - /** - * The unique ID of this report file. - */ - id?: string; - /** - * The kind of resource this is, in this case dfareporting#file. - */ - kind?: string; - /** - * The timestamp in milliseconds since epoch when this file was last - * modified. - */ - lastModifiedTime?: string; - /** - * The ID of the report this file was generated from. - */ - reportId?: string; - /** - * The status of the report file. - */ - status?: string; - /** - * The URLs where the completed report file can be downloaded. - */ - urls?: any; - } - /** - * Represents the list of File resources. - */ - export interface Schema$FileList { - /** - * The eTag of this response for caching purposes. - */ - etag?: string; - /** - * The files returned in this response. - */ - items?: Schema$File[]; - /** - * The kind of list this is, in this case dfareporting#fileList. - */ - kind?: string; - /** - * Continuation token used to page through files. To retrieve the next page - * of results, set the next request's "pageToken" to the value - * of this field. The page token is only valid for a limited amount of time - * and should not be persisted. - */ - nextPageToken?: string; - } - /** - * Flight - */ - export interface Schema$Flight { - /** - * Inventory item flight end date. - */ - endDate?: string; - /** - * Rate or cost of this flight. - */ - rateOrCost?: string; - /** - * Inventory item flight start date. - */ - startDate?: string; - /** - * Units of this flight. - */ - units?: string; - } - /** - * Floodlight Activity GenerateTag Response - */ - export interface Schema$FloodlightActivitiesGenerateTagResponse { - /** - * Generated tag for this Floodlight activity. For global site tags, this is - * the event snippet. - */ - floodlightActivityTag?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#floodlightActivitiesGenerateTagResponse". - */ - kind?: string; - } - /** - * Floodlight Activity List Response - */ - export interface Schema$FloodlightActivitiesListResponse { - /** - * Floodlight activity collection. - */ - floodlightActivities?: Schema$FloodlightActivity[]; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#floodlightActivitiesListResponse". - */ - kind?: string; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string; - } - /** - * Contains properties of a Floodlight activity. - */ - export interface Schema$FloodlightActivity { - /** - * Account ID of this floodlight activity. This is a read-only field that - * can be left blank. - */ - accountId?: string; - /** - * Advertiser ID of this floodlight activity. If this field is left blank, - * the value will be copied over either from the activity group's - * advertiser or the existing activity's advertiser. - */ - advertiserId?: string; - /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Code type used for cache busting in the generated tag. Applicable only - * when floodlightActivityGroupType is COUNTER and countingMethod is - * STANDARD_COUNTING or UNIQUE_COUNTING. - */ - cacheBustingType?: string; - /** - * Counting method for conversions for this floodlight activity. This is a - * required field. - */ - countingMethod?: string; - /** - * Dynamic floodlight tags. - */ - defaultTags?: Schema$FloodlightActivityDynamicTag[]; - /** - * URL where this tag will be deployed. If specified, must be less than 256 - * characters long. - */ - expectedUrl?: string; - /** - * Floodlight activity group ID of this floodlight activity. This is a - * required field. - */ - floodlightActivityGroupId?: string; - /** - * Name of the associated floodlight activity group. This is a read-only - * field. - */ - floodlightActivityGroupName?: string; - /** - * Tag string of the associated floodlight activity group. This is a - * read-only field. - */ - floodlightActivityGroupTagString?: string; - /** - * Type of the associated floodlight activity group. This is a read-only - * field. - */ - floodlightActivityGroupType?: string; - /** - * Floodlight configuration ID of this floodlight activity. If this field is - * left blank, the value will be copied over either from the activity - * group's floodlight configuration or from the existing activity's - * floodlight configuration. - */ - floodlightConfigurationId?: string; - /** - * Dimension value for the ID of the floodlight configuration. This is a - * read-only, auto-generated field. - */ - floodlightConfigurationIdDimensionValue?: Schema$DimensionValue; - /** - * Whether this activity is archived. - */ - hidden?: boolean; - /** - * ID of this floodlight activity. This is a read-only, auto-generated - * field. - */ - id?: string; - /** - * Dimension value for the ID of this floodlight activity. This is a - * read-only, auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Whether the image tag is enabled for this activity. - */ - imageTagEnabled?: boolean; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#floodlightActivity". - */ - kind?: string; - /** - * Name of this floodlight activity. This is a required field. Must be less - * than 129 characters long and cannot contain quotes. - */ - name?: string; - /** - * General notes or implementation instructions for the tag. - */ - notes?: string; - /** - * Publisher dynamic floodlight tags. - */ - publisherTags?: Schema$FloodlightActivityPublisherDynamicTag[]; - /** - * Whether this tag should use SSL. - */ - secure?: boolean; - /** - * Whether the floodlight activity is SSL-compliant. This is a read-only - * field, its value detected by the system from the floodlight tags. - */ - sslCompliant?: boolean; - /** - * Whether this floodlight activity must be SSL-compliant. - */ - sslRequired?: boolean; - /** - * Subaccount ID of this floodlight activity. This is a read-only field that - * can be left blank. - */ - subaccountId?: string; - /** - * Tag format type for the floodlight activity. If left blank, the tag - * format will default to HTML. - */ - tagFormat?: string; - /** - * Value of the cat= parameter in the floodlight tag, which the ad servers - * use to identify the activity. This is optional: if empty, a new tag - * string will be generated for you. This string must be 1 to 8 characters - * long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag - * string must also be unique among activities of the same activity group. - * This field is read-only after insertion. - */ - tagString?: string; - /** - * List of the user-defined variables used by this conversion tag. These map - * to the "u[1-100]=" in the tags. Each of these can have a user - * defined type. Acceptable values are U1 to U100, inclusive. - */ - userDefinedVariableTypes?: string[]; - } - /** - * Dynamic Tag - */ - export interface Schema$FloodlightActivityDynamicTag { - /** - * ID of this dynamic tag. This is a read-only, auto-generated field. - */ - id?: string; - /** - * Name of this tag. - */ - name?: string; - /** - * Tag code. - */ - tag?: string; - } - /** - * Contains properties of a Floodlight activity group. - */ - export interface Schema$FloodlightActivityGroup { - /** - * Account ID of this floodlight activity group. This is a read-only field - * that can be left blank. - */ - accountId?: string; - /** - * Advertiser ID of this floodlight activity group. If this field is left - * blank, the value will be copied over either from the floodlight - * configuration's advertiser or from the existing activity group's - * advertiser. - */ - advertiserId?: string; - /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Floodlight configuration ID of this floodlight activity group. This is a - * required field. - */ - floodlightConfigurationId?: string; - /** - * Dimension value for the ID of the floodlight configuration. This is a - * read-only, auto-generated field. - */ - floodlightConfigurationIdDimensionValue?: Schema$DimensionValue; - /** - * ID of this floodlight activity group. This is a read-only, auto-generated - * field. - */ - id?: string; - /** - * Dimension value for the ID of this floodlight activity group. This is a - * read-only, auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#floodlightActivityGroup". - */ - kind?: string; - /** - * Name of this floodlight activity group. This is a required field. Must be - * less than 65 characters long and cannot contain quotes. - */ - name?: string; - /** - * Subaccount ID of this floodlight activity group. This is a read-only - * field that can be left blank. - */ - subaccountId?: string; - /** - * Value of the type= parameter in the floodlight tag, which the ad servers - * use to identify the activity group that the activity belongs to. This is - * optional: if empty, a new tag string will be generated for you. This - * string must be 1 to 8 characters long, with valid characters being - * [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among - * activity groups of the same floodlight configuration. This field is - * read-only after insertion. - */ - tagString?: string; - /** - * Type of the floodlight activity group. This is a required field that is - * read-only after insertion. - */ - type?: string; - } - /** - * Floodlight Activity Group List Response - */ - export interface Schema$FloodlightActivityGroupsListResponse { - /** - * Floodlight activity group collection. - */ - floodlightActivityGroups?: Schema$FloodlightActivityGroup[]; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#floodlightActivityGroupsListResponse". - */ - kind?: string; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string; - } - /** - * Publisher Dynamic Tag - */ - export interface Schema$FloodlightActivityPublisherDynamicTag { - /** - * Whether this tag is applicable only for click-throughs. - */ - clickThrough?: boolean; - /** - * Directory site ID of this dynamic tag. This is a write-only field that - * can be used as an alternative to the siteId field. When this resource is - * retrieved, only the siteId field will be populated. - */ - directorySiteId?: string; - /** - * Dynamic floodlight tag. - */ - dynamicTag?: Schema$FloodlightActivityDynamicTag; - /** - * Site ID of this dynamic tag. - */ - siteId?: string; - /** - * Dimension value for the ID of the site. This is a read-only, - * auto-generated field. - */ - siteIdDimensionValue?: Schema$DimensionValue; - /** - * Whether this tag is applicable only for view-throughs. - */ - viewThrough?: boolean; - } - /** - * Contains properties of a Floodlight configuration. - */ - export interface Schema$FloodlightConfiguration { - /** - * Account ID of this floodlight configuration. This is a read-only field - * that can be left blank. - */ - accountId?: string; - /** - * Advertiser ID of the parent advertiser of this floodlight configuration. - */ - advertiserId?: string; - /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Whether advertiser data is shared with Google Analytics. - */ - analyticsDataSharingEnabled?: boolean; - /** - * Whether the exposure-to-conversion report is enabled. This report shows - * detailed pathway information on up to 10 of the most recent ad exposures - * seen by a user before converting. - */ - exposureToConversionEnabled?: boolean; - /** - * Day that will be counted as the first day of the week in reports. This is - * a required field. - */ - firstDayOfWeek?: string; - /** - * ID of this floodlight configuration. This is a read-only, auto-generated - * field. - */ - id?: string; - /** - * Dimension value for the ID of this floodlight configuration. This is a - * read-only, auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Whether in-app attribution tracking is enabled. - */ - inAppAttributionTrackingEnabled?: boolean; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#floodlightConfiguration". - */ - kind?: string; - /** - * Lookback window settings for this floodlight configuration. - */ - lookbackConfiguration?: Schema$LookbackConfiguration; - /** - * Types of attribution options for natural search conversions. - */ - naturalSearchConversionAttributionOption?: string; - /** - * Settings for Campaign Manager Omniture integration. - */ - omnitureSettings?: Schema$OmnitureSettings; - /** - * Subaccount ID of this floodlight configuration. This is a read-only field - * that can be left blank. - */ - subaccountId?: string; - /** - * Configuration settings for dynamic and image floodlight tags. - */ - tagSettings?: Schema$TagSettings; - /** - * List of third-party authentication tokens enabled for this configuration. - */ - thirdPartyAuthenticationTokens?: Schema$ThirdPartyAuthenticationToken[]; - /** - * List of user defined variables enabled for this configuration. - */ - userDefinedVariableConfigurations?: - Schema$UserDefinedVariableConfiguration[]; - } - /** - * Floodlight Configuration List Response - */ - export interface Schema$FloodlightConfigurationsListResponse { - /** - * Floodlight configuration collection. - */ - floodlightConfigurations?: Schema$FloodlightConfiguration[]; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#floodlightConfigurationsListResponse". - */ - kind?: string; - } - /** - * Represents fields that are compatible to be selected for a report of type - * "FlOODLIGHT". - */ - export interface Schema$FloodlightReportCompatibleFields { - /** - * Dimensions which are compatible to be selected in the - * "dimensionFilters" section of the report. - */ - dimensionFilters?: Schema$Dimension[]; - /** - * Dimensions which are compatible to be selected in the - * "dimensions" section of the report. - */ - dimensions?: Schema$Dimension[]; - /** - * The kind of resource this is, in this case - * dfareporting#floodlightReportCompatibleFields. - */ - kind?: string; - /** - * Metrics which are compatible to be selected in the - * "metricNames" section of the report. - */ - metrics?: Schema$Metric[]; - } - /** - * Frequency Cap. - */ - export interface Schema$FrequencyCap { - /** - * Duration of time, in seconds, for this frequency cap. The maximum - * duration is 90 days. Acceptable values are 1 to 7776000, inclusive. - */ - duration?: string; - /** - * Number of times an individual user can be served the ad within the - * specified duration. Acceptable values are 1 to 15, inclusive. - */ - impressions?: string; - } - /** - * FsCommand. - */ - export interface Schema$FsCommand { - /** - * Distance from the left of the browser.Applicable when positionOption is - * DISTANCE_FROM_TOP_LEFT_CORNER. - */ - left?: number; - /** - * Position in the browser where the window will open. - */ - positionOption?: string; - /** - * Distance from the top of the browser. Applicable when positionOption is - * DISTANCE_FROM_TOP_LEFT_CORNER. - */ - top?: number; - /** - * Height of the window. - */ - windowHeight?: number; - /** - * Width of the window. - */ - windowWidth?: number; - } - /** - * Geographical Targeting. - */ - export interface Schema$GeoTargeting { - /** - * Cities to be targeted. For each city only dartId is required. The other - * fields are populated automatically when the ad is inserted or updated. If - * targeting a city, do not target or exclude the country of the city, and - * do not target the metro or region of the city. - */ - cities?: Schema$City[]; - /** - * Countries to be targeted or excluded from targeting, depending on the - * setting of the excludeCountries field. For each country only dartId is - * required. The other fields are populated automatically when the ad is - * inserted or updated. If targeting or excluding a country, do not target - * regions, cities, metros, or postal codes in the same country. - */ - countries?: Schema$Country[]; - /** - * Whether or not to exclude the countries in the countries field from - * targeting. If false, the countries field refers to countries which will - * be targeted by the ad. - */ - excludeCountries?: boolean; - /** - * Metros to be targeted. For each metro only dmaId is required. The other - * fields are populated automatically when the ad is inserted or updated. If - * targeting a metro, do not target or exclude the country of the metro. - */ - metros?: Schema$Metro[]; - /** - * Postal codes to be targeted. For each postal code only id is required. - * The other fields are populated automatically when the ad is inserted or - * updated. If targeting a postal code, do not target or exclude the country - * of the postal code. - */ - postalCodes?: Schema$PostalCode[]; - /** - * Regions to be targeted. For each region only dartId is required. The - * other fields are populated automatically when the ad is inserted or - * updated. If targeting a region, do not target or exclude the country of - * the region. - */ - regions?: Schema$Region[]; - } - /** - * Represents a buy from the Planning inventory store. - */ - export interface Schema$InventoryItem { - /** - * Account ID of this inventory item. - */ - accountId?: string; - /** - * Ad slots of this inventory item. If this inventory item represents a - * standalone placement, there will be exactly one ad slot. If this - * inventory item represents a placement group, there will be more than one - * ad slot, each representing one child placement in that placement group. - */ - adSlots?: Schema$AdSlot[]; - /** - * Advertiser ID of this inventory item. - */ - advertiserId?: string; - /** - * Content category ID of this inventory item. - */ - contentCategoryId?: string; - /** - * Estimated click-through rate of this inventory item. - */ - estimatedClickThroughRate?: string; - /** - * Estimated conversion rate of this inventory item. - */ - estimatedConversionRate?: string; - /** - * ID of this inventory item. - */ - id?: string; - /** - * Whether this inventory item is in plan. - */ - inPlan?: boolean; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#inventoryItem". - */ - kind?: string; - /** - * Information about the most recent modification of this inventory item. - */ - lastModifiedInfo?: Schema$LastModifiedInfo; - /** - * Name of this inventory item. For standalone inventory items, this is the - * same name as that of its only ad slot. For group inventory items, this - * can differ from the name of any of its ad slots. - */ - name?: string; - /** - * Negotiation channel ID of this inventory item. - */ - negotiationChannelId?: string; - /** - * Order ID of this inventory item. - */ - orderId?: string; - /** - * Placement strategy ID of this inventory item. - */ - placementStrategyId?: string; - /** - * Pricing of this inventory item. - */ - pricing?: Schema$Pricing; - /** - * Project ID of this inventory item. - */ - projectId?: string; - /** - * RFP ID of this inventory item. - */ - rfpId?: string; - /** - * ID of the site this inventory item is associated with. - */ - siteId?: string; - /** - * Subaccount ID of this inventory item. - */ - subaccountId?: string; - /** - * Type of inventory item. - */ - type?: string; - } - /** - * Inventory item List Response - */ - export interface Schema$InventoryItemsListResponse { - /** - * Inventory item collection - */ - inventoryItems?: Schema$InventoryItem[]; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#inventoryItemsListResponse". - */ - kind?: string; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string; - } - /** - * Key Value Targeting Expression. - */ - export interface Schema$KeyValueTargetingExpression { - /** - * Keyword expression being targeted by the ad. - */ - expression?: string; - } - /** - * Contains information about where a user's browser is taken after the - * user clicks an ad. - */ - export interface Schema$LandingPage { - /** - * Whether or not this landing page will be assigned to any ads or creatives - * that do not have a landing page assigned explicitly. Only one default - * landing page is allowed per campaign. - */ - default?: boolean; - /** - * ID of this landing page. This is a read-only, auto-generated field. - */ - id?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#landingPage". - */ - kind?: string; - /** - * Name of this landing page. This is a required field. It must be less than - * 256 characters long, and must be unique among landing pages of the same - * campaign. - */ - name?: string; - /** - * URL of this landing page. This is a required field. - */ - url?: string; - } - /** - * Landing Page List Response - */ - export interface Schema$LandingPagesListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#landingPagesListResponse". - */ - kind?: string; - /** - * Landing page collection - */ - landingPages?: Schema$LandingPage[]; - } - /** - * Contains information about a language that can be targeted by ads. - */ - export interface Schema$Language { - /** - * Language ID of this language. This is the ID used for targeting and - * generating reports. - */ - id?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#language". - */ - kind?: string; - /** - * Format of language code is an ISO 639 two-letter language code optionally - * followed by an underscore followed by an ISO 3166 code. Examples are - * "en" for English or "zh_CN" for Simplified Chinese. - */ - languageCode?: string; - /** - * Name of this language. - */ - name?: string; - } - /** - * Language List Response - */ - export interface Schema$LanguagesListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#languagesListResponse". - */ - kind?: string; - /** - * Language collection. - */ - languages?: Schema$Language[]; - } - /** - * Language Targeting. - */ - export interface Schema$LanguageTargeting { - /** - * Languages that this ad targets. For each language only languageId is - * required. The other fields are populated automatically when the ad is - * inserted or updated. - */ - languages?: Schema$Language[]; - } - /** - * Modification timestamp. - */ - export interface Schema$LastModifiedInfo { - /** - * Timestamp of the last change in milliseconds since epoch. - */ - time?: string; - } - /** - * A group clause made up of list population terms representing constraints - * joined by ORs. - */ - export interface Schema$ListPopulationClause { - /** - * Terms of this list population clause. Each clause is made up of list - * population terms representing constraints and are joined by ORs. - */ - terms?: Schema$ListPopulationTerm[]; - } - /** - * Remarketing List Population Rule. - */ - export interface Schema$ListPopulationRule { - /** - * Floodlight activity ID associated with this rule. This field can be left - * blank. - */ - floodlightActivityId?: string; - /** - * Name of floodlight activity associated with this rule. This is a - * read-only, auto-generated field. - */ - floodlightActivityName?: string; - /** - * Clauses that make up this list population rule. Clauses are joined by - * ANDs, and the clauses themselves are made up of list population terms - * which are joined by ORs. - */ - listPopulationClauses?: Schema$ListPopulationClause[]; - } - /** - * Remarketing List Population Rule Term. - */ - export interface Schema$ListPopulationTerm { - /** - * Will be true if the term should check if the user is in the list and - * false if the term should check if the user is not in the list. This field - * is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by - * default. - */ - contains?: boolean; - /** - * Whether to negate the comparison result of this term during rule - * evaluation. This field is only relevant when type is left unset or set to - * CUSTOM_VARIABLE_TERM or REFERRER_TERM. - */ - negation?: boolean; - /** - * Comparison operator of this term. This field is only relevant when type - * is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. - */ - operator?: string; - /** - * ID of the list in question. This field is only relevant when type is set - * to LIST_MEMBERSHIP_TERM. - */ - remarketingListId?: string; - /** - * List population term type determines the applicable fields in this - * object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, - * variableFriendlyName, operator, value, and negation are applicable. If - * set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are - * applicable. If set to REFERRER_TERM then operator, value, and negation - * are applicable. - */ - type?: string; - /** - * Literal to compare the variable to. This field is only relevant when type - * is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. - */ - value?: string; - /** - * Friendly name of this term's variable. This is a read-only, - * auto-generated field. This field is only relevant when type is left unset - * or set to CUSTOM_VARIABLE_TERM. - */ - variableFriendlyName?: string; - /** - * Name of the variable (U1, U2, etc.) being compared in this term. This - * field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or - * REFERRER_TERM. - */ - variableName?: string; - } - /** - * Remarketing List Targeting Expression. - */ - export interface Schema$ListTargetingExpression { - /** - * Expression describing which lists are being targeted by the ad. - */ - expression?: string; - } - /** - * Lookback configuration settings. - */ - export interface Schema$LookbackConfiguration { - /** - * Lookback window, in days, from the last time a given user clicked on one - * of your ads. If you enter 0, clicks will not be considered as triggering - * events for floodlight tracking. If you leave this field blank, the - * default value for your account will be used. Acceptable values are 0 to - * 90, inclusive. - */ - clickDuration?: number; - /** - * Lookback window, in days, from the last time a given user viewed one of - * your ads. If you enter 0, impressions will not be considered as - * triggering events for floodlight tracking. If you leave this field blank, - * the default value for your account will be used. Acceptable values are 0 - * to 90, inclusive. - */ - postImpressionActivitiesDuration?: number; - } - /** - * Represents a metric. - */ - export interface Schema$Metric { - /** - * The kind of resource this is, in this case dfareporting#metric. - */ - kind?: string; - /** - * The metric name, e.g. dfa:impressions - */ - name?: string; - } - /** - * Contains information about a metro region that can be targeted by ads. - */ - export interface Schema$Metro { - /** - * Country code of the country to which this metro region belongs. - */ - countryCode?: string; - /** - * DART ID of the country to which this metro region belongs. - */ - countryDartId?: string; - /** - * DART ID of this metro region. - */ - dartId?: string; - /** - * DMA ID of this metro region. This is the ID used for targeting and - * generating reports, and is equivalent to metro_code. - */ - dmaId?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#metro". - */ - kind?: string; - /** - * Metro code of this metro region. This is equivalent to dma_id. - */ - metroCode?: string; - /** - * Name of this metro region. - */ - name?: string; - } - /** - * Metro List Response - */ - export interface Schema$MetrosListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#metrosListResponse". - */ - kind?: string; - /** - * Metro collection. - */ - metros?: Schema$Metro[]; - } - /** - * Contains information about a mobile carrier that can be targeted by ads. - */ - export interface Schema$MobileCarrier { - /** - * Country code of the country to which this mobile carrier belongs. - */ - countryCode?: string; - /** - * DART ID of the country to which this mobile carrier belongs. - */ - countryDartId?: string; - /** - * ID of this mobile carrier. - */ - id?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#mobileCarrier". - */ - kind?: string; - /** - * Name of this mobile carrier. - */ - name?: string; - } - /** - * Mobile Carrier List Response - */ - export interface Schema$MobileCarriersListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#mobileCarriersListResponse". - */ - kind?: string; - /** - * Mobile carrier collection. - */ - mobileCarriers?: Schema$MobileCarrier[]; - } - /** - * Object Filter. - */ - export interface Schema$ObjectFilter { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#objectFilter". - */ - kind?: string; - /** - * Applicable when status is ASSIGNED. The user has access to objects with - * these object IDs. - */ - objectIds?: string[]; - /** - * Status of the filter. NONE means the user has access to none of the - * objects. ALL means the user has access to all objects. ASSIGNED means the - * user has access to the objects with IDs in the objectIds list. - */ - status?: string; - } - /** - * Offset Position. - */ - export interface Schema$OffsetPosition { - /** - * Offset distance from left side of an asset or a window. - */ - left?: number; - /** - * Offset distance from top side of an asset or a window. - */ - top?: number; - } - /** - * Omniture Integration Settings. - */ - export interface Schema$OmnitureSettings { - /** - * Whether placement cost data will be sent to Omniture. This property can - * be enabled only if omnitureIntegrationEnabled is true. - */ - omnitureCostDataEnabled?: boolean; - /** - * Whether Omniture integration is enabled. This property can be enabled - * only when the "Advanced Ad Serving" account setting is enabled. - */ - omnitureIntegrationEnabled?: boolean; - } - /** - * Contains information about an operating system that can be targeted by ads. - */ - export interface Schema$OperatingSystem { - /** - * DART ID of this operating system. This is the ID used for targeting. - */ - dartId?: string; - /** - * Whether this operating system is for desktop. - */ - desktop?: boolean; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#operatingSystem". - */ - kind?: string; - /** - * Whether this operating system is for mobile. - */ - mobile?: boolean; - /** - * Name of this operating system. - */ - name?: string; - } - /** - * Operating System List Response - */ - export interface Schema$OperatingSystemsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#operatingSystemsListResponse". - */ - kind?: string; - /** - * Operating system collection. - */ - operatingSystems?: Schema$OperatingSystem[]; - } - /** - * Contains information about a particular version of an operating system that - * can be targeted by ads. - */ - export interface Schema$OperatingSystemVersion { - /** - * ID of this operating system version. - */ - id?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#operatingSystemVersion". - */ - kind?: string; - /** - * Major version (leftmost number) of this operating system version. - */ - majorVersion?: string; - /** - * Minor version (number after the first dot) of this operating system - * version. - */ - minorVersion?: string; - /** - * Name of this operating system version. - */ - name?: string; - /** - * Operating system of this operating system version. - */ - operatingSystem?: Schema$OperatingSystem; - } - /** - * Operating System Version List Response - */ - export interface Schema$OperatingSystemVersionsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#operatingSystemVersionsListResponse". - */ - kind?: string; - /** - * Operating system version collection. - */ - operatingSystemVersions?: Schema$OperatingSystemVersion[]; - } - /** - * Creative optimization activity. - */ - export interface Schema$OptimizationActivity { - /** - * Floodlight activity ID of this optimization activity. This is a required - * field. - */ - floodlightActivityId?: string; - /** - * Dimension value for the ID of the floodlight activity. This is a - * read-only, auto-generated field. - */ - floodlightActivityIdDimensionValue?: Schema$DimensionValue; - /** - * Weight associated with this optimization. The weight assigned will be - * understood in proportion to the weights assigned to the other - * optimization activities. Value must be greater than or equal to 1. - */ - weight?: number; - } - /** - * Describes properties of a Planning order. - */ - export interface Schema$Order { - /** - * Account ID of this order. - */ - accountId?: string; - /** - * Advertiser ID of this order. - */ - advertiserId?: string; - /** - * IDs for users that have to approve documents created for this order. - */ - approverUserProfileIds?: string[]; - /** - * Buyer invoice ID associated with this order. - */ - buyerInvoiceId?: string; - /** - * Name of the buyer organization. - */ - buyerOrganizationName?: string; - /** - * Comments in this order. - */ - comments?: string; - /** - * Contacts for this order. - */ - contacts?: Schema$OrderContact[]; - /** - * ID of this order. This is a read-only, auto-generated field. - */ - id?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#order". - */ - kind?: string; - /** - * Information about the most recent modification of this order. - */ - lastModifiedInfo?: Schema$LastModifiedInfo; - /** - * Name of this order. - */ - name?: string; - /** - * Notes of this order. - */ - notes?: string; - /** - * ID of the terms and conditions template used in this order. - */ - planningTermId?: string; - /** - * Project ID of this order. - */ - projectId?: string; - /** - * Seller order ID associated with this order. - */ - sellerOrderId?: string; - /** - * Name of the seller organization. - */ - sellerOrganizationName?: string; - /** - * Site IDs this order is associated with. - */ - siteId?: string[]; - /** - * Free-form site names this order is associated with. - */ - siteNames?: string[]; - /** - * Subaccount ID of this order. - */ - subaccountId?: string; - /** - * Terms and conditions of this order. - */ - termsAndConditions?: string; - } - /** - * Contact of an order. - */ - export interface Schema$OrderContact { - /** - * Free-form information about this contact. It could be any information - * related to this contact in addition to type, title, name, and signature - * user profile ID. - */ - contactInfo?: string; - /** - * Name of this contact. - */ - contactName?: string; - /** - * Title of this contact. - */ - contactTitle?: string; - /** - * Type of this contact. - */ - contactType?: string; - /** - * ID of the user profile containing the signature that will be embedded - * into order documents. - */ - signatureUserProfileId?: string; - } - /** - * Contains properties of a Planning order document. - */ - export interface Schema$OrderDocument { - /** - * Account ID of this order document. - */ - accountId?: string; - /** - * Advertiser ID of this order document. - */ - advertiserId?: string; - /** - * The amended order document ID of this order document. An order document - * can be created by optionally amending another order document so that the - * change history can be preserved. - */ - amendedOrderDocumentId?: string; - /** - * IDs of users who have approved this order document. - */ - approvedByUserProfileIds?: string[]; - /** - * Whether this order document is cancelled. - */ - cancelled?: boolean; - /** - * Information about the creation of this order document. - */ - createdInfo?: Schema$LastModifiedInfo; - /** - * Effective date of this order document. - */ - effectiveDate?: string; - /** - * ID of this order document. - */ - id?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#orderDocument". - */ - kind?: string; - /** - * List of email addresses that received the last sent document. - */ - lastSentRecipients?: string[]; - /** - * Timestamp of the last email sent with this order document. - */ - lastSentTime?: string; - /** - * ID of the order from which this order document is created. - */ - orderId?: string; - /** - * Project ID of this order document. - */ - projectId?: string; - /** - * Whether this order document has been signed. - */ - signed?: boolean; - /** - * Subaccount ID of this order document. - */ - subaccountId?: string; - /** - * Title of this order document. - */ - title?: string; - /** - * Type of this order document - */ - type?: string; - } - /** - * Order document List Response - */ - export interface Schema$OrderDocumentsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#orderDocumentsListResponse". - */ - kind?: string; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string; - /** - * Order document collection - */ - orderDocuments?: Schema$OrderDocument[]; - } - /** - * Order List Response - */ - export interface Schema$OrdersListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#ordersListResponse". - */ - kind?: string; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string; - /** - * Order collection. - */ - orders?: Schema$Order[]; - } - /** - * Represents fields that are compatible to be selected for a report of type - * "PATH_TO_CONVERSION". - */ - export interface Schema$PathToConversionReportCompatibleFields { - /** - * Conversion dimensions which are compatible to be selected in the - * "conversionDimensions" section of the report. - */ - conversionDimensions?: Schema$Dimension[]; - /** - * Custom floodlight variables which are compatible to be selected in the - * "customFloodlightVariables" section of the report. - */ - customFloodlightVariables?: Schema$Dimension[]; - /** - * The kind of resource this is, in this case - * dfareporting#pathToConversionReportCompatibleFields. - */ - kind?: string; - /** - * Metrics which are compatible to be selected in the - * "metricNames" section of the report. - */ - metrics?: Schema$Metric[]; - /** - * Per-interaction dimensions which are compatible to be selected in the - * "perInteractionDimensions" section of the report. - */ - perInteractionDimensions?: Schema$Dimension[]; - } - /** - * Contains properties of a placement. - */ - export interface Schema$Placement { - /** - * Account ID of this placement. This field can be left blank. - */ - accountId?: string; - /** - * Whether this placement opts out of ad blocking. When true, ad blocking is - * disabled for this placement. When false, the campaign and site settings - * take effect. - */ - adBlockingOptOut?: boolean; - /** - * Advertiser ID of this placement. This field can be left blank. - */ - advertiserId?: string; - /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Whether this placement is archived. - */ - archived?: boolean; - /** - * Campaign ID of this placement. This field is a required field on - * insertion. - */ - campaignId?: string; - /** - * Dimension value for the ID of the campaign. This is a read-only, - * auto-generated field. - */ - campaignIdDimensionValue?: Schema$DimensionValue; - /** - * Comments for this placement. - */ - comment?: string; - /** - * Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to - * rendering on desktop, on mobile devices or in mobile apps for regular or - * interstitial ads respectively. APP and APP_INTERSTITIAL are no longer - * allowed for new placement insertions. Instead, use DISPLAY or - * DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream - * video ads developed with the VAST standard. This field is required on - * insertion. - */ - compatibility?: string; - /** - * ID of the content category assigned to this placement. - */ - contentCategoryId?: string; - /** - * Information about the creation of this placement. This is a read-only - * field. - */ - createInfo?: Schema$LastModifiedInfo; - /** - * Directory site ID of this placement. On insert, you must set either this - * field or the siteId field to specify the site associated with this - * placement. This is a required field that is read-only after insertion. - */ - directorySiteId?: string; - /** - * Dimension value for the ID of the directory site. This is a read-only, - * auto-generated field. - */ - directorySiteIdDimensionValue?: Schema$DimensionValue; - /** - * External ID for this placement. - */ - externalId?: string; - /** - * ID of this placement. This is a read-only, auto-generated field. - */ - id?: string; - /** - * Dimension value for the ID of this placement. This is a read-only, - * auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Key name of this placement. This is a read-only, auto-generated field. - */ - keyName?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#placement". - */ - kind?: string; - /** - * Information about the most recent modification of this placement. This is - * a read-only field. - */ - lastModifiedInfo?: Schema$LastModifiedInfo; - /** - * Lookback window settings for this placement. - */ - lookbackConfiguration?: Schema$LookbackConfiguration; - /** - * Name of this placement.This is a required field and must be less than 256 - * characters long. - */ - name?: string; - /** - * Whether payment was approved for this placement. This is a read-only - * field relevant only to publisher-paid placements. - */ - paymentApproved?: boolean; - /** - * Payment source for this placement. This is a required field that is - * read-only after insertion. - */ - paymentSource?: string; - /** - * ID of this placement's group, if applicable. - */ - placementGroupId?: string; - /** - * Dimension value for the ID of the placement group. This is a read-only, - * auto-generated field. - */ - placementGroupIdDimensionValue?: Schema$DimensionValue; - /** - * ID of the placement strategy assigned to this placement. - */ - placementStrategyId?: string; - /** - * Pricing schedule of this placement. This field is required on insertion, - * specifically subfields startDate, endDate and pricingType. - */ - pricingSchedule?: Schema$PricingSchedule; - /** - * Whether this placement is the primary placement of a roadblock (placement - * group). You cannot change this field from true to false. Setting this - * field to true will automatically set the primary field on the original - * primary placement of the roadblock to false, and it will automatically - * set the roadblock's primaryPlacementId field to the ID of this - * placement. - */ - primary?: boolean; - /** - * Information about the last publisher update. This is a read-only field. - */ - publisherUpdateInfo?: Schema$LastModifiedInfo; - /** - * Site ID associated with this placement. On insert, you must set either - * this field or the directorySiteId field to specify the site associated - * with this placement. This is a required field that is read-only after - * insertion. - */ - siteId?: string; - /** - * Dimension value for the ID of the site. This is a read-only, - * auto-generated field. - */ - siteIdDimensionValue?: Schema$DimensionValue; - /** - * Size associated with this placement. When inserting or updating a - * placement, only the size ID field is used. This field is required on - * insertion. - */ - size?: Schema$Size; - /** - * Whether creatives assigned to this placement must be SSL-compliant. - */ - sslRequired?: boolean; - /** - * Third-party placement status. - */ - status?: string; - /** - * Subaccount ID of this placement. This field can be left blank. - */ - subaccountId?: string; - /** - * Tag formats to generate for this placement. This field is required on - * insertion. Acceptable values are: - "PLACEMENT_TAG_STANDARD" - - * "PLACEMENT_TAG_IFRAME_JAVASCRIPT" - - * "PLACEMENT_TAG_IFRAME_ILAYER" - - * "PLACEMENT_TAG_INTERNAL_REDIRECT" - - * "PLACEMENT_TAG_JAVASCRIPT" - - * "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT" - - * "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT" - - * "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT" - - * "PLACEMENT_TAG_CLICK_COMMANDS" - - * "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH" - - * "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3" - - * "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4" - - * "PLACEMENT_TAG_TRACKING" - - * "PLACEMENT_TAG_TRACKING_IFRAME" - - * "PLACEMENT_TAG_TRACKING_JAVASCRIPT" - */ - tagFormats?: string[]; - /** - * Tag settings for this placement. - */ - tagSetting?: Schema$TagSetting; - /** - * Whether Verification and ActiveView are disabled for in-stream video - * creatives for this placement. The same setting videoActiveViewOptOut - * exists on the site level -- the opt out occurs if either of these - * settings are true. These settings are distinct from - * DirectorySites.settings.activeViewOptOut or - * Sites.siteSettings.activeViewOptOut which only apply to display ads. - * However, Accounts.activeViewOptOut opts out both video traffic, as well - * as display ads, from Verification and ActiveView. - */ - videoActiveViewOptOut?: boolean; - /** - * A collection of settings which affect video creatives served through this - * placement. Applicable to placements with IN_STREAM_VIDEO compatibility. - */ - videoSettings?: Schema$VideoSettings; - /** - * VPAID adapter setting for this placement. Controls which VPAID format the - * measurement adapter will use for in-stream video creatives assigned to - * this placement. Note: Flash is no longer supported. This field now - * defaults to HTML5 when the following values are provided: FLASH, BOTH. - */ - vpaidAdapterChoice?: string; - } - /** - * Placement Assignment. - */ - export interface Schema$PlacementAssignment { - /** - * Whether this placement assignment is active. When true, the placement - * will be included in the ad's rotation. - */ - active?: boolean; - /** - * ID of the placement to be assigned. This is a required field. - */ - placementId?: string; - /** - * Dimension value for the ID of the placement. This is a read-only, - * auto-generated field. - */ - placementIdDimensionValue?: Schema$DimensionValue; - /** - * Whether the placement to be assigned requires SSL. This is a read-only - * field that is auto-generated when the ad is inserted or updated. - */ - sslRequired?: boolean; - } - /** - * Contains properties of a package or roadblock. - */ - export interface Schema$PlacementGroup { - /** - * Account ID of this placement group. This is a read-only field that can be - * left blank. - */ - accountId?: string; - /** - * Advertiser ID of this placement group. This is a required field on - * insertion. - */ - advertiserId?: string; - /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Whether this placement group is archived. - */ - archived?: boolean; - /** - * Campaign ID of this placement group. This field is required on insertion. - */ - campaignId?: string; - /** - * Dimension value for the ID of the campaign. This is a read-only, - * auto-generated field. - */ - campaignIdDimensionValue?: Schema$DimensionValue; - /** - * IDs of placements which are assigned to this placement group. This is a - * read-only, auto-generated field. - */ - childPlacementIds?: string[]; - /** - * Comments for this placement group. - */ - comment?: string; - /** - * ID of the content category assigned to this placement group. - */ - contentCategoryId?: string; - /** - * Information about the creation of this placement group. This is a - * read-only field. - */ - createInfo?: Schema$LastModifiedInfo; - /** - * Directory site ID associated with this placement group. On insert, you - * must set either this field or the site_id field to specify the site - * associated with this placement group. This is a required field that is - * read-only after insertion. - */ - directorySiteId?: string; - /** - * Dimension value for the ID of the directory site. This is a read-only, - * auto-generated field. - */ - directorySiteIdDimensionValue?: Schema$DimensionValue; - /** - * External ID for this placement. - */ - externalId?: string; - /** - * ID of this placement group. This is a read-only, auto-generated field. - */ - id?: string; - /** - * Dimension value for the ID of this placement group. This is a read-only, - * auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#placementGroup". - */ - kind?: string; - /** - * Information about the most recent modification of this placement group. - * This is a read-only field. - */ - lastModifiedInfo?: Schema$LastModifiedInfo; - /** - * Name of this placement group. This is a required field and must be less - * than 256 characters long. - */ - name?: string; - /** - * Type of this placement group. A package is a simple group of placements - * that acts as a single pricing point for a group of tags. A roadblock is a - * group of placements that not only acts as a single pricing point, but - * also assumes that all the tags in it will be served at the same time. A - * roadblock requires one of its assigned placements to be marked as primary - * for reporting. This field is required on insertion. - */ - placementGroupType?: string; - /** - * ID of the placement strategy assigned to this placement group. - */ - placementStrategyId?: string; - /** - * Pricing schedule of this placement group. This field is required on - * insertion. - */ - pricingSchedule?: Schema$PricingSchedule; - /** - * ID of the primary placement, used to calculate the media cost of a - * roadblock (placement group). Modifying this field will automatically - * modify the primary field on all affected roadblock child placements. - */ - primaryPlacementId?: string; - /** - * Dimension value for the ID of the primary placement. This is a read-only, - * auto-generated field. - */ - primaryPlacementIdDimensionValue?: Schema$DimensionValue; - /** - * Site ID associated with this placement group. On insert, you must set - * either this field or the directorySiteId field to specify the site - * associated with this placement group. This is a required field that is - * read-only after insertion. - */ - siteId?: string; - /** - * Dimension value for the ID of the site. This is a read-only, - * auto-generated field. - */ - siteIdDimensionValue?: Schema$DimensionValue; - /** - * Subaccount ID of this placement group. This is a read-only field that can - * be left blank. - */ - subaccountId?: string; - } - /** - * Placement Group List Response - */ - export interface Schema$PlacementGroupsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#placementGroupsListResponse". - */ - kind?: string; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string; - /** - * Placement group collection. - */ - placementGroups?: Schema$PlacementGroup[]; - } - /** - * Placement GenerateTags Response - */ - export interface Schema$PlacementsGenerateTagsResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#placementsGenerateTagsResponse". - */ - kind?: string; - /** - * Set of generated tags for the specified placements. - */ - placementTags?: Schema$PlacementTag[]; - } - /** - * Placement List Response - */ - export interface Schema$PlacementsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#placementsListResponse". - */ - kind?: string; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string; - /** - * Placement collection. - */ - placements?: Schema$Placement[]; - } - /** - * Placement Strategy List Response - */ - export interface Schema$PlacementStrategiesListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#placementStrategiesListResponse". - */ - kind?: string; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string; - /** - * Placement strategy collection. - */ - placementStrategies?: Schema$PlacementStrategy[]; - } - /** - * Contains properties of a placement strategy. - */ - export interface Schema$PlacementStrategy { - /** - * Account ID of this placement strategy.This is a read-only field that can - * be left blank. - */ - accountId?: string; - /** - * ID of this placement strategy. This is a read-only, auto-generated field. - */ - id?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#placementStrategy". - */ - kind?: string; - /** - * Name of this placement strategy. This is a required field. It must be - * less than 256 characters long and unique among placement strategies of - * the same account. - */ - name?: string; - } - /** - * Placement Tag - */ - export interface Schema$PlacementTag { - /** - * Placement ID - */ - placementId?: string; - /** - * Tags generated for this placement. - */ - tagDatas?: Schema$TagData[]; - } - /** - * Contains information about a platform type that can be targeted by ads. - */ - export interface Schema$PlatformType { - /** - * ID of this platform type. - */ - id?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#platformType". - */ - kind?: string; - /** - * Name of this platform type. - */ - name?: string; - } - /** - * Platform Type List Response - */ - export interface Schema$PlatformTypesListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#platformTypesListResponse". - */ - kind?: string; - /** - * Platform type collection. - */ - platformTypes?: Schema$PlatformType[]; - } - /** - * Popup Window Properties. - */ - export interface Schema$PopupWindowProperties { - /** - * Popup dimension for a creative. This is a read-only field. Applicable to - * the following creative types: all RICH_MEDIA and all VPAID - */ - dimension?: Schema$Size; - /** - * Upper-left corner coordinates of the popup window. Applicable if - * positionType is COORDINATES. - */ - offset?: Schema$OffsetPosition; - /** - * Popup window position either centered or at specific coordinate. - */ - positionType?: string; - /** - * Whether to display the browser address bar. - */ - showAddressBar?: boolean; - /** - * Whether to display the browser menu bar. - */ - showMenuBar?: boolean; - /** - * Whether to display the browser scroll bar. - */ - showScrollBar?: boolean; - /** - * Whether to display the browser status bar. - */ - showStatusBar?: boolean; - /** - * Whether to display the browser tool bar. - */ - showToolBar?: boolean; - /** - * Title of popup window. - */ - title?: string; - } - /** - * Contains information about a postal code that can be targeted by ads. - */ - export interface Schema$PostalCode { - /** - * Postal code. This is equivalent to the id field. - */ - code?: string; - /** - * Country code of the country to which this postal code belongs. - */ - countryCode?: string; - /** - * DART ID of the country to which this postal code belongs. - */ - countryDartId?: string; - /** - * ID of this postal code. - */ - id?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#postalCode". - */ - kind?: string; - } - /** - * Postal Code List Response - */ - export interface Schema$PostalCodesListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#postalCodesListResponse". - */ - kind?: string; - /** - * Postal code collection. - */ - postalCodes?: Schema$PostalCode[]; - } - /** - * Pricing Information - */ - export interface Schema$Pricing { - /** - * Cap cost type of this inventory item. - */ - capCostType?: string; - /** - * End date of this inventory item. - */ - endDate?: string; - /** - * Flights of this inventory item. A flight (a.k.a. pricing period) - * represents the inventory item pricing information for a specific period - * of time. - */ - flights?: Schema$Flight[]; - /** - * Group type of this inventory item if it represents a placement group. Is - * null otherwise. There are two type of placement groups: - * PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory - * items that acts as a single pricing point for a group of tags. - * PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items - * that not only acts as a single pricing point, but also assumes that all - * the tags in it will be served at the same time. A roadblock requires one - * of its assigned inventory items to be marked as primary. - */ - groupType?: string; - /** - * Pricing type of this inventory item. - */ - pricingType?: string; - /** - * Start date of this inventory item. - */ - startDate?: string; - } - /** - * Pricing Schedule - */ - export interface Schema$PricingSchedule { - /** - * Placement cap cost option. - */ - capCostOption?: string; - /** - * Whether cap costs are ignored by ad serving. - */ - disregardOverdelivery?: boolean; - /** - * Placement end date. This date must be later than, or the same day as, the - * placement start date, but not later than the campaign end date. If, for - * example, you set 6/25/2015 as both the start and end dates, the effective - * placement date is just that day only, 6/25/2015. The hours, minutes, and - * seconds of the end date should not be set, as doing so will result in an - * error. This field is required on insertion. - */ - endDate?: string; - /** - * Whether this placement is flighted. If true, pricing periods will be - * computed automatically. - */ - flighted?: boolean; - /** - * Floodlight activity ID associated with this placement. This field should - * be set when placement pricing type is set to PRICING_TYPE_CPA. - */ - floodlightActivityId?: string; - /** - * Pricing periods for this placement. - */ - pricingPeriods?: Schema$PricingSchedulePricingPeriod[]; - /** - * Placement pricing type. This field is required on insertion. - */ - pricingType?: string; - /** - * Placement start date. This date must be later than, or the same day as, - * the campaign start date. The hours, minutes, and seconds of the start - * date should not be set, as doing so will result in an error. This field - * is required on insertion. - */ - startDate?: string; - /** - * Testing start date of this placement. The hours, minutes, and seconds of - * the start date should not be set, as doing so will result in an error. - */ - testingStartDate?: string; - } - /** - * Pricing Period - */ - export interface Schema$PricingSchedulePricingPeriod { - /** - * Pricing period end date. This date must be later than, or the same day - * as, the pricing period start date, but not later than the placement end - * date. The period end date can be the same date as the period start date. - * If, for example, you set 6/25/2015 as both the start and end dates, the - * effective pricing period date is just that day only, 6/25/2015. The - * hours, minutes, and seconds of the end date should not be set, as doing - * so will result in an error. - */ - endDate?: string; - /** - * Comments for this pricing period. - */ - pricingComment?: string; - /** - * Rate or cost of this pricing period in nanos (i.e., multipled by - * 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. - */ - rateOrCostNanos?: string; - /** - * Pricing period start date. This date must be later than, or the same day - * as, the placement start date. The hours, minutes, and seconds of the - * start date should not be set, as doing so will result in an error. - */ - startDate?: string; - /** - * Units of this pricing period. Acceptable values are 0 to 10000000000, - * inclusive. - */ - units?: string; - } - /** - * Contains properties of a Planning project. - */ - export interface Schema$Project { - /** - * Account ID of this project. - */ - accountId?: string; - /** - * Advertiser ID of this project. - */ - advertiserId?: string; - /** - * Audience age group of this project. - */ - audienceAgeGroup?: string; - /** - * Audience gender of this project. - */ - audienceGender?: string; - /** - * Budget of this project in the currency specified by the current account. - * The value stored in this field represents only the non-fractional amount. - * For example, for USD, the smallest value that can be represented by this - * field is 1 US dollar. - */ - budget?: string; - /** - * Client billing code of this project. - */ - clientBillingCode?: string; - /** - * Name of the project client. - */ - clientName?: string; - /** - * End date of the project. - */ - endDate?: string; - /** - * ID of this project. This is a read-only, auto-generated field. - */ - id?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#project". - */ - kind?: string; - /** - * Information about the most recent modification of this project. - */ - lastModifiedInfo?: Schema$LastModifiedInfo; - /** - * Name of this project. - */ - name?: string; - /** - * Overview of this project. - */ - overview?: string; - /** - * Start date of the project. - */ - startDate?: string; - /** - * Subaccount ID of this project. - */ - subaccountId?: string; - /** - * Number of clicks that the advertiser is targeting. - */ - targetClicks?: string; - /** - * Number of conversions that the advertiser is targeting. - */ - targetConversions?: string; - /** - * CPA that the advertiser is targeting. - */ - targetCpaNanos?: string; - /** - * CPC that the advertiser is targeting. - */ - targetCpcNanos?: string; - /** - * vCPM from Active View that the advertiser is targeting. - */ - targetCpmActiveViewNanos?: string; - /** - * CPM that the advertiser is targeting. - */ - targetCpmNanos?: string; - /** - * Number of impressions that the advertiser is targeting. - */ - targetImpressions?: string; - } - /** - * Project List Response - */ - export interface Schema$ProjectsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#projectsListResponse". - */ - kind?: string; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string; - /** - * Project collection. - */ - projects?: Schema$Project[]; - } - /** - * Represents fields that are compatible to be selected for a report of type - * "REACH". - */ - export interface Schema$ReachReportCompatibleFields { - /** - * Dimensions which are compatible to be selected in the - * "dimensionFilters" section of the report. - */ - dimensionFilters?: Schema$Dimension[]; - /** - * Dimensions which are compatible to be selected in the - * "dimensions" section of the report. - */ - dimensions?: Schema$Dimension[]; - /** - * The kind of resource this is, in this case - * dfareporting#reachReportCompatibleFields. - */ - kind?: string; - /** - * Metrics which are compatible to be selected in the - * "metricNames" section of the report. - */ - metrics?: Schema$Metric[]; - /** - * Metrics which are compatible to be selected as activity metrics to pivot - * on in the "activities" section of the report. - */ - pivotedActivityMetrics?: Schema$Metric[]; - /** - * Metrics which are compatible to be selected in the - * "reachByFrequencyMetricNames" section of the report. - */ - reachByFrequencyMetrics?: Schema$Metric[]; - } - /** - * Represents a recipient. - */ - export interface Schema$Recipient { - /** - * The delivery type for the recipient. - */ - deliveryType?: string; - /** - * The email address of the recipient. - */ - email?: string; - /** - * The kind of resource this is, in this case dfareporting#recipient. - */ - kind?: string; - } - /** - * Contains information about a region that can be targeted by ads. - */ - export interface Schema$Region { - /** - * Country code of the country to which this region belongs. - */ - countryCode?: string; - /** - * DART ID of the country to which this region belongs. - */ - countryDartId?: string; - /** - * DART ID of this region. - */ - dartId?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#region". - */ - kind?: string; - /** - * Name of this region. - */ - name?: string; - /** - * Region code. - */ - regionCode?: string; - } - /** - * Region List Response - */ - export interface Schema$RegionsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#regionsListResponse". - */ - kind?: string; - /** - * Region collection. - */ - regions?: Schema$Region[]; - } - /** - * Contains properties of a remarketing list. Remarketing enables you to - * create lists of users who have performed specific actions on a site, then - * target ads to members of those lists. This resource can be used to manage - * remarketing lists that are owned by your advertisers. To see all - * remarketing lists that are visible to your advertisers, including those - * that are shared to your advertiser or account, use the - * TargetableRemarketingLists resource. - */ - export interface Schema$RemarketingList { - /** - * Account ID of this remarketing list. This is a read-only, auto-generated - * field that is only returned in GET requests. - */ - accountId?: string; - /** - * Whether this remarketing list is active. - */ - active?: boolean; - /** - * Dimension value for the advertiser ID that owns this remarketing list. - * This is a required field. - */ - advertiserId?: string; - /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Remarketing list description. - */ - description?: string; - /** - * Remarketing list ID. This is a read-only, auto-generated field. - */ - id?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#remarketingList". - */ - kind?: string; - /** - * Number of days that a user should remain in the remarketing list without - * an impression. Acceptable values are 1 to 540, inclusive. - */ - lifeSpan?: string; - /** - * Rule used to populate the remarketing list with users. - */ - listPopulationRule?: Schema$ListPopulationRule; - /** - * Number of users currently in the list. This is a read-only field. - */ - listSize?: string; - /** - * Product from which this remarketing list was originated. - */ - listSource?: string; - /** - * Name of the remarketing list. This is a required field. Must be no - * greater than 128 characters long. - */ - name?: string; - /** - * Subaccount ID of this remarketing list. This is a read-only, - * auto-generated field that is only returned in GET requests. - */ - subaccountId?: string; - } - /** - * Contains properties of a remarketing list's sharing information. - * Sharing allows other accounts or advertisers to target to your remarketing - * lists. This resource can be used to manage remarketing list sharing to - * other accounts and advertisers. - */ - export interface Schema$RemarketingListShare { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#remarketingListShare". - */ - kind?: string; - /** - * Remarketing list ID. This is a read-only, auto-generated field. - */ - remarketingListId?: string; - /** - * Accounts that the remarketing list is shared with. - */ - sharedAccountIds?: string[]; - /** - * Advertisers that the remarketing list is shared with. - */ - sharedAdvertiserIds?: string[]; - } - /** - * Remarketing list response - */ - export interface Schema$RemarketingListsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#remarketingListsListResponse". - */ - kind?: string; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string; - /** - * Remarketing list collection. - */ - remarketingLists?: Schema$RemarketingList[]; - } - /** - * Represents a Report resource. - */ - export interface Schema$Report { - /** - * The account ID to which this report belongs. - */ - accountId?: string; - /** - * The report criteria for a report of type "STANDARD". - */ - criteria?: any; - /** - * The report criteria for a report of type - * "CROSS_DIMENSION_REACH". - */ - crossDimensionReachCriteria?: any; - /** - * The report's email delivery settings. - */ - delivery?: any; - /** - * The eTag of this response for caching purposes. - */ - etag?: string; - /** - * The filename used when generating report files for this report. - */ - fileName?: string; - /** - * The report criteria for a report of type "FLOODLIGHT". - */ - floodlightCriteria?: any; - /** - * The output format of the report. If not specified, default format is - * "CSV". Note that the actual format in the completed report file - * might differ if for instance the report's size exceeds the - * format's capabilities. "CSV" will then be the fallback - * format. - */ - format?: string; - /** - * The unique ID identifying this report resource. - */ - id?: string; - /** - * The kind of resource this is, in this case dfareporting#report. - */ - kind?: string; - /** - * The timestamp (in milliseconds since epoch) of when this report was last - * modified. - */ - lastModifiedTime?: string; - /** - * The name of the report. - */ - name?: string; - /** - * The user profile id of the owner of this report. - */ - ownerProfileId?: string; - /** - * The report criteria for a report of type "PATH_TO_CONVERSION". - */ - pathToConversionCriteria?: any; - /** - * The report criteria for a report of type "REACH". - */ - reachCriteria?: any; - /** - * The report's schedule. Can only be set if the report's - * 'dateRange' is a relative date range and the relative date range - * is not "TODAY". - */ - schedule?: any; - /** - * The subaccount ID to which this report belongs if applicable. - */ - subAccountId?: string; - /** - * The type of the report. - */ - type?: string; - } - /** - * Represents fields that are compatible to be selected for a report of type - * "STANDARD". - */ - export interface Schema$ReportCompatibleFields { - /** - * Dimensions which are compatible to be selected in the - * "dimensionFilters" section of the report. - */ - dimensionFilters?: Schema$Dimension[]; - /** - * Dimensions which are compatible to be selected in the - * "dimensions" section of the report. - */ - dimensions?: Schema$Dimension[]; - /** - * The kind of resource this is, in this case - * dfareporting#reportCompatibleFields. - */ - kind?: string; - /** - * Metrics which are compatible to be selected in the - * "metricNames" section of the report. - */ - metrics?: Schema$Metric[]; - /** - * Metrics which are compatible to be selected as activity metrics to pivot - * on in the "activities" section of the report. - */ - pivotedActivityMetrics?: Schema$Metric[]; - } - /** - * Represents the list of reports. - */ - export interface Schema$ReportList { - /** - * The eTag of this response for caching purposes. - */ - etag?: string; - /** - * The reports returned in this response. - */ - items?: Schema$Report[]; - /** - * The kind of list this is, in this case dfareporting#reportList. - */ - kind?: string; - /** - * Continuation token used to page through reports. To retrieve the next - * page of results, set the next request's "pageToken" to the - * value of this field. The page token is only valid for a limited amount of - * time and should not be persisted. - */ - nextPageToken?: string; - } - /** - * Reporting Configuration - */ - export interface Schema$ReportsConfiguration { - /** - * Whether the exposure to conversion report is enabled. This report shows - * detailed pathway information on up to 10 of the most recent ad exposures - * seen by a user before converting. - */ - exposureToConversionEnabled?: boolean; - /** - * Default lookback windows for new advertisers in this account. - */ - lookbackConfiguration?: Schema$LookbackConfiguration; - /** - * Report generation time zone ID of this account. This is a required field - * that can only be changed by a superuser. Acceptable values are: - - * "1" for "America/New_York" - "2" for - * "Europe/London" - "3" for "Europe/Paris" - * - "4" for "Africa/Johannesburg" - "5" for - * "Asia/Jerusalem" - "6" for "Asia/Shanghai" - * - "7" for "Asia/Hong_Kong" - "8" for - * "Asia/Tokyo" - "9" for "Australia/Sydney" - * - "10" for "Asia/Dubai" - "11" for - * "America/Los_Angeles" - "12" for - * "Pacific/Auckland" - "13" for - * "America/Sao_Paulo" - */ - reportGenerationTimeZoneId?: string; - } - /** - * Rich Media Exit Override. - */ - export interface Schema$RichMediaExitOverride { - /** - * Click-through URL of this rich media exit override. Applicable if the - * enabled field is set to true. - */ - clickThroughUrl?: Schema$ClickThroughUrl; - /** - * Whether to use the clickThroughUrl. If false, the creative-level exit - * will be used. - */ - enabled?: boolean; - /** - * ID for the override to refer to a specific exit in the creative. - */ - exitId?: string; - } - /** - * A rule associates an asset with a targeting template for asset-level - * targeting. Applicable to INSTREAM_VIDEO creatives. - */ - export interface Schema$Rule { - /** - * A creativeAssets[].id. This should refer to one of the parent assets in - * this creative. This is a required field. - */ - assetId?: string; - /** - * A user-friendly name for this rule. This is a required field. - */ - name?: string; - /** - * A targeting template ID. The targeting from the targeting template will - * be used to determine whether this asset should be served. This is a - * required field. - */ - targetingTemplateId?: string; - } - /** - * Contains properties of a site. - */ - export interface Schema$Site { - /** - * Account ID of this site. This is a read-only field that can be left - * blank. - */ - accountId?: string; - /** - * Whether this site is approved. - */ - approved?: boolean; - /** - * Directory site associated with this site. This is a required field that - * is read-only after insertion. - */ - directorySiteId?: string; - /** - * Dimension value for the ID of the directory site. This is a read-only, - * auto-generated field. - */ - directorySiteIdDimensionValue?: Schema$DimensionValue; - /** - * ID of this site. This is a read-only, auto-generated field. - */ - id?: string; - /** - * Dimension value for the ID of this site. This is a read-only, - * auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Key name of this site. This is a read-only, auto-generated field. - */ - keyName?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#site". - */ - kind?: string; - /** - * Name of this site.This is a required field. Must be less than 128 - * characters long. If this site is under a subaccount, the name must be - * unique among sites of the same subaccount. Otherwise, this site is a - * top-level site, and the name must be unique among top-level sites of the - * same account. - */ - name?: string; - /** - * Site contacts. - */ - siteContacts?: Schema$SiteContact[]; - /** - * Site-wide settings. - */ - siteSettings?: Schema$SiteSettings; - /** - * Subaccount ID of this site. This is a read-only field that can be left - * blank. - */ - subaccountId?: string; - } - /** - * Site Contact - */ - export interface Schema$SiteContact { - /** - * Address of this site contact. - */ - address?: string; - /** - * Site contact type. - */ - contactType?: string; - /** - * Email address of this site contact. This is a required field. - */ - email?: string; - /** - * First name of this site contact. - */ - firstName?: string; - /** - * ID of this site contact. This is a read-only, auto-generated field. - */ - id?: string; - /** - * Last name of this site contact. - */ - lastName?: string; - /** - * Primary phone number of this site contact. - */ - phone?: string; - /** - * Title or designation of this site contact. - */ - title?: string; - } - /** - * Site Settings - */ - export interface Schema$SiteSettings { - /** - * Whether active view creatives are disabled for this site. - */ - activeViewOptOut?: boolean; - /** - * Whether this site opts out of ad blocking. When true, ad blocking is - * disabled for all placements under the site, regardless of the individual - * placement settings. When false, the campaign and placement settings take - * effect. - */ - adBlockingOptOut?: boolean; - /** - * Site-wide creative settings. - */ - creativeSettings?: Schema$CreativeSettings; - /** - * Whether new cookies are disabled for this site. - */ - disableNewCookie?: boolean; - /** - * Lookback window settings for this site. - */ - lookbackConfiguration?: Schema$LookbackConfiguration; - /** - * Configuration settings for dynamic and image floodlight tags. - */ - tagSetting?: Schema$TagSetting; - /** - * Whether Verification and ActiveView for in-stream video creatives are - * disabled by default for new placements created under this site. This - * value will be used to populate the placement.videoActiveViewOptOut field, - * when no value is specified for the new placement. - */ - videoActiveViewOptOutTemplate?: boolean; - /** - * Default VPAID adapter setting for new placements created under this site. - * This value will be used to populate the placements.vpaidAdapterChoice - * field, when no value is specified for the new placement. Controls which - * VPAID format the measurement adapter will use for in-stream video - * creatives assigned to the placement. The publisher's specifications - * will typically determine this setting. For VPAID creatives, the adapter - * format will match the VPAID format (HTML5 VPAID creatives use the HTML5 - * adapter). Note: Flash is no longer supported. This field now defaults to - * HTML5 when the following values are provided: FLASH, BOTH. - */ - vpaidAdapterChoiceTemplate?: string; - } - /** - * Site List Response - */ - export interface Schema$SitesListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#sitesListResponse". - */ - kind?: string; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string; - /** - * Site collection. - */ - sites?: Schema$Site[]; - } - /** - * Represents the dimensions of ads, placements, creatives, or creative - * assets. - */ - export interface Schema$Size { - /** - * Height of this size. Acceptable values are 0 to 32767, inclusive. - */ - height?: number; - /** - * IAB standard size. This is a read-only, auto-generated field. - */ - iab?: boolean; - /** - * ID of this size. This is a read-only, auto-generated field. - */ - id?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#size". - */ - kind?: string; - /** - * Width of this size. Acceptable values are 0 to 32767, inclusive. - */ - width?: number; - } - /** - * Size List Response - */ - export interface Schema$SizesListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#sizesListResponse". - */ - kind?: string; - /** - * Size collection. - */ - sizes?: Schema$Size[]; - } - /** - * Skippable Settings - */ - export interface Schema$SkippableSetting { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#skippableSetting". - */ - kind?: string; - /** - * Amount of time to play videos served to this placement before counting a - * view. Applicable when skippable is true. - */ - progressOffset?: Schema$VideoOffset; - /** - * Amount of time to play videos served to this placement before the skip - * button should appear. Applicable when skippable is true. - */ - skipOffset?: Schema$VideoOffset; - /** - * Whether the user can skip creatives served to this placement. - */ - skippable?: boolean; - } - /** - * Represents a sorted dimension. - */ - export interface Schema$SortedDimension { - /** - * The kind of resource this is, in this case dfareporting#sortedDimension. - */ - kind?: string; - /** - * The name of the dimension. - */ - name?: string; - /** - * An optional sort order for the dimension column. - */ - sortOrder?: string; - } - /** - * Contains properties of a Campaign Manager subaccount. - */ - export interface Schema$Subaccount { - /** - * ID of the account that contains this subaccount. This is a read-only - * field that can be left blank. - */ - accountId?: string; - /** - * IDs of the available user role permissions for this subaccount. - */ - availablePermissionIds?: string[]; - /** - * ID of this subaccount. This is a read-only, auto-generated field. - */ - id?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#subaccount". - */ - kind?: string; - /** - * Name of this subaccount. This is a required field. Must be less than 128 - * characters long and be unique among subaccounts of the same account. - */ - name?: string; - } - /** - * Subaccount List Response - */ - export interface Schema$SubaccountsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#subaccountsListResponse". - */ - kind?: string; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string; - /** - * Subaccount collection. - */ - subaccounts?: Schema$Subaccount[]; - } - /** - * Placement Tag Data - */ - export interface Schema$TagData { - /** - * Ad associated with this placement tag. Applicable only when format is - * PLACEMENT_TAG_TRACKING. - */ - adId?: string; - /** - * Tag string to record a click. - */ - clickTag?: string; - /** - * Creative associated with this placement tag. Applicable only when format - * is PLACEMENT_TAG_TRACKING. - */ - creativeId?: string; - /** - * TagData tag format of this tag. - */ - format?: string; - /** - * Tag string for serving an ad. - */ - impressionTag?: string; - } - /** - * Tag Settings - */ - export interface Schema$TagSetting { - /** - * Additional key-values to be included in tags. Each key-value pair must be - * of the form key=value, and pairs must be separated by a semicolon (;). - * Keys and values must not contain commas. For example, id=2;color=red is a - * valid value for this field. - */ - additionalKeyValues?: string; - /** - * Whether static landing page URLs should be included in the tags. This - * setting applies only to placements. - */ - includeClickThroughUrls?: boolean; - /** - * Whether click-tracking string should be included in the tags. - */ - includeClickTracking?: boolean; - /** - * Option specifying how keywords are embedded in ad tags. This setting can - * be used to specify whether keyword placeholders are inserted in placement - * tags for this site. Publishers can then add keywords to those - * placeholders. - */ - keywordOption?: string; - } - /** - * Dynamic and Image Tag Settings. - */ - export interface Schema$TagSettings { - /** - * Whether dynamic floodlight tags are enabled. - */ - dynamicTagEnabled?: boolean; - /** - * Whether image tags are enabled. - */ - imageTagEnabled?: boolean; - } - /** - * Contains properties of a targetable remarketing list. Remarketing enables - * you to create lists of users who have performed specific actions on a site, - * then target ads to members of those lists. This resource is a read-only - * view of a remarketing list to be used to faciliate targeting ads to - * specific lists. Remarketing lists that are owned by your advertisers and - * those that are shared to your advertisers or account are accessible via - * this resource. To manage remarketing lists that are owned by your - * advertisers, use the RemarketingLists resource. - */ - export interface Schema$TargetableRemarketingList { - /** - * Account ID of this remarketing list. This is a read-only, auto-generated - * field that is only returned in GET requests. - */ - accountId?: string; - /** - * Whether this targetable remarketing list is active. - */ - active?: boolean; - /** - * Dimension value for the advertiser ID that owns this targetable - * remarketing list. - */ - advertiserId?: string; - /** - * Dimension value for the ID of the advertiser. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Targetable remarketing list description. - */ - description?: string; - /** - * Targetable remarketing list ID. - */ - id?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#targetableRemarketingList". - */ - kind?: string; - /** - * Number of days that a user should remain in the targetable remarketing - * list without an impression. - */ - lifeSpan?: string; - /** - * Number of users currently in the list. This is a read-only field. - */ - listSize?: string; - /** - * Product from which this targetable remarketing list was originated. - */ - listSource?: string; - /** - * Name of the targetable remarketing list. Is no greater than 128 - * characters long. - */ - name?: string; - /** - * Subaccount ID of this remarketing list. This is a read-only, - * auto-generated field that is only returned in GET requests. - */ - subaccountId?: string; - } - /** - * Targetable remarketing list response - */ - export interface Schema$TargetableRemarketingListsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#targetableRemarketingListsListResponse". - */ - kind?: string; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string; - /** - * Targetable remarketing list collection. - */ - targetableRemarketingLists?: Schema$TargetableRemarketingList[]; - } - /** - * Contains properties of a targeting template. A targeting template - * encapsulates targeting information which can be reused across multiple ads. - */ - export interface Schema$TargetingTemplate { - /** - * Account ID of this targeting template. This field, if left unset, will be - * auto-generated on insert and is read-only after insert. - */ - accountId?: string; - /** - * Advertiser ID of this targeting template. This is a required field on - * insert and is read-only after insert. - */ - advertiserId?: string; - /** - * Dimension value for the ID of the advertiser. This is a read-only, - * auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Time and day targeting criteria. - */ - dayPartTargeting?: Schema$DayPartTargeting; - /** - * Geographical targeting criteria. - */ - geoTargeting?: Schema$GeoTargeting; - /** - * ID of this targeting template. This is a read-only, auto-generated field. - */ - id?: string; - /** - * Key-value targeting criteria. - */ - keyValueTargetingExpression?: Schema$KeyValueTargetingExpression; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#targetingTemplate". - */ - kind?: string; - /** - * Language targeting criteria. - */ - languageTargeting?: Schema$LanguageTargeting; - /** - * Remarketing list targeting criteria. - */ - listTargetingExpression?: Schema$ListTargetingExpression; - /** - * Name of this targeting template. This field is required. It must be less - * than 256 characters long and unique within an advertiser. - */ - name?: string; - /** - * Subaccount ID of this targeting template. This field, if left unset, will - * be auto-generated on insert and is read-only after insert. - */ - subaccountId?: string; - /** - * Technology platform targeting criteria. - */ - technologyTargeting?: Schema$TechnologyTargeting; - } - /** - * Targeting Template List Response - */ - export interface Schema$TargetingTemplatesListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#targetingTemplatesListResponse". - */ - kind?: string; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string; - /** - * Targeting template collection. - */ - targetingTemplates?: Schema$TargetingTemplate[]; - } - /** - * Target Window. - */ - export interface Schema$TargetWindow { - /** - * User-entered value. - */ - customHtml?: string; - /** - * Type of browser window for which the backup image of the flash creative - * can be displayed. - */ - targetWindowOption?: string; - } - /** - * Technology Targeting. - */ - export interface Schema$TechnologyTargeting { - /** - * Browsers that this ad targets. For each browser either set - * browserVersionId or dartId along with the version numbers. If both are - * specified, only browserVersionId will be used. The other fields are - * populated automatically when the ad is inserted or updated. - */ - browsers?: Schema$Browser[]; - /** - * Connection types that this ad targets. For each connection type only id - * is required. The other fields are populated automatically when the ad is - * inserted or updated. - */ - connectionTypes?: Schema$ConnectionType[]; - /** - * Mobile carriers that this ad targets. For each mobile carrier only id is - * required, and the other fields are populated automatically when the ad is - * inserted or updated. If targeting a mobile carrier, do not set targeting - * for any zip codes. - */ - mobileCarriers?: Schema$MobileCarrier[]; - /** - * Operating systems that this ad targets. To target specific versions, use - * operatingSystemVersions. For each operating system only dartId is - * required. The other fields are populated automatically when the ad is - * inserted or updated. If targeting an operating system, do not set - * targeting for operating system versions for the same operating system. - */ - operatingSystems?: Schema$OperatingSystem[]; - /** - * Operating system versions that this ad targets. To target all versions, - * use operatingSystems. For each operating system version, only id is - * required. The other fields are populated automatically when the ad is - * inserted or updated. If targeting an operating system version, do not set - * targeting for the corresponding operating system in operatingSystems. - */ - operatingSystemVersions?: Schema$OperatingSystemVersion[]; - /** - * Platform types that this ad targets. For example, desktop, mobile, or - * tablet. For each platform type, only id is required, and the other fields - * are populated automatically when the ad is inserted or updated. - */ - platformTypes?: Schema$PlatformType[]; - } - /** - * Third Party Authentication Token - */ - export interface Schema$ThirdPartyAuthenticationToken { - /** - * Name of the third-party authentication token. - */ - name?: string; - /** - * Value of the third-party authentication token. This is a read-only, - * auto-generated field. - */ - value?: string; - } - /** - * Third-party Tracking URL. - */ - export interface Schema$ThirdPartyTrackingUrl { - /** - * Third-party URL type for in-stream video creatives. - */ - thirdPartyUrlType?: string; - /** - * URL for the specified third-party URL type. - */ - url?: string; - } - /** - * Transcode Settings - */ - export interface Schema$TranscodeSetting { - /** - * Whitelist of video formats to be served to this placement. Set this list - * to null or empty to serve all video formats. - */ - enabledVideoFormats?: number[]; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#transcodeSetting". - */ - kind?: string; - } - /** - * A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following - * creative types: INSTREAM_VIDEO and VPAID. - */ - export interface Schema$UniversalAdId { - /** - * Registry used for the Ad ID value. - */ - registry?: string; - /** - * ID value for this creative. Only alphanumeric characters and the - * following symbols are valid: "_/\-". Maximum length is 64 - * characters. Read only when registry is DCM. - */ - value?: string; - } - /** - * User Defined Variable configuration. - */ - export interface Schema$UserDefinedVariableConfiguration { - /** - * Data type for the variable. This is a required field. - */ - dataType?: string; - /** - * User-friendly name for the variable which will appear in reports. This is - * a required field, must be less than 64 characters long, and cannot - * contain the following characters: ""<>". - */ - reportName?: string; - /** - * Variable name in the tag. This is a required field. - */ - variableType?: string; - } - /** - * Represents a UserProfile resource. - */ - export interface Schema$UserProfile { - /** - * The account ID to which this profile belongs. - */ - accountId?: string; - /** - * The account name this profile belongs to. - */ - accountName?: string; - /** - * The eTag of this response for caching purposes. - */ - etag?: string; - /** - * The kind of resource this is, in this case dfareporting#userProfile. - */ - kind?: string; - /** - * The unique ID of the user profile. - */ - profileId?: string; - /** - * The sub account ID this profile belongs to if applicable. - */ - subAccountId?: string; - /** - * The sub account name this profile belongs to if applicable. - */ - subAccountName?: string; - /** - * The user name. - */ - userName?: string; - } - /** - * Represents the list of user profiles. - */ - export interface Schema$UserProfileList { - /** - * The eTag of this response for caching purposes. - */ - etag?: string; - /** - * The user profiles returned in this response. - */ - items?: Schema$UserProfile[]; - /** - * The kind of list this is, in this case dfareporting#userProfileList. - */ - kind?: string; - } - /** - * Contains properties of auser role, which is used to manage user access. - */ - export interface Schema$UserRole { - /** - * Account ID of this user role. This is a read-only field that can be left - * blank. - */ - accountId?: string; - /** - * Whether this is a default user role. Default user roles are created by - * the system for the account/subaccount and cannot be modified or deleted. - * Each default user role comes with a basic set of preassigned permissions. - */ - defaultUserRole?: boolean; - /** - * ID of this user role. This is a read-only, auto-generated field. - */ - id?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#userRole". - */ - kind?: string; - /** - * Name of this user role. This is a required field. Must be less than 256 - * characters long. If this user role is under a subaccount, the name must - * be unique among sites of the same subaccount. Otherwise, this user role - * is a top-level user role, and the name must be unique among top-level - * user roles of the same account. - */ - name?: string; - /** - * ID of the user role that this user role is based on or copied from. This - * is a required field. - */ - parentUserRoleId?: string; - /** - * List of permissions associated with this user role. - */ - permissions?: Schema$UserRolePermission[]; - /** - * Subaccount ID of this user role. This is a read-only field that can be - * left blank. - */ - subaccountId?: string; - } - /** - * Contains properties of a user role permission. - */ - export interface Schema$UserRolePermission { - /** - * Levels of availability for a user role permission. - */ - availability?: string; - /** - * ID of this user role permission. - */ - id?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#userRolePermission". - */ - kind?: string; - /** - * Name of this user role permission. - */ - name?: string; - /** - * ID of the permission group that this user role permission belongs to. - */ - permissionGroupId?: string; - } - /** - * Represents a grouping of related user role permissions. - */ - export interface Schema$UserRolePermissionGroup { - /** - * ID of this user role permission. - */ - id?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#userRolePermissionGroup". - */ - kind?: string; - /** - * Name of this user role permission group. - */ - name?: string; - } - /** - * User Role Permission Group List Response - */ - export interface Schema$UserRolePermissionGroupsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#userRolePermissionGroupsListResponse". - */ - kind?: string; - /** - * User role permission group collection. - */ - userRolePermissionGroups?: Schema$UserRolePermissionGroup[]; - } - /** - * User Role Permission List Response - */ - export interface Schema$UserRolePermissionsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#userRolePermissionsListResponse". - */ - kind?: string; - /** - * User role permission collection. - */ - userRolePermissions?: Schema$UserRolePermission[]; - } - /** - * User Role List Response - */ - export interface Schema$UserRolesListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#userRolesListResponse". - */ - kind?: string; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string; - /** - * User role collection. - */ - userRoles?: Schema$UserRole[]; - } - /** - * Contains information about supported video formats. - */ - export interface Schema$VideoFormat { - /** - * File type of the video format. - */ - fileType?: string; - /** - * ID of the video format. - */ - id?: number; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#videoFormat". - */ - kind?: string; - /** - * The resolution of this video format. - */ - resolution?: Schema$Size; - /** - * The target bit rate of this video format. - */ - targetBitRate?: number; - } - /** - * Video Format List Response - */ - export interface Schema$VideoFormatsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#videoFormatsListResponse". - */ - kind?: string; - /** - * Video format collection. - */ - videoFormats?: Schema$VideoFormat[]; - } - /** - * Video Offset - */ - export interface Schema$VideoOffset { - /** - * Duration, as a percentage of video duration. Do not set when - * offsetSeconds is set. Acceptable values are 0 to 100, inclusive. - */ - offsetPercentage?: number; - /** - * Duration, in seconds. Do not set when offsetPercentage is set. Acceptable - * values are 0 to 86399, inclusive. - */ - offsetSeconds?: number; - } - /** - * Video Settings - */ - export interface Schema$VideoSettings { - /** - * Settings for the companion creatives of video creatives served to this - * placement. - */ - companionSettings?: Schema$CompanionSetting; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#videoSettings". - */ - kind?: string; - /** - * Settings for the skippability of video creatives served to this - * placement. If this object is provided, the creative-level skippable - * settings will be overridden. - */ - skippableSettings?: Schema$SkippableSetting; - /** - * Settings for the transcodes of video creatives served to this placement. - * If this object is provided, the creative-level transcode settings will be - * overridden. - */ - transcodeSettings?: Schema$TranscodeSetting; - } - - - export class Resource$Accountactiveadsummaries { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.accountActiveAdSummaries.get - * @desc Gets the account's active ad summary by account ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Account ID. - * summaryAccountId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.accountActiveAdSummaries.get(request, function(err, - * response) { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.accountActiveAdSummaries.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {string} params.summaryAccountId Account 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 - */ - get(params?: Params$Resource$Accountactiveadsummaries$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Accountactiveadsummaries$Get, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Accountactiveadsummaries$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Accountactiveadsummaries$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Accountactiveadsummaries$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accountactiveadsummaries$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'summaryAccountId'], - pathParams: ['profileId', 'summaryAccountId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Accountactiveadsummaries$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Account ID. - */ - summaryAccountId?: string; - } - - - export class Resource$Accountpermissiongroups { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.accountPermissionGroups.get - * @desc Gets one account permission group by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Account permission group ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.accountPermissionGroups.get(request, function(err, - * response) { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.accountPermissionGroups.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Account permission group ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Accountpermissiongroups$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Accountpermissiongroups$Get, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Accountpermissiongroups$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Accountpermissiongroups$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Accountpermissiongroups$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accountpermissiongroups$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/accountPermissionGroups/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.accountPermissionGroups.list - * @desc Retrieves the list of account permission groups. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.accountPermissionGroups.list(request, function(err, - * response) { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.accountPermissionGroups.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with 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 - */ - list( - params?: Params$Resource$Accountpermissiongroups$List, - options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Accountpermissiongroups$List, - options: MethodOptions| - BodyResponseCallback, - callback: - BodyResponseCallback): - void; - list( - params: Params$Resource$Accountpermissiongroups$List, - callback: - BodyResponseCallback): - void; - list(callback: - BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Accountpermissiongroups$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: - BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Accountpermissiongroups$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accountpermissiongroups$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/accountPermissionGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - } - - export interface Params$Resource$Accountpermissiongroups$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Account permission group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Accountpermissiongroups$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - - export class Resource$Accountpermissions { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.accountPermissions.get - * @desc Gets one account permission by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Account permission ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.accountPermissions.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.accountPermissions.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Account permission ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Accountpermissions$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Accountpermissions$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Accountpermissions$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Accountpermissions$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Accountpermissions$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accountpermissions$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/accountPermissions/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.accountPermissions.list - * @desc Retrieves the list of account permissions. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.accountPermissions.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.accountPermissions.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with 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 - */ - list( - params?: Params$Resource$Accountpermissions$List, - options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Accountpermissions$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - list( - params: Params$Resource$Accountpermissions$List, - callback: BodyResponseCallback): - void; - list(callback: BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Accountpermissions$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Accountpermissions$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accountpermissions$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/accountPermissions') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - } - - export interface Params$Resource$Accountpermissions$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Account permission ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Accountpermissions$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - - export class Resource$Accounts { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.accounts.get - * @desc Gets one account by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Account ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.accounts.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.accounts.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Account ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Accounts$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Accounts$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Accounts$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Accounts$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Accounts$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/accounts/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.accounts.list - * @desc Retrieves the list of accounts, possibly filtered. This method - * supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var accountsPage = response['accounts']; - * if (!accountsPage) { - * return; - * } - * for (var i = 0; i < accountsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `accountsPage`: console.log(JSON.stringify(accountsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.accounts.list(request, handlePage); - * } - * }; - * - * dfareporting.accounts.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.accounts.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.active Select only active accounts. Don't set this field to select both active and non-active accounts. - * @param {string=} params.ids Select only accounts with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "account*2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "account" will match objects with name "my account", "account 2015", or simply "account". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted 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 - */ - list(params?: Params$Resource$Accounts$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Accounts$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Accounts$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Accounts$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Accounts$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/accounts') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.accounts.patch - * @desc Updates an existing account. This method supports patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Account ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.accounts.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.accounts.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Account ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Account} 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 - */ - patch(params?: Params$Resource$Accounts$Patch, options?: MethodOptions): - AxiosPromise; - patch( - params: Params$Resource$Accounts$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Accounts$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Accounts$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Accounts$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/accounts') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.accounts.update - * @desc Updates an existing account. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.accounts.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.accounts.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Account} 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$Accounts$Update, options?: MethodOptions): - AxiosPromise; - update( - params: Params$Resource$Accounts$Update, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - update( - params: Params$Resource$Accounts$Update, - callback: BodyResponseCallback): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: Params$Resource$Accounts$Update| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Accounts$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/accounts') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Accounts$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Account ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Accounts$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Select only active accounts. Don't set this field to select both active - * and non-active accounts. - */ - active?: boolean; - /** - * Select only accounts with these IDs. - */ - ids?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "account*2015" will return objects with names like "account - * June 2015", "account April 2015", or simply "account 2015". Most of the - * searches also add wildcards implicitly at the start and the end of the - * search string. For example, a search string of "account" will match - * objects with name "my account", "account 2015", or simply "account". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Accounts$Patch { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Account ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Account; - } - export interface Params$Resource$Accounts$Update { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Account; - } - - - export class Resource$Accountuserprofiles { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.accountUserProfiles.get - * @desc Gets one account user profile by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // User profile ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.accountUserProfiles.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.accountUserProfiles.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id User profile ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Accountuserprofiles$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Accountuserprofiles$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Accountuserprofiles$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Accountuserprofiles$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Accountuserprofiles$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accountuserprofiles$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/accountUserProfiles/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.accountUserProfiles.insert - * @desc Inserts a new account user profile. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.accountUserProfiles.insert(request, function(err, - * response) { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.accountUserProfiles.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().AccountUserProfile} 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$Accountuserprofiles$Insert, - options?: MethodOptions): AxiosPromise; - insert( - params: Params$Resource$Accountuserprofiles$Insert, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - insert( - params: Params$Resource$Accountuserprofiles$Insert, - callback: BodyResponseCallback): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: Params$Resource$Accountuserprofiles$Insert| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Accountuserprofiles$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accountuserprofiles$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/accountUserProfiles') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.accountUserProfiles.list - * @desc Retrieves a list of account user profiles, possibly filtered. This - * method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var accountUserProfilesPage = response['accountUserProfiles']; - * if (!accountUserProfilesPage) { - * return; - * } - * for (var i = 0; i < accountUserProfilesPage.length; i++) { - * // TODO: Change code below to process each resource in - * `accountUserProfilesPage`: - * console.log(JSON.stringify(accountUserProfilesPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.accountUserProfiles.list(request, handlePage); - * } - * }; - * - * dfareporting.accountUserProfiles.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.accountUserProfiles.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.active Select only active user profiles. - * @param {string=} params.ids Select only user profiles with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "user profile*2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {string=} params.subaccountId Select only user profiles with the specified subaccount ID. - * @param {string=} params.userRoleId Select only user profiles with the specified user role 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 - */ - list( - params?: Params$Resource$Accountuserprofiles$List, - options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Accountuserprofiles$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - list( - params: Params$Resource$Accountuserprofiles$List, - callback: BodyResponseCallback): - void; - list(callback: - BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Accountuserprofiles$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: - BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Accountuserprofiles$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accountuserprofiles$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/accountUserProfiles') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * dfareporting.accountUserProfiles.patch - * @desc Updates an existing account user profile. This method supports - * patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // User profile ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.accountUserProfiles.patch(request, function(err, response) - * { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.accountUserProfiles.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id User profile ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().AccountUserProfile} 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 - */ - patch( - params?: Params$Resource$Accountuserprofiles$Patch, - options?: MethodOptions): AxiosPromise; - patch( - params: Params$Resource$Accountuserprofiles$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Accountuserprofiles$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Accountuserprofiles$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Accountuserprofiles$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accountuserprofiles$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/accountUserProfiles') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.accountUserProfiles.update - * @desc Updates an existing account user profile. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.accountUserProfiles.update(request, function(err, - * response) { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.accountUserProfiles.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().AccountUserProfile} 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$Accountuserprofiles$Update, - options?: MethodOptions): AxiosPromise; - update( - params: Params$Resource$Accountuserprofiles$Update, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - update( - params: Params$Resource$Accountuserprofiles$Update, - callback: BodyResponseCallback): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: Params$Resource$Accountuserprofiles$Update| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Accountuserprofiles$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accountuserprofiles$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/accountUserProfiles') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Accountuserprofiles$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Accountuserprofiles$Insert { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AccountUserProfile; - } - export interface Params$Resource$Accountuserprofiles$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Select only active user profiles. - */ - active?: boolean; - /** - * Select only user profiles with these IDs. - */ - ids?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name, ID or email. Wildcards (*) are - * allowed. For example, "user profile*2015" will return objects with names - * like "user profile June 2015", "user profile April 2015", or simply "user - * profile 2015". Most of the searches also add wildcards implicitly at the - * start and the end of the search string. For example, a search string of - * "user profile" will match objects with name "my user profile", "user - * profile 2015", or simply "user profile". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - /** - * Select only user profiles with the specified subaccount ID. - */ - subaccountId?: string; - /** - * Select only user profiles with the specified user role ID. - */ - userRoleId?: string; - } - export interface Params$Resource$Accountuserprofiles$Patch { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AccountUserProfile; - } - export interface Params$Resource$Accountuserprofiles$Update { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AccountUserProfile; - } - - - export class Resource$Ads { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.ads.get - * @desc Gets one ad by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Ad ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.ads.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.ads.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Ad ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Ads$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Ads$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Ads$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Ads$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Ads$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Ads$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/ads/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.ads.insert - * @desc Inserts a new ad. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.ads.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.ads.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Ad} 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$Ads$Insert, options?: MethodOptions): - AxiosPromise; - insert( - params: Params$Resource$Ads$Insert, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - insert( - params: Params$Resource$Ads$Insert, - callback: BodyResponseCallback): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: Params$Resource$Ads$Insert| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Ads$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Ads$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/dfareporting/v2.8/userprofiles/{profileId}/ads') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.ads.list - * @desc Retrieves a list of ads, possibly filtered. This method supports - * paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var adsPage = response['ads']; - * if (!adsPage) { - * return; - * } - * for (var i = 0; i < adsPage.length; i++) { - * // TODO: Change code below to process each resource in `adsPage`: - * console.log(JSON.stringify(adsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.ads.list(request, handlePage); - * } - * }; - * - * dfareporting.ads.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.ads.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.active Select only active ads. - * @param {string=} params.advertiserId Select only ads with this advertiser ID. - * @param {boolean=} params.archived Select only archived ads. - * @param {string=} params.audienceSegmentIds Select only ads with these audience segment IDs. - * @param {string=} params.campaignIds Select only ads with these campaign IDs. - * @param {string=} params.compatibility Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard. - * @param {string=} params.creativeIds Select only ads with these creative IDs assigned. - * @param {string=} params.creativeOptimizationConfigurationIds Select only ads with these creative optimization configuration IDs. - * @param {boolean=} params.dynamicClickTracker Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both. - * @param {string=} params.ids Select only ads with these IDs. - * @param {string=} params.landingPageIds Select only ads with these landing page IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.overriddenEventTagId Select only ads with this event tag override ID. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string=} params.placementIds Select only ads with these placement IDs assigned. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.remarketingListIds Select only ads whose list targeting expression use these remarketing list IDs. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "ad" will match objects with name "my ad", "ad 2015", or simply "ad". - * @param {string=} params.sizeIds Select only ads with these size IDs. - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {boolean=} params.sslCompliant Select only ads that are SSL-compliant. - * @param {boolean=} params.sslRequired Select only ads that require SSL. - * @param {string=} params.type Select only ads with these types. - * @param {object} [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$Ads$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Ads$List, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Ads$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Ads$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Ads$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Ads$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/dfareporting/v2.8/userprofiles/{profileId}/ads') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.ads.patch - * @desc Updates an existing ad. This method supports patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Ad ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.ads.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.ads.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Ad ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Ad} 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 - */ - patch(params?: Params$Resource$Ads$Patch, options?: MethodOptions): - AxiosPromise; - patch( - params: Params$Resource$Ads$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Ads$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Ads$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Ads$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Ads$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/dfareporting/v2.8/userprofiles/{profileId}/ads') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.ads.update - * @desc Updates an existing ad. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.ads.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.ads.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Ad} 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$Ads$Update, options?: MethodOptions): - AxiosPromise; - update( - params: Params$Resource$Ads$Update, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - update( - params: Params$Resource$Ads$Update, - callback: BodyResponseCallback): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: Params$Resource$Ads$Update| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Ads$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Ads$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/dfareporting/v2.8/userprofiles/{profileId}/ads') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Ads$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Ad ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Ads$Insert { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Ad; - } - export interface Params$Resource$Ads$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Select only active ads. - */ - active?: boolean; - /** - * Select only ads with this advertiser ID. - */ - advertiserId?: string; - /** - * Select only archived ads. - */ - archived?: boolean; - /** - * Select only ads with these audience segment IDs. - */ - audienceSegmentIds?: string; - /** - * Select only ads with these campaign IDs. - */ - campaignIds?: string; - /** - * Select default ads with the specified compatibility. Applicable when type - * is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to - * rendering either on desktop or on mobile devices for regular or - * interstitial ads, respectively. APP and APP_INTERSTITIAL are for - * rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an - * in-stream video ads developed with the VAST standard. - */ - compatibility?: string; - /** - * Select only ads with these creative IDs assigned. - */ - creativeIds?: string; - /** - * Select only ads with these creative optimization configuration IDs. - */ - creativeOptimizationConfigurationIds?: string; - /** - * Select only dynamic click trackers. Applicable when type is - * AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If - * false, select static click trackers. Leave unset to select both. - */ - dynamicClickTracker?: boolean; - /** - * Select only ads with these IDs. - */ - ids?: string; - /** - * Select only ads with these landing page IDs. - */ - landingPageIds?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Select only ads with this event tag override ID. - */ - overriddenEventTagId?: string; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * Select only ads with these placement IDs assigned. - */ - placementIds?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Select only ads whose list targeting expression use these remarketing - * list IDs. - */ - remarketingListIds?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "ad*2015" will return objects with names like "ad June - * 2015", "ad April 2015", or simply "ad 2015". Most of the searches also - * add wildcards implicitly at the start and the end of the search string. - * For example, a search string of "ad" will match objects with name "my - * ad", "ad 2015", or simply "ad". - */ - searchString?: string; - /** - * Select only ads with these size IDs. - */ - sizeIds?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - /** - * Select only ads that are SSL-compliant. - */ - sslCompliant?: boolean; - /** - * Select only ads that require SSL. - */ - sslRequired?: boolean; - /** - * Select only ads with these types. - */ - type?: string; - } - export interface Params$Resource$Ads$Patch { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Ad ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Ad; - } - export interface Params$Resource$Ads$Update { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Ad; - } - - - export class Resource$Advertisergroups { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.advertiserGroups.delete - * @desc Deletes an existing advertiser group. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Advertiser group ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.advertiserGroups.delete(request, function(err) { - * if (err) { - * console.error(err); - * return; - * } - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.advertiserGroups.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Advertiser group ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - delete( - params?: Params$Resource$Advertisergroups$Delete, - options?: MethodOptions): AxiosPromise; - delete( - params: Params$Resource$Advertisergroups$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( - params: Params$Resource$Advertisergroups$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: Params$Resource$Advertisergroups$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Advertisergroups$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisergroups$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/advertiserGroups/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.advertiserGroups.get - * @desc Gets one advertiser group by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Advertiser group ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.advertiserGroups.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.advertiserGroups.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Advertiser group ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Advertisergroups$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Advertisergroups$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Advertisergroups$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Advertisergroups$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Advertisergroups$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisergroups$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/advertiserGroups/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.advertiserGroups.insert - * @desc Inserts a new advertiser group. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.advertiserGroups.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.advertiserGroups.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().AdvertiserGroup} 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$Advertisergroups$Insert, - options?: MethodOptions): AxiosPromise; - insert( - params: Params$Resource$Advertisergroups$Insert, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - insert( - params: Params$Resource$Advertisergroups$Insert, - callback: BodyResponseCallback): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: Params$Resource$Advertisergroups$Insert| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Advertisergroups$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisergroups$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/advertiserGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.advertiserGroups.list - * @desc Retrieves a list of advertiser groups, possibly filtered. This - * method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var advertiserGroupsPage = response['advertiserGroups']; - * if (!advertiserGroupsPage) { - * return; - * } - * for (var i = 0; i < advertiserGroupsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `advertiserGroupsPage`: - * console.log(JSON.stringify(advertiserGroupsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.advertiserGroups.list(request, handlePage); - * } - * }; - * - * dfareporting.advertiserGroups.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.advertiserGroups.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.ids Select only advertiser groups with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted 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 - */ - list( - params?: Params$Resource$Advertisergroups$List, - options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Advertisergroups$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - list( - params: Params$Resource$Advertisergroups$List, - callback: BodyResponseCallback): - void; - list(callback: BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Advertisergroups$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Advertisergroups$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisergroups$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/advertiserGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * dfareporting.advertiserGroups.patch - * @desc Updates an existing advertiser group. This method supports patch - * semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Advertiser group ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.advertiserGroups.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.advertiserGroups.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Advertiser group ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().AdvertiserGroup} 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 - */ - patch( - params?: Params$Resource$Advertisergroups$Patch, - options?: MethodOptions): AxiosPromise; - patch( - params: Params$Resource$Advertisergroups$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Advertisergroups$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Advertisergroups$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Advertisergroups$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisergroups$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/advertiserGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.advertiserGroups.update - * @desc Updates an existing advertiser group. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.advertiserGroups.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.advertiserGroups.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().AdvertiserGroup} 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$Advertisergroups$Update, - options?: MethodOptions): AxiosPromise; - update( - params: Params$Resource$Advertisergroups$Update, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - update( - params: Params$Resource$Advertisergroups$Update, - callback: BodyResponseCallback): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: Params$Resource$Advertisergroups$Update| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Advertisergroups$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisergroups$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/advertiserGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Advertisergroups$Delete { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Advertiser group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Advertisergroups$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Advertiser group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Advertisergroups$Insert { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AdvertiserGroup; - } - export interface Params$Resource$Advertisergroups$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Select only advertiser groups with these IDs. - */ - ids?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "advertiser*2015" will return objects with names like - * "advertiser group June 2015", "advertiser group April 2015", or simply - * "advertiser group 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "advertisergroup" will match objects with name "my - * advertisergroup", "advertisergroup 2015", or simply "advertisergroup". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Advertisergroups$Patch { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Advertiser group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AdvertiserGroup; - } - export interface Params$Resource$Advertisergroups$Update { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AdvertiserGroup; - } - - - export class Resource$Advertisers { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.advertisers.get - * @desc Gets one advertiser by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Advertiser ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.advertisers.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.advertisers.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Advertiser ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Advertisers$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Advertisers$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Advertisers$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Advertisers$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Advertisers$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/advertisers/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.advertisers.insert - * @desc Inserts a new advertiser. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.advertisers.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.advertisers.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Advertiser} 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$Advertisers$Insert, - options?: MethodOptions): AxiosPromise; - insert( - params: Params$Resource$Advertisers$Insert, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - insert( - params: Params$Resource$Advertisers$Insert, - callback: BodyResponseCallback): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: Params$Resource$Advertisers$Insert| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Advertisers$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/advertisers') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.advertisers.list - * @desc Retrieves a list of advertisers, possibly filtered. This method - * supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var advertisersPage = response['advertisers']; - * if (!advertisersPage) { - * return; - * } - * for (var i = 0; i < advertisersPage.length; i++) { - * // TODO: Change code below to process each resource in - * `advertisersPage`: console.log(JSON.stringify(advertisersPage[i], null, - * 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.advertisers.list(request, handlePage); - * } - * }; - * - * dfareporting.advertisers.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.advertisers.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserGroupIds Select only advertisers with these advertiser group IDs. - * @param {string=} params.floodlightConfigurationIds Select only advertisers with these floodlight configuration IDs. - * @param {string=} params.ids Select only advertisers with these IDs. - * @param {boolean=} params.includeAdvertisersWithoutGroupsOnly Select only advertisers which do not belong to any advertiser group. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {boolean=} params.onlyParent Select only advertisers which use another advertiser's floodlight configuration. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {string=} params.status Select only advertisers with the specified status. - * @param {string=} params.subaccountId Select only advertisers with these subaccount IDs. - * @param {object} [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$Advertisers$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Advertisers$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Advertisers$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Advertisers$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Advertisers$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/advertisers') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.advertisers.patch - * @desc Updates an existing advertiser. This method supports patch - * semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Advertiser ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.advertisers.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.advertisers.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Advertiser ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Advertiser} 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 - */ - patch(params?: Params$Resource$Advertisers$Patch, options?: MethodOptions): - AxiosPromise; - patch( - params: Params$Resource$Advertisers$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Advertisers$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Advertisers$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Advertisers$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/advertisers') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.advertisers.update - * @desc Updates an existing advertiser. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.advertisers.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.advertisers.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Advertiser} 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$Advertisers$Update, - options?: MethodOptions): AxiosPromise; - update( - params: Params$Resource$Advertisers$Update, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - update( - params: Params$Resource$Advertisers$Update, - callback: BodyResponseCallback): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: Params$Resource$Advertisers$Update| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Advertisers$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/advertisers') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Advertisers$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Advertiser ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Advertisers$Insert { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Advertiser; - } - export interface Params$Resource$Advertisers$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Select only advertisers with these advertiser group IDs. - */ - advertiserGroupIds?: string; - /** - * Select only advertisers with these floodlight configuration IDs. - */ - floodlightConfigurationIds?: string; - /** - * Select only advertisers with these IDs. - */ - ids?: string; - /** - * Select only advertisers which do not belong to any advertiser group. - */ - includeAdvertisersWithoutGroupsOnly?: boolean; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Select only advertisers which use another advertiser's floodlight - * configuration. - */ - onlyParent?: boolean; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "advertiser*2015" will return objects with names like - * "advertiser June 2015", "advertiser April 2015", or simply "advertiser - * 2015". Most of the searches also add wildcards implicitly at the start - * and the end of the search string. For example, a search string of - * "advertiser" will match objects with name "my advertiser", "advertiser - * 2015", or simply "advertiser". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - /** - * Select only advertisers with the specified status. - */ - status?: string; - /** - * Select only advertisers with these subaccount IDs. - */ - subaccountId?: string; - } - export interface Params$Resource$Advertisers$Patch { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Advertiser ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Advertiser; - } - export interface Params$Resource$Advertisers$Update { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Advertiser; - } - - - export class Resource$Browsers { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.browsers.list - * @desc Retrieves a list of browsers. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.browsers.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.browsers.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with 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 - */ - list(params?: Params$Resource$Browsers$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Browsers$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Browsers$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Browsers$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Browsers$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Browsers$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/browsers') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Browsers$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - - export class Resource$Campaigncreativeassociations { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.campaignCreativeAssociations.insert - * @desc Associates a creative with the specified campaign. This method - * creates a default ad with dimensions matching the creative in the - * campaign if such a default ad does not exist already. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Campaign ID in this association. - * campaignId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.campaignCreativeAssociations.insert(request, function(err, - * response) { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.campaignCreativeAssociations.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.campaignId Campaign ID in this association. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().CampaignCreativeAssociation} 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$Campaigncreativeassociations$Insert, - options?: MethodOptions): - AxiosPromise; - insert( - params: Params$Resource$Campaigncreativeassociations$Insert, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - insert( - params: Params$Resource$Campaigncreativeassociations$Insert, - callback: BodyResponseCallback): - void; - insert(callback: BodyResponseCallback): - void; - insert( - paramsOrCallback?: Params$Resource$Campaigncreativeassociations$Insert| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Campaigncreativeassociations$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Campaigncreativeassociations$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId', 'campaignId'], - pathParams: ['campaignId', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.campaignCreativeAssociations.list - * @desc Retrieves the list of creative IDs associated with the specified - * campaign. This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Campaign ID in this association. - * campaignId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var campaignCreativeAssociationsPage = - * response['campaignCreativeAssociations']; if - * (!campaignCreativeAssociationsPage) { return; - * } - * for (var i = 0; i < campaignCreativeAssociationsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `campaignCreativeAssociationsPage`: - * console.log(JSON.stringify(campaignCreativeAssociationsPage[i], - * null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.campaignCreativeAssociations.list(request, - * handlePage); - * } - * }; - * - * dfareporting.campaignCreativeAssociations.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.campaignCreativeAssociations.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.campaignId Campaign ID in this association. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.sortOrder Order of sorted 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 - */ - list( - params?: Params$Resource$Campaigncreativeassociations$List, - options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Campaigncreativeassociations$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback< - Schema$CampaignCreativeAssociationsListResponse>): void; - list( - params: Params$Resource$Campaigncreativeassociations$List, - callback: BodyResponseCallback< - Schema$CampaignCreativeAssociationsListResponse>): void; - list(callback: BodyResponseCallback< - Schema$CampaignCreativeAssociationsListResponse>): void; - list( - paramsOrCallback?: Params$Resource$Campaigncreativeassociations$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$CampaignCreativeAssociationsListResponse>): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Campaigncreativeassociations$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Campaigncreativeassociations$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'campaignId'], - pathParams: ['campaignId', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest< - Schema$CampaignCreativeAssociationsListResponse>(parameters); - } - } - } - - export interface Params$Resource$Campaigncreativeassociations$Insert { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Campaign ID in this association. - */ - campaignId?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CampaignCreativeAssociation; - } - export interface Params$Resource$Campaigncreativeassociations$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Campaign ID in this association. - */ - campaignId?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - - - export class Resource$Campaigns { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.campaigns.get - * @desc Gets one campaign by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Campaign ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.campaigns.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.campaigns.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Campaign ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Campaigns$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Campaigns$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Campaigns$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Campaigns$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Campaigns$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Campaigns$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/campaigns/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.campaigns.insert - * @desc Inserts a new campaign. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Default landing page name for this new campaign. Must be less than - * 256 characters long. defaultLandingPageName: '', // TODO: Update - * placeholder value. - * - * // Default landing page URL for this new campaign. - * defaultLandingPageUrl: '', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.campaigns.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.campaigns.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.defaultLandingPageName Default landing page name for this new campaign. Must be less than 256 characters long. - * @param {string} params.defaultLandingPageUrl Default landing page URL for this new campaign. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Campaign} 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$Campaigns$Insert, options?: MethodOptions): - AxiosPromise; - insert( - params: Params$Resource$Campaigns$Insert, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - insert( - params: Params$Resource$Campaigns$Insert, - callback: BodyResponseCallback): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: Params$Resource$Campaigns$Insert| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Campaigns$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Campaigns$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/campaigns') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: - ['profileId', 'defaultLandingPageName', 'defaultLandingPageUrl'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.campaigns.list - * @desc Retrieves a list of campaigns, possibly filtered. This method - * supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var campaignsPage = response['campaigns']; - * if (!campaignsPage) { - * return; - * } - * for (var i = 0; i < campaignsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `campaignsPage`: console.log(JSON.stringify(campaignsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.campaigns.list(request, handlePage); - * } - * }; - * - * dfareporting.campaigns.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.campaigns.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserGroupIds Select only campaigns whose advertisers belong to these advertiser groups. - * @param {string=} params.advertiserIds Select only campaigns that belong to these advertisers. - * @param {boolean=} params.archived Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns. - * @param {boolean=} params.atLeastOneOptimizationActivity Select only campaigns that have at least one optimization activity. - * @param {string=} params.excludedIds Exclude campaigns with these IDs. - * @param {string=} params.ids Select only campaigns with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.overriddenEventTagId Select only campaigns that have overridden this event tag ID. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, "campaign*2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {string=} params.subaccountId Select only campaigns that belong to this subaccount. - * @param {object} [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$Campaigns$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Campaigns$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Campaigns$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Campaigns$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Campaigns$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Campaigns$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/campaigns') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.campaigns.patch - * @desc Updates an existing campaign. This method supports patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Campaign ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.campaigns.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.campaigns.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Campaign ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Campaign} 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 - */ - patch(params?: Params$Resource$Campaigns$Patch, options?: MethodOptions): - AxiosPromise; - patch( - params: Params$Resource$Campaigns$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Campaigns$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Campaigns$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Campaigns$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Campaigns$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/campaigns') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.campaigns.update - * @desc Updates an existing campaign. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.campaigns.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.campaigns.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Campaign} 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$Campaigns$Update, options?: MethodOptions): - AxiosPromise; - update( - params: Params$Resource$Campaigns$Update, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - update( - params: Params$Resource$Campaigns$Update, - callback: BodyResponseCallback): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: Params$Resource$Campaigns$Update| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Campaigns$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Campaigns$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/campaigns') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Campaigns$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Campaign ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Campaigns$Insert { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Default landing page name for this new campaign. Must be less than 256 - * characters long. - */ - defaultLandingPageName?: string; - /** - * Default landing page URL for this new campaign. - */ - defaultLandingPageUrl?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Campaign; - } - export interface Params$Resource$Campaigns$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Select only campaigns whose advertisers belong to these advertiser - * groups. - */ - advertiserGroupIds?: string; - /** - * Select only campaigns that belong to these advertisers. - */ - advertiserIds?: string; - /** - * Select only archived campaigns. Don't set this field to select both - * archived and non-archived campaigns. - */ - archived?: boolean; - /** - * Select only campaigns that have at least one optimization activity. - */ - atLeastOneOptimizationActivity?: boolean; - /** - * Exclude campaigns with these IDs. - */ - excludedIds?: string; - /** - * Select only campaigns with these IDs. - */ - ids?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Select only campaigns that have overridden this event tag ID. - */ - overriddenEventTagId?: string; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for campaigns by name or ID. Wildcards (*) are allowed. - * For example, "campaign*2015" will return campaigns with names like - * "campaign June 2015", "campaign April 2015", or simply "campaign 2015". - * Most of the searches also add wildcards implicitly at the start and the - * end of the search string. For example, a search string of "campaign" will - * match campaigns with name "my campaign", "campaign 2015", or simply - * "campaign". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - /** - * Select only campaigns that belong to this subaccount. - */ - subaccountId?: string; - } - export interface Params$Resource$Campaigns$Patch { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Campaign ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Campaign; - } - export interface Params$Resource$Campaigns$Update { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Campaign; - } - - - export class Resource$Changelogs { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.changeLogs.get - * @desc Gets one change log by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Change log ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.changeLogs.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.changeLogs.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Change log ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Changelogs$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Changelogs$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Changelogs$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Changelogs$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Changelogs$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Changelogs$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/changeLogs/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.changeLogs.list - * @desc Retrieves a list of change logs. This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var changeLogsPage = response['changeLogs']; - * if (!changeLogsPage) { - * return; - * } - * for (var i = 0; i < changeLogsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `changeLogsPage`: console.log(JSON.stringify(changeLogsPage[i], null, - * 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.changeLogs.list(request, handlePage); - * } - * }; - * - * dfareporting.changeLogs.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.changeLogs.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.action Select only change logs with the specified action. - * @param {string=} params.ids Select only change logs with these IDs. - * @param {string=} params.maxChangeTime Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.minChangeTime Select only change logs whose change time is before the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset. - * @param {string=} params.objectIds Select only change logs with these object IDs. - * @param {string=} params.objectType Select only change logs with the specified object type. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Select only change logs whose object ID, user name, old or new values match the search string. - * @param {string=} params.userProfileIds Select only change logs with these user profile IDs. - * @param {object} [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$Changelogs$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Changelogs$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Changelogs$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Changelogs$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Changelogs$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Changelogs$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/changeLogs') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Changelogs$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Change log ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Changelogs$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Select only change logs with the specified action. - */ - action?: string; - /** - * Select only change logs with these IDs. - */ - ids?: string; - /** - * Select only change logs whose change time is before the specified - * maxChangeTime.The time should be formatted as an RFC3339 date/time - * string. For example, for 10:54 PM on July 18th, 2015, in the America/New - * York time zone, the format is "2015-07-18T22:54:00-04:00". In other - * words, the year, month, day, the letter T, the hour (24-hour clock - * system), minute, second, and then the time zone offset. - */ - maxChangeTime?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Select only change logs whose change time is before the specified - * minChangeTime.The time should be formatted as an RFC3339 date/time - * string. For example, for 10:54 PM on July 18th, 2015, in the America/New - * York time zone, the format is "2015-07-18T22:54:00-04:00". In other - * words, the year, month, day, the letter T, the hour (24-hour clock - * system), minute, second, and then the time zone offset. - */ - minChangeTime?: string; - /** - * Select only change logs with these object IDs. - */ - objectIds?: string; - /** - * Select only change logs with the specified object type. - */ - objectType?: string; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Select only change logs whose object ID, user name, old or new values - * match the search string. - */ - searchString?: string; - /** - * Select only change logs with these user profile IDs. - */ - userProfileIds?: string; - } - - - export class Resource$Cities { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.cities.list - * @desc Retrieves a list of cities, possibly filtered. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.cities.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.cities.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.countryDartIds Select only cities from these countries. - * @param {string=} params.dartIds Select only cities with these DART IDs. - * @param {string=} params.namePrefix Select only cities with names starting with this prefix. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.regionDartIds Select only cities from these regions. - * @param {object} [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$Cities$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Cities$List, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Cities$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Cities$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Cities$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Cities$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/cities') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Cities$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Select only cities from these countries. - */ - countryDartIds?: string; - /** - * Select only cities with these DART IDs. - */ - dartIds?: string; - /** - * Select only cities with names starting with this prefix. - */ - namePrefix?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Select only cities from these regions. - */ - regionDartIds?: string; - } - - - export class Resource$Connectiontypes { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.connectionTypes.get - * @desc Gets one connection type by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Connection type ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.connectionTypes.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.connectionTypes.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Connection type ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Connectiontypes$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Connectiontypes$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Connectiontypes$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Connectiontypes$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Connectiontypes$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Connectiontypes$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/connectionTypes/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.connectionTypes.list - * @desc Retrieves a list of connection types. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.connectionTypes.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.connectionTypes.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with 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 - */ - list( - params?: Params$Resource$Connectiontypes$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Connectiontypes$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - list( - params: Params$Resource$Connectiontypes$List, - callback: BodyResponseCallback): - void; - list(callback: BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Connectiontypes$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Connectiontypes$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Connectiontypes$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/connectionTypes') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Connectiontypes$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Connection type ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Connectiontypes$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - - export class Resource$Contentcategories { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.contentCategories.delete - * @desc Deletes an existing content category. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Content category ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.contentCategories.delete(request, function(err) { - * if (err) { - * console.error(err); - * return; - * } - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.contentCategories.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Content category ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - delete( - params?: Params$Resource$Contentcategories$Delete, - options?: MethodOptions): AxiosPromise; - delete( - params: Params$Resource$Contentcategories$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( - params: Params$Resource$Contentcategories$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: Params$Resource$Contentcategories$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Contentcategories$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Contentcategories$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/contentCategories/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.contentCategories.get - * @desc Gets one content category by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Content category ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.contentCategories.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.contentCategories.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Content category ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Contentcategories$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Contentcategories$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Contentcategories$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Contentcategories$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Contentcategories$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Contentcategories$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/contentCategories/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.contentCategories.insert - * @desc Inserts a new content category. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.contentCategories.insert(request, function(err, response) - * { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.contentCategories.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().ContentCategory} 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$Contentcategories$Insert, - options?: MethodOptions): AxiosPromise; - insert( - params: Params$Resource$Contentcategories$Insert, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - insert( - params: Params$Resource$Contentcategories$Insert, - callback: BodyResponseCallback): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: Params$Resource$Contentcategories$Insert| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Contentcategories$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Contentcategories$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/contentCategories') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.contentCategories.list - * @desc Retrieves a list of content categories, possibly filtered. This - * method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var contentCategoriesPage = response['contentCategories']; - * if (!contentCategoriesPage) { - * return; - * } - * for (var i = 0; i < contentCategoriesPage.length; i++) { - * // TODO: Change code below to process each resource in - * `contentCategoriesPage`: - * console.log(JSON.stringify(contentCategoriesPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.contentCategories.list(request, handlePage); - * } - * }; - * - * dfareporting.contentCategories.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.contentCategories.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.ids Select only content categories with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "contentcategory*2015" will return objects with names like "contentcategory June 2015", "contentcategory April 2015", or simply "contentcategory 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "contentcategory" will match objects with name "my contentcategory", "contentcategory 2015", or simply "contentcategory". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted 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 - */ - list( - params?: Params$Resource$Contentcategories$List, - options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Contentcategories$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - list( - params: Params$Resource$Contentcategories$List, - callback: BodyResponseCallback): - void; - list(callback: BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Contentcategories$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Contentcategories$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Contentcategories$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/contentCategories') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * dfareporting.contentCategories.patch - * @desc Updates an existing content category. This method supports patch - * semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Content category ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.contentCategories.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.contentCategories.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Content category ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().ContentCategory} 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 - */ - patch( - params?: Params$Resource$Contentcategories$Patch, - options?: MethodOptions): AxiosPromise; - patch( - params: Params$Resource$Contentcategories$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Contentcategories$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Contentcategories$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Contentcategories$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Contentcategories$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/contentCategories') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.contentCategories.update - * @desc Updates an existing content category. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.contentCategories.update(request, function(err, response) - * { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.contentCategories.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().ContentCategory} 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$Contentcategories$Update, - options?: MethodOptions): AxiosPromise; - update( - params: Params$Resource$Contentcategories$Update, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - update( - params: Params$Resource$Contentcategories$Update, - callback: BodyResponseCallback): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: Params$Resource$Contentcategories$Update| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Contentcategories$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Contentcategories$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/contentCategories') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Contentcategories$Delete { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Content category ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Contentcategories$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Content category ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Contentcategories$Insert { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ContentCategory; - } - export interface Params$Resource$Contentcategories$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Select only content categories with these IDs. - */ - ids?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "contentcategory*2015" will return objects with names like - * "contentcategory June 2015", "contentcategory April 2015", or simply - * "contentcategory 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "contentcategory" will match objects with name "my - * contentcategory", "contentcategory 2015", or simply "contentcategory". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Contentcategories$Patch { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Content category ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ContentCategory; - } - export interface Params$Resource$Contentcategories$Update { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ContentCategory; - } - - - export class Resource$Conversions { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.conversions.batchinsert - * @desc Inserts conversions. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.conversions.batchinsert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/ddmconversions' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.conversions.batchinsert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().ConversionsBatchInsertRequest} 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 - */ - batchinsert( - params?: Params$Resource$Conversions$Batchinsert, - options?: MethodOptions): - AxiosPromise; - batchinsert( - params: Params$Resource$Conversions$Batchinsert, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - batchinsert( - params: Params$Resource$Conversions$Batchinsert, - callback: BodyResponseCallback): - void; - batchinsert( - callback: BodyResponseCallback): - void; - batchinsert( - paramsOrCallback?: Params$Resource$Conversions$Batchinsert| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Conversions$Batchinsert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Conversions$Batchinsert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/conversions/batchinsert') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * dfareporting.conversions.batchupdate - * @desc Updates existing conversions. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.conversions.batchupdate(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/ddmconversions' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.conversions.batchupdate - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().ConversionsBatchUpdateRequest} 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 - */ - batchupdate( - params?: Params$Resource$Conversions$Batchupdate, - options?: MethodOptions): - AxiosPromise; - batchupdate( - params: Params$Resource$Conversions$Batchupdate, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - batchupdate( - params: Params$Resource$Conversions$Batchupdate, - callback: BodyResponseCallback): - void; - batchupdate( - callback: BodyResponseCallback): - void; - batchupdate( - paramsOrCallback?: Params$Resource$Conversions$Batchupdate| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Conversions$Batchupdate; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Conversions$Batchupdate; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/conversions/batchupdate') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - } - - export interface Params$Resource$Conversions$Batchinsert { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ConversionsBatchInsertRequest; - } - export interface Params$Resource$Conversions$Batchupdate { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ConversionsBatchUpdateRequest; - } - - - export class Resource$Countries { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.countries.get - * @desc Gets one country by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Country DART ID. - * dartId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.countries.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.countries.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.dartId Country DART ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Countries$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Countries$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Countries$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Countries$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Countries$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Countries$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/countries/{dartId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'dartId'], - pathParams: ['dartId', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.countries.list - * @desc Retrieves a list of countries. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.countries.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.countries.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with 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 - */ - list(params?: Params$Resource$Countries$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Countries$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Countries$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Countries$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Countries$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Countries$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/countries') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Countries$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Country DART ID. - */ - dartId?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Countries$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - - export class Resource$Creativeassets { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.creativeAssets.insert - * @desc Inserts a new creative asset. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Advertiser ID of this creative. This is a required field. - * advertiserId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * media: { - * // TODO: Add desired media content for upload. See - * // https://github.com/google/google-api-nodejs-client#media-uploads - * mimeType: '', // See - * https://www.w3.org/Protocols/rfc1341/4_Content-Type.html body: '', - * }, - * - * auth: authClient, - * }; - * - * dfareporting.creativeAssets.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeAssets.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.advertiserId Advertiser ID of this creative. This is a required field. - * @param {string} params.profileId User profile ID associated with this request. - * @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 {callback} callback The callback that handles the response. - * @return {object} Request object - */ - insert( - params?: Params$Resource$Creativeassets$Insert, - options?: MethodOptions): AxiosPromise; - insert( - params: Params$Resource$Creativeassets$Insert, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - insert( - params: Params$Resource$Creativeassets$Insert, - callback: BodyResponseCallback): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: Params$Resource$Creativeassets$Insert| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Creativeassets$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativeassets$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - mediaUrl: - (rootUrl + - '/upload/dfareporting/v2.8/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets') - .replace(/([^:]\/)\/+/g, '$1'), - requiredParams: ['profileId', 'advertiserId'], - pathParams: ['advertiserId', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Creativeassets$Insert { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Advertiser ID of this creative. This is a required field. - */ - advertiserId?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreativeAssetMetadata; - - /** - * Media metadata - */ - media?: { - /** - * Media mime-type - */ - mediaType?: string; - - /** - * Media body contents - */ - body?: any; - }; - } - - - export class Resource$Creativefields { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.creativeFields.delete - * @desc Deletes an existing creative field. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Creative Field ID - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.creativeFields.delete(request, function(err) { - * if (err) { - * console.error(err); - * return; - * } - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeFields.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Creative Field ID - * @param {string} params.profileId User profile ID associated with 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 - */ - delete( - params?: Params$Resource$Creativefields$Delete, - options?: MethodOptions): AxiosPromise; - delete( - params: Params$Resource$Creativefields$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( - params: Params$Resource$Creativefields$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: Params$Resource$Creativefields$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Creativefields$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefields$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/creativeFields/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.creativeFields.get - * @desc Gets one creative field by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Creative Field ID - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.creativeFields.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeFields.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Creative Field ID - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Creativefields$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Creativefields$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Creativefields$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Creativefields$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Creativefields$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefields$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/creativeFields/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.creativeFields.insert - * @desc Inserts a new creative field. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.creativeFields.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeFields.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().CreativeField} 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$Creativefields$Insert, - options?: MethodOptions): AxiosPromise; - insert( - params: Params$Resource$Creativefields$Insert, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - insert( - params: Params$Resource$Creativefields$Insert, - callback: BodyResponseCallback): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: Params$Resource$Creativefields$Insert| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Creativefields$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefields$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/creativeFields') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.creativeFields.list - * @desc Retrieves a list of creative fields, possibly filtered. This method - * supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var creativeFieldsPage = response['creativeFields']; - * if (!creativeFieldsPage) { - * return; - * } - * for (var i = 0; i < creativeFieldsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `creativeFieldsPage`: console.log(JSON.stringify(creativeFieldsPage[i], - * null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.creativeFields.list(request, handlePage); - * } - * }; - * - * dfareporting.creativeFields.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeFields.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserIds Select only creative fields that belong to these advertisers. - * @param {string=} params.ids Select only creative fields with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, "creativefield*2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted 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 - */ - list(params?: Params$Resource$Creativefields$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Creativefields$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - list( - params: Params$Resource$Creativefields$List, - callback: BodyResponseCallback): - void; - list(callback: BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Creativefields$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Creativefields$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefields$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/creativeFields') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.creativeFields.patch - * @desc Updates an existing creative field. This method supports patch - * semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Creative Field ID - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.creativeFields.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeFields.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Creative Field ID - * @param {string} params.profileId User profile ID associated with this request. - * @param {().CreativeField} 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 - */ - patch( - params?: Params$Resource$Creativefields$Patch, - options?: MethodOptions): AxiosPromise; - patch( - params: Params$Resource$Creativefields$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Creativefields$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Creativefields$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Creativefields$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefields$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/creativeFields') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.creativeFields.update - * @desc Updates an existing creative field. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.creativeFields.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeFields.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().CreativeField} 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$Creativefields$Update, - options?: MethodOptions): AxiosPromise; - update( - params: Params$Resource$Creativefields$Update, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - update( - params: Params$Resource$Creativefields$Update, - callback: BodyResponseCallback): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: Params$Resource$Creativefields$Update| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Creativefields$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefields$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/creativeFields') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Creativefields$Delete { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Creative Field ID - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Creativefields$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Creative Field ID - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Creativefields$Insert { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreativeField; - } - export interface Params$Resource$Creativefields$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Select only creative fields that belong to these advertisers. - */ - advertiserIds?: string; - /** - * Select only creative fields with these IDs. - */ - ids?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for creative fields by name or ID. Wildcards (*) are - * allowed. For example, "creativefield*2015" will return creative fields - * with names like "creativefield June 2015", "creativefield April 2015", or - * simply "creativefield 2015". Most of the searches also add wild-cards - * implicitly at the start and the end of the search string. For example, a - * search string of "creativefield" will match creative fields with the name - * "my creativefield", "creativefield 2015", or simply "creativefield". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Creativefields$Patch { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Creative Field ID - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreativeField; - } - export interface Params$Resource$Creativefields$Update { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreativeField; - } - - - export class Resource$Creativefieldvalues { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.creativeFieldValues.delete - * @desc Deletes an existing creative field value. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Creative field ID for this creative field value. - * creativeFieldId: '0', // TODO: Update placeholder value. - * - * // Creative Field Value ID - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.creativeFieldValues.delete(request, function(err) { - * if (err) { - * console.error(err); - * return; - * } - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeFieldValues.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.creativeFieldId Creative field ID for this creative field value. - * @param {string} params.id Creative Field Value ID - * @param {string} params.profileId User profile ID associated with 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 - */ - delete( - params?: Params$Resource$Creativefieldvalues$Delete, - options?: MethodOptions): AxiosPromise; - delete( - params: Params$Resource$Creativefieldvalues$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( - params: Params$Resource$Creativefieldvalues$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: Params$Resource$Creativefieldvalues$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Creativefieldvalues$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefieldvalues$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['profileId', 'creativeFieldId', 'id'], - pathParams: ['creativeFieldId', 'id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.creativeFieldValues.get - * @desc Gets one creative field value by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Creative field ID for this creative field value. - * creativeFieldId: '0', // TODO: Update placeholder value. - * - * // Creative Field Value ID - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.creativeFieldValues.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeFieldValues.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.creativeFieldId Creative field ID for this creative field value. - * @param {string} params.id Creative Field Value ID - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Creativefieldvalues$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Creativefieldvalues$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Creativefieldvalues$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Creativefieldvalues$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Creativefieldvalues$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefieldvalues$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'creativeFieldId', 'id'], - pathParams: ['creativeFieldId', 'id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.creativeFieldValues.insert - * @desc Inserts a new creative field value. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Creative field ID for this creative field value. - * creativeFieldId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.creativeFieldValues.insert(request, function(err, - * response) { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeFieldValues.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.creativeFieldId Creative field ID for this creative field value. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().CreativeFieldValue} 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$Creativefieldvalues$Insert, - options?: MethodOptions): AxiosPromise; - insert( - params: Params$Resource$Creativefieldvalues$Insert, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - insert( - params: Params$Resource$Creativefieldvalues$Insert, - callback: BodyResponseCallback): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: Params$Resource$Creativefieldvalues$Insert| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Creativefieldvalues$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefieldvalues$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId', 'creativeFieldId'], - pathParams: ['creativeFieldId', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.creativeFieldValues.list - * @desc Retrieves a list of creative field values, possibly filtered. This - * method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Creative field ID for this creative field value. - * creativeFieldId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var creativeFieldValuesPage = response['creativeFieldValues']; - * if (!creativeFieldValuesPage) { - * return; - * } - * for (var i = 0; i < creativeFieldValuesPage.length; i++) { - * // TODO: Change code below to process each resource in - * `creativeFieldValuesPage`: - * console.log(JSON.stringify(creativeFieldValuesPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.creativeFieldValues.list(request, handlePage); - * } - * }; - * - * dfareporting.creativeFieldValues.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeFieldValues.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.creativeFieldId Creative field ID for this creative field value. - * @param {string=} params.ids Select only creative field values with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed. - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted 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 - */ - list( - params?: Params$Resource$Creativefieldvalues$List, - options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Creativefieldvalues$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - list( - params: Params$Resource$Creativefieldvalues$List, - callback: BodyResponseCallback): - void; - list(callback: - BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Creativefieldvalues$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: - BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Creativefieldvalues$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefieldvalues$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'creativeFieldId'], - pathParams: ['creativeFieldId', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * dfareporting.creativeFieldValues.patch - * @desc Updates an existing creative field value. This method supports - * patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Creative field ID for this creative field value. - * creativeFieldId: '0', // TODO: Update placeholder value. - * - * // Creative Field Value ID - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.creativeFieldValues.patch(request, function(err, response) - * { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeFieldValues.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.creativeFieldId Creative field ID for this creative field value. - * @param {string} params.id Creative Field Value ID - * @param {string} params.profileId User profile ID associated with this request. - * @param {().CreativeFieldValue} 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 - */ - patch( - params?: Params$Resource$Creativefieldvalues$Patch, - options?: MethodOptions): AxiosPromise; - patch( - params: Params$Resource$Creativefieldvalues$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Creativefieldvalues$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Creativefieldvalues$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Creativefieldvalues$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefieldvalues$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'creativeFieldId', 'id'], - pathParams: ['creativeFieldId', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.creativeFieldValues.update - * @desc Updates an existing creative field value. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Creative field ID for this creative field value. - * creativeFieldId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.creativeFieldValues.update(request, function(err, - * response) { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeFieldValues.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.creativeFieldId Creative field ID for this creative field value. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().CreativeFieldValue} 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$Creativefieldvalues$Update, - options?: MethodOptions): AxiosPromise; - update( - params: Params$Resource$Creativefieldvalues$Update, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - update( - params: Params$Resource$Creativefieldvalues$Update, - callback: BodyResponseCallback): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: Params$Resource$Creativefieldvalues$Update| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Creativefieldvalues$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefieldvalues$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId', 'creativeFieldId'], - pathParams: ['creativeFieldId', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Creativefieldvalues$Delete { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Creative field ID for this creative field value. - */ - creativeFieldId?: string; - /** - * Creative Field Value ID - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Creativefieldvalues$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Creative field ID for this creative field value. - */ - creativeFieldId?: string; - /** - * Creative Field Value ID - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Creativefieldvalues$Insert { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Creative field ID for this creative field value. - */ - creativeFieldId?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreativeFieldValue; - } - export interface Params$Resource$Creativefieldvalues$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Creative field ID for this creative field value. - */ - creativeFieldId?: string; - /** - * Select only creative field values with these IDs. - */ - ids?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for creative field values by their values. Wildcards - * (e.g. *) are not allowed. - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Creativefieldvalues$Patch { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Creative field ID for this creative field value. - */ - creativeFieldId?: string; - /** - * Creative Field Value ID - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreativeFieldValue; - } - export interface Params$Resource$Creativefieldvalues$Update { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Creative field ID for this creative field value. - */ - creativeFieldId?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreativeFieldValue; - } - - - export class Resource$Creativegroups { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.creativeGroups.get - * @desc Gets one creative group by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Creative group ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.creativeGroups.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeGroups.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Creative group ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Creativegroups$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Creativegroups$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Creativegroups$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Creativegroups$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Creativegroups$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativegroups$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/creativeGroups/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.creativeGroups.insert - * @desc Inserts a new creative group. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.creativeGroups.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeGroups.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().CreativeGroup} 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$Creativegroups$Insert, - options?: MethodOptions): AxiosPromise; - insert( - params: Params$Resource$Creativegroups$Insert, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - insert( - params: Params$Resource$Creativegroups$Insert, - callback: BodyResponseCallback): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: Params$Resource$Creativegroups$Insert| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Creativegroups$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativegroups$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/creativeGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.creativeGroups.list - * @desc Retrieves a list of creative groups, possibly filtered. This method - * supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var creativeGroupsPage = response['creativeGroups']; - * if (!creativeGroupsPage) { - * return; - * } - * for (var i = 0; i < creativeGroupsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `creativeGroupsPage`: console.log(JSON.stringify(creativeGroupsPage[i], - * null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.creativeGroups.list(request, handlePage); - * } - * }; - * - * dfareporting.creativeGroups.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeGroups.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserIds Select only creative groups that belong to these advertisers. - * @param {integer=} params.groupNumber Select only creative groups that belong to this subgroup. - * @param {string=} params.ids Select only creative groups with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, "creativegroup*2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted 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 - */ - list(params?: Params$Resource$Creativegroups$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Creativegroups$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - list( - params: Params$Resource$Creativegroups$List, - callback: BodyResponseCallback): - void; - list(callback: BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Creativegroups$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Creativegroups$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativegroups$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/creativeGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.creativeGroups.patch - * @desc Updates an existing creative group. This method supports patch - * semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Creative group ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.creativeGroups.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeGroups.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Creative group ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().CreativeGroup} 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 - */ - patch( - params?: Params$Resource$Creativegroups$Patch, - options?: MethodOptions): AxiosPromise; - patch( - params: Params$Resource$Creativegroups$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Creativegroups$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Creativegroups$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Creativegroups$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativegroups$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/creativeGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.creativeGroups.update - * @desc Updates an existing creative group. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.creativeGroups.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeGroups.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().CreativeGroup} 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$Creativegroups$Update, - options?: MethodOptions): AxiosPromise; - update( - params: Params$Resource$Creativegroups$Update, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - update( - params: Params$Resource$Creativegroups$Update, - callback: BodyResponseCallback): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: Params$Resource$Creativegroups$Update| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Creativegroups$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativegroups$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/creativeGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Creativegroups$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Creative group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Creativegroups$Insert { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreativeGroup; - } - export interface Params$Resource$Creativegroups$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Select only creative groups that belong to these advertisers. - */ - advertiserIds?: string; - /** - * Select only creative groups that belong to this subgroup. - */ - groupNumber?: number; - /** - * Select only creative groups with these IDs. - */ - ids?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for creative groups by name or ID. Wildcards (*) are - * allowed. For example, "creativegroup*2015" will return creative groups - * with names like "creativegroup June 2015", "creativegroup April 2015", or - * simply "creativegroup 2015". Most of the searches also add wild-cards - * implicitly at the start and the end of the search string. For example, a - * search string of "creativegroup" will match creative groups with the name - * "my creativegroup", "creativegroup 2015", or simply "creativegroup". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Creativegroups$Patch { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Creative group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreativeGroup; - } - export interface Params$Resource$Creativegroups$Update { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreativeGroup; - } - - - export class Resource$Creatives { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.creatives.get - * @desc Gets one creative by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Creative ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.creatives.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creatives.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Creative ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Creatives$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Creatives$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Creatives$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Creatives$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Creatives$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creatives$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/creatives/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.creatives.insert - * @desc Inserts a new creative. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.creatives.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creatives.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Creative} 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$Creatives$Insert, options?: MethodOptions): - AxiosPromise; - insert( - params: Params$Resource$Creatives$Insert, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - insert( - params: Params$Resource$Creatives$Insert, - callback: BodyResponseCallback): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: Params$Resource$Creatives$Insert| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Creatives$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creatives$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/creatives') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.creatives.list - * @desc Retrieves a list of creatives, possibly filtered. This method - * supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var creativesPage = response['creatives']; - * if (!creativesPage) { - * return; - * } - * for (var i = 0; i < creativesPage.length; i++) { - * // TODO: Change code below to process each resource in - * `creativesPage`: console.log(JSON.stringify(creativesPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.creatives.list(request, handlePage); - * } - * }; - * - * dfareporting.creatives.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creatives.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.active Select only active creatives. Leave blank to select active and inactive creatives. - * @param {string=} params.advertiserId Select only creatives with this advertiser ID. - * @param {boolean=} params.archived Select only archived creatives. Leave blank to select archived and unarchived creatives. - * @param {string=} params.campaignId Select only creatives with this campaign ID. - * @param {string=} params.companionCreativeIds Select only in-stream video creatives with these companion IDs. - * @param {string=} params.creativeFieldIds Select only creatives with these creative field IDs. - * @param {string=} params.ids Select only creatives with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.renderingIds Select only creatives with these rendering IDs. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "creative*2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "creative" will match objects with name "my creative", "creative 2015", or simply "creative". - * @param {string=} params.sizeIds Select only creatives with these size IDs. - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {string=} params.studioCreativeId Select only creatives corresponding to this Studio creative ID. - * @param {string=} params.types Select only creatives with these creative types. - * @param {object} [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$Creatives$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Creatives$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Creatives$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Creatives$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Creatives$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creatives$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/creatives') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.creatives.patch - * @desc Updates an existing creative. This method supports patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Creative ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.creatives.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creatives.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Creative ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Creative} 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 - */ - patch(params?: Params$Resource$Creatives$Patch, options?: MethodOptions): - AxiosPromise; - patch( - params: Params$Resource$Creatives$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Creatives$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Creatives$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Creatives$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creatives$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/creatives') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.creatives.update - * @desc Updates an existing creative. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.creatives.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creatives.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Creative} 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$Creatives$Update, options?: MethodOptions): - AxiosPromise; - update( - params: Params$Resource$Creatives$Update, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - update( - params: Params$Resource$Creatives$Update, - callback: BodyResponseCallback): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: Params$Resource$Creatives$Update| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Creatives$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creatives$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/creatives') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Creatives$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Creative ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Creatives$Insert { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Creative; - } - export interface Params$Resource$Creatives$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Select only active creatives. Leave blank to select active and inactive - * creatives. - */ - active?: boolean; - /** - * Select only creatives with this advertiser ID. - */ - advertiserId?: string; - /** - * Select only archived creatives. Leave blank to select archived and - * unarchived creatives. - */ - archived?: boolean; - /** - * Select only creatives with this campaign ID. - */ - campaignId?: string; - /** - * Select only in-stream video creatives with these companion IDs. - */ - companionCreativeIds?: string; - /** - * Select only creatives with these creative field IDs. - */ - creativeFieldIds?: string; - /** - * Select only creatives with these IDs. - */ - ids?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Select only creatives with these rendering IDs. - */ - renderingIds?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "creative*2015" will return objects with names like - * "creative June 2015", "creative April 2015", or simply "creative 2015". - * Most of the searches also add wildcards implicitly at the start and the - * end of the search string. For example, a search string of "creative" will - * match objects with name "my creative", "creative 2015", or simply - * "creative". - */ - searchString?: string; - /** - * Select only creatives with these size IDs. - */ - sizeIds?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - /** - * Select only creatives corresponding to this Studio creative ID. - */ - studioCreativeId?: string; - /** - * Select only creatives with these creative types. - */ - types?: string; - } - export interface Params$Resource$Creatives$Patch { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Creative ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Creative; - } - export interface Params$Resource$Creatives$Update { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Creative; - } - - - export class Resource$Dimensionvalues { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.dimensionValues.query - * @desc Retrieves list of report dimension values for a list of filters. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // The DFA user profile ID. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var itemsPage = response['items']; - * if (!itemsPage) { - * return; - * } - * for (var i = 0; i < itemsPage.length; i++) { - * // TODO: Change code below to process each resource in `itemsPage`: - * console.log(JSON.stringify(itemsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.dimensionValues.query(request, handlePage); - * } - * }; - * - * dfareporting.dimensionValues.query(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfareporting' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.dimensionValues.query - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken The value of the nextToken from the previous result page. - * @param {string} params.profileId The DFA user profile ID. - * @param {().DimensionValueRequest} 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 - */ - query( - params?: Params$Resource$Dimensionvalues$Query, - options?: MethodOptions): AxiosPromise; - query( - params: Params$Resource$Dimensionvalues$Query, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - query( - params: Params$Resource$Dimensionvalues$Query, - callback: BodyResponseCallback): void; - query(callback: BodyResponseCallback): void; - query( - paramsOrCallback?: Params$Resource$Dimensionvalues$Query| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Dimensionvalues$Query; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Dimensionvalues$Query; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/dimensionvalues/query') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Dimensionvalues$Query { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * The value of the nextToken from the previous result page. - */ - pageToken?: string; - /** - * The DFA user profile ID. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$DimensionValueRequest; - } - - - export class Resource$Directorysitecontacts { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.directorySiteContacts.get - * @desc Gets one directory site contact by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Directory site contact ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.directorySiteContacts.get(request, function(err, response) - * { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.directorySiteContacts.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Directory site contact ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Directorysitecontacts$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Directorysitecontacts$Get, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Directorysitecontacts$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Directorysitecontacts$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Directorysitecontacts$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Directorysitecontacts$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/directorySiteContacts/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.directorySiteContacts.list - * @desc Retrieves a list of directory site contacts, possibly filtered. - * This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var directorySiteContactsPage = response['directorySiteContacts']; - * if (!directorySiteContactsPage) { - * return; - * } - * for (var i = 0; i < directorySiteContactsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `directorySiteContactsPage`: - * console.log(JSON.stringify(directorySiteContactsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.directorySiteContacts.list(request, handlePage); - * } - * }; - * - * dfareporting.directorySiteContacts.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.directorySiteContacts.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.directorySiteIds Select only directory site contacts with these directory site IDs. This is a required field. - * @param {string=} params.ids Select only directory site contacts with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "directory site contact*2015" will return objects with names like "directory site contact June 2015", "directory site contact April 2015", or simply "directory site contact 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site contact" will match objects with name "my directory site contact", "directory site contact 2015", or simply "directory site contact". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted 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 - */ - list( - params?: Params$Resource$Directorysitecontacts$List, - options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Directorysitecontacts$List, - options: MethodOptions| - BodyResponseCallback, - callback: - BodyResponseCallback): - void; - list( - params: Params$Resource$Directorysitecontacts$List, - callback: - BodyResponseCallback): - void; - list(callback: - BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Directorysitecontacts$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: - BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Directorysitecontacts$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Directorysitecontacts$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/directorySiteContacts') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - } - - export interface Params$Resource$Directorysitecontacts$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Directory site contact ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Directorysitecontacts$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Select only directory site contacts with these directory site IDs. This - * is a required field. - */ - directorySiteIds?: string; - /** - * Select only directory site contacts with these IDs. - */ - ids?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name, ID or email. Wildcards (*) are - * allowed. For example, "directory site contact*2015" will return objects - * with names like "directory site contact June 2015", "directory site - * contact April 2015", or simply "directory site contact 2015". Most of the - * searches also add wildcards implicitly at the start and the end of the - * search string. For example, a search string of "directory site contact" - * will match objects with name "my directory site contact", "directory site - * contact 2015", or simply "directory site contact". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - - - export class Resource$Directorysites { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.directorySites.get - * @desc Gets one directory site by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Directory site ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.directorySites.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.directorySites.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Directory site ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Directorysites$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Directorysites$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Directorysites$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Directorysites$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Directorysites$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Directorysites$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/directorySites/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.directorySites.insert - * @desc Inserts a new directory site. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.directorySites.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.directorySites.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().DirectorySite} 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$Directorysites$Insert, - options?: MethodOptions): AxiosPromise; - insert( - params: Params$Resource$Directorysites$Insert, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - insert( - params: Params$Resource$Directorysites$Insert, - callback: BodyResponseCallback): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: Params$Resource$Directorysites$Insert| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Directorysites$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Directorysites$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/directorySites') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.directorySites.list - * @desc Retrieves a list of directory sites, possibly filtered. This method - * supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var directorySitesPage = response['directorySites']; - * if (!directorySitesPage) { - * return; - * } - * for (var i = 0; i < directorySitesPage.length; i++) { - * // TODO: Change code below to process each resource in - * `directorySitesPage`: console.log(JSON.stringify(directorySitesPage[i], - * null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.directorySites.list(request, handlePage); - * } - * }; - * - * dfareporting.directorySites.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.directorySites.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.acceptsInStreamVideoPlacements This search filter is no longer supported and will have no effect on the results returned. - * @param {boolean=} params.acceptsInterstitialPlacements This search filter is no longer supported and will have no effect on the results returned. - * @param {boolean=} params.acceptsPublisherPaidPlacements Select only directory sites that accept publisher paid placements. This field can be left blank. - * @param {boolean=} params.active Select only active directory sites. Leave blank to retrieve both active and inactive directory sites. - * @param {string=} params.countryId Select only directory sites with this country ID. - * @param {string=} params.dfpNetworkCode Select only directory sites with this Ad Manager network code. - * @param {string=} params.ids Select only directory sites with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string=} params.parentId Select only directory sites with this parent ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, "directory site*2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted 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 - */ - list(params?: Params$Resource$Directorysites$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Directorysites$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - list( - params: Params$Resource$Directorysites$List, - callback: BodyResponseCallback): - void; - list(callback: BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Directorysites$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Directorysites$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Directorysites$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/directorySites') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Directorysites$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Directory site ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Directorysites$Insert { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$DirectorySite; - } - export interface Params$Resource$Directorysites$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * This search filter is no longer supported and will have no effect on the - * results returned. - */ - acceptsInStreamVideoPlacements?: boolean; - /** - * This search filter is no longer supported and will have no effect on the - * results returned. - */ - acceptsInterstitialPlacements?: boolean; - /** - * Select only directory sites that accept publisher paid placements. This - * field can be left blank. - */ - acceptsPublisherPaidPlacements?: boolean; - /** - * Select only active directory sites. Leave blank to retrieve both active - * and inactive directory sites. - */ - active?: boolean; - /** - * Select only directory sites with this country ID. - */ - countryId?: string; - /** - * Select only directory sites with this Ad Manager network code. - */ - dfpNetworkCode?: string; - /** - * Select only directory sites with these IDs. - */ - ids?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * Select only directory sites with this parent ID. - */ - parentId?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name, ID or URL. Wildcards (*) are - * allowed. For example, "directory site*2015" will return objects with - * names like "directory site June 2015", "directory site April 2015", or - * simply "directory site 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "directory site" will match objects with name "my - * directory site", "directory site 2015" or simply, "directory site". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - - - export class Resource$Dynamictargetingkeys { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.dynamicTargetingKeys.delete - * @desc Deletes an existing dynamic targeting key. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // ID of the object of this dynamic targeting key. This is a required - * field. objectId: '0', // TODO: Update placeholder value. - * - * // Name of this dynamic targeting key. This is a required field. Must - * be less than 256 characters long - * // and cannot contain commas. All characters are converted to - * lowercase. name: '', // TODO: Update placeholder value. - * - * // Type of the object of this dynamic targeting key. This is a - * required field. objectType: '', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.dynamicTargetingKeys.delete(request, function(err) { - * if (err) { - * console.error(err); - * return; - * } - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.dynamicTargetingKeys.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase. - * @param {string} params.objectId ID of the object of this dynamic targeting key. This is a required field. - * @param {string} params.objectType Type of the object of this dynamic targeting key. This is a required field. - * @param {string} params.profileId User profile ID associated with 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 - */ - delete( - params?: Params$Resource$Dynamictargetingkeys$Delete, - options?: MethodOptions): AxiosPromise; - delete( - params: Params$Resource$Dynamictargetingkeys$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( - params: Params$Resource$Dynamictargetingkeys$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: Params$Resource$Dynamictargetingkeys$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Dynamictargetingkeys$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Dynamictargetingkeys$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/dynamicTargetingKeys/{objectId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['profileId', 'objectId', 'name', 'objectType'], - pathParams: ['objectId', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.dynamicTargetingKeys.insert - * @desc Inserts a new dynamic targeting key. Keys must be created at the - * advertiser level before being assigned to the advertiser's ads, - * creatives, or placements. There is a maximum of 1000 keys per advertiser, - * out of which a maximum of 20 keys can be assigned per ad, creative, or - * placement. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.dynamicTargetingKeys.insert(request, function(err, - * response) { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.dynamicTargetingKeys.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().DynamicTargetingKey} 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$Dynamictargetingkeys$Insert, - options?: MethodOptions): AxiosPromise; - insert( - params: Params$Resource$Dynamictargetingkeys$Insert, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - insert( - params: Params$Resource$Dynamictargetingkeys$Insert, - callback: BodyResponseCallback): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: Params$Resource$Dynamictargetingkeys$Insert| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Dynamictargetingkeys$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Dynamictargetingkeys$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/dynamicTargetingKeys') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.dynamicTargetingKeys.list - * @desc Retrieves a list of dynamic targeting keys. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.dynamicTargetingKeys.list(request, function(err, response) - * { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.dynamicTargetingKeys.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserId Select only dynamic targeting keys whose object has this advertiser ID. - * @param {string=} params.names Select only dynamic targeting keys exactly matching these names. - * @param {string=} params.objectId Select only dynamic targeting keys with this object ID. - * @param {string=} params.objectType Select only dynamic targeting keys with this object type. - * @param {string} params.profileId User profile ID associated with 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 - */ - list( - params?: Params$Resource$Dynamictargetingkeys$List, - options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Dynamictargetingkeys$List, - options: MethodOptions| - BodyResponseCallback, - callback: - BodyResponseCallback): - void; - list( - params: Params$Resource$Dynamictargetingkeys$List, - callback: - BodyResponseCallback): - void; - list(callback: - BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Dynamictargetingkeys$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: - BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Dynamictargetingkeys$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Dynamictargetingkeys$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/dynamicTargetingKeys') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - } - - export interface Params$Resource$Dynamictargetingkeys$Delete { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Name of this dynamic targeting key. This is a required field. Must be - * less than 256 characters long and cannot contain commas. All characters - * are converted to lowercase. - */ - name?: string; - /** - * ID of the object of this dynamic targeting key. This is a required field. - */ - objectId?: string; - /** - * Type of the object of this dynamic targeting key. This is a required - * field. - */ - objectType?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Dynamictargetingkeys$Insert { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$DynamicTargetingKey; - } - export interface Params$Resource$Dynamictargetingkeys$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Select only dynamic targeting keys whose object has this advertiser ID. - */ - advertiserId?: string; - /** - * Select only dynamic targeting keys exactly matching these names. - */ - names?: string; - /** - * Select only dynamic targeting keys with this object ID. - */ - objectId?: string; - /** - * Select only dynamic targeting keys with this object type. - */ - objectType?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - - export class Resource$Eventtags { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.eventTags.delete - * @desc Deletes an existing event tag. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Event tag ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.eventTags.delete(request, function(err) { - * if (err) { - * console.error(err); - * return; - * } - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.eventTags.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Event tag ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - delete(params?: Params$Resource$Eventtags$Delete, options?: MethodOptions): - AxiosPromise; - delete( - params: Params$Resource$Eventtags$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( - params: Params$Resource$Eventtags$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: Params$Resource$Eventtags$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Eventtags$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/eventTags/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.eventTags.get - * @desc Gets one event tag by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Event tag ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.eventTags.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.eventTags.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Event tag ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Eventtags$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Eventtags$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Eventtags$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Eventtags$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Eventtags$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/eventTags/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.eventTags.insert - * @desc Inserts a new event tag. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.eventTags.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.eventTags.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().EventTag} 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$Eventtags$Insert, options?: MethodOptions): - AxiosPromise; - insert( - params: Params$Resource$Eventtags$Insert, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - insert( - params: Params$Resource$Eventtags$Insert, - callback: BodyResponseCallback): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: Params$Resource$Eventtags$Insert| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Eventtags$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/eventTags') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.eventTags.list - * @desc Retrieves a list of event tags, possibly filtered. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.eventTags.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.eventTags.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.adId Select only event tags that belong to this ad. - * @param {string=} params.advertiserId Select only event tags that belong to this advertiser. - * @param {string=} params.campaignId Select only event tags that belong to this campaign. - * @param {boolean=} params.definitionsOnly Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags. - * @param {boolean=} params.enabled Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well. - * @param {string=} params.eventTagTypes Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. - * @param {string=} params.ids Select only event tags with these IDs. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" will return objects with names like "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "eventtag" will match objects with name "my eventtag", "eventtag 2015", or simply "eventtag". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted 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 - */ - list(params?: Params$Resource$Eventtags$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Eventtags$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Eventtags$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Eventtags$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Eventtags$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/eventTags') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.eventTags.patch - * @desc Updates an existing event tag. This method supports patch - * semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Event tag ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.eventTags.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.eventTags.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Event tag ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().EventTag} 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 - */ - patch(params?: Params$Resource$Eventtags$Patch, options?: MethodOptions): - AxiosPromise; - patch( - params: Params$Resource$Eventtags$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Eventtags$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Eventtags$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Eventtags$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/eventTags') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.eventTags.update - * @desc Updates an existing event tag. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.eventTags.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.eventTags.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().EventTag} 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$Eventtags$Update, options?: MethodOptions): - AxiosPromise; - update( - params: Params$Resource$Eventtags$Update, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - update( - params: Params$Resource$Eventtags$Update, - callback: BodyResponseCallback): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: Params$Resource$Eventtags$Update| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Eventtags$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/eventTags') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Eventtags$Delete { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Event tag ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Eventtags$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Event tag ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Eventtags$Insert { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$EventTag; - } - export interface Params$Resource$Eventtags$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Select only event tags that belong to this ad. - */ - adId?: string; - /** - * Select only event tags that belong to this advertiser. - */ - advertiserId?: string; - /** - * Select only event tags that belong to this campaign. - */ - campaignId?: string; - /** - * Examine only the specified campaign or advertiser's event tags for - * matching selector criteria. When set to false, the parent advertiser and - * parent campaign of the specified ad or campaign is examined as well. In - * addition, when set to false, the status field is examined as well, along - * with the enabledByDefault field. This parameter can not be set to true - * when adId is specified as ads do not define their own even tags. - */ - definitionsOnly?: boolean; - /** - * Select only enabled event tags. What is considered enabled or disabled - * depends on the definitionsOnly parameter. When definitionsOnly is set to - * true, only the specified advertiser or campaign's event tags' - * enabledByDefault field is examined. When definitionsOnly is set to false, - * the specified ad or specified campaign's parent advertiser's or parent - * campaign's event tags' enabledByDefault and status fields are examined as - * well. - */ - enabled?: boolean; - /** - * Select only event tags with the specified event tag types. Event tag - * types can be used to specify whether to use a third-party pixel, a - * third-party JavaScript URL, or a third-party click-through URL for either - * impression or click tracking. - */ - eventTagTypes?: string; - /** - * Select only event tags with these IDs. - */ - ids?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "eventtag*2015" will return objects with names like - * "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". - * Most of the searches also add wildcards implicitly at the start and the - * end of the search string. For example, a search string of "eventtag" will - * match objects with name "my eventtag", "eventtag 2015", or simply - * "eventtag". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Eventtags$Patch { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Event tag ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$EventTag; - } - export interface Params$Resource$Eventtags$Update { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$EventTag; - } - - - export class Resource$Files { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.files.get - * @desc Retrieves a report file by its report ID and file ID. This method - * supports media download. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // The ID of the report. - * reportId: '0', // TODO: Update placeholder value. - * - * // The ID of the report file. - * fileId: '0', // TODO: Update placeholder value. - * - * // TODO: To download media content, use: - * // - * // alt: 'media', - * - * auth: authClient, - * }; - * - * dfareporting.files.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfareporting' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.files.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.fileId The ID of the report file. - * @param {string} params.reportId The ID of the 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 - */ - get(params?: Params$Resource$Files$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Files$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Files$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Files$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Files$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Files$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/reports/{reportId}/files/{fileId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['reportId', 'fileId'], - pathParams: ['fileId', 'reportId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.files.list - * @desc Lists files for a user profile. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // The DFA profile ID. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var itemsPage = response['items']; - * if (!itemsPage) { - * return; - * } - * for (var i = 0; i < itemsPage.length; i++) { - * // TODO: Change code below to process each resource in `itemsPage`: - * console.log(JSON.stringify(itemsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.files.list(request, handlePage); - * } - * }; - * - * dfareporting.files.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfareporting' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.files.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken The value of the nextToken from the previous result page. - * @param {string} params.profileId The DFA profile ID. - * @param {string=} params.scope The scope that defines which results are returned. - * @param {string=} params.sortField The field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted 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 - */ - list(params?: Params$Resource$Files$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Files$List, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Files$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Files$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Files$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Files$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/files') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Files$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the report file. - */ - fileId?: string; - /** - * The ID of the report. - */ - reportId?: string; - } - export interface Params$Resource$Files$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * The value of the nextToken from the previous result page. - */ - pageToken?: string; - /** - * The DFA profile ID. - */ - profileId?: string; - /** - * The scope that defines which results are returned. - */ - scope?: string; - /** - * The field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - - - export class Resource$Floodlightactivities { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.floodlightActivities.delete - * @desc Deletes an existing floodlight activity. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Floodlight activity ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.floodlightActivities.delete(request, function(err) { - * if (err) { - * console.error(err); - * return; - * } - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.floodlightActivities.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Floodlight activity ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - delete( - params?: Params$Resource$Floodlightactivities$Delete, - options?: MethodOptions): AxiosPromise; - delete( - params: Params$Resource$Floodlightactivities$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( - params: Params$Resource$Floodlightactivities$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: Params$Resource$Floodlightactivities$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Floodlightactivities$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivities$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/floodlightActivities/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.floodlightActivities.generatetag - * @desc Generates a tag for a floodlight activity. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.floodlightActivities.generatetag(request, function(err, - * response) { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.floodlightActivities.generatetag - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.floodlightActivityId Floodlight activity ID for which we want to generate a tag. - * @param {string} params.profileId User profile ID associated with 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 - */ - generatetag( - params?: Params$Resource$Floodlightactivities$Generatetag, - options?: MethodOptions): - AxiosPromise; - generatetag( - params: Params$Resource$Floodlightactivities$Generatetag, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback< - Schema$FloodlightActivitiesGenerateTagResponse>): void; - generatetag( - params: Params$Resource$Floodlightactivities$Generatetag, - callback: BodyResponseCallback< - Schema$FloodlightActivitiesGenerateTagResponse>): void; - generatetag(callback: BodyResponseCallback< - Schema$FloodlightActivitiesGenerateTagResponse>): void; - generatetag( - paramsOrCallback?: Params$Resource$Floodlightactivities$Generatetag| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$FloodlightActivitiesGenerateTagResponse>): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Floodlightactivities$Generatetag; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivities$Generatetag; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/floodlightActivities/generatetag') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * dfareporting.floodlightActivities.get - * @desc Gets one floodlight activity by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Floodlight activity ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.floodlightActivities.get(request, function(err, response) - * { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.floodlightActivities.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Floodlight activity ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Floodlightactivities$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Floodlightactivities$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Floodlightactivities$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Floodlightactivities$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Floodlightactivities$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivities$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/floodlightActivities/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.floodlightActivities.insert - * @desc Inserts a new floodlight activity. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.floodlightActivities.insert(request, function(err, - * response) { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.floodlightActivities.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().FloodlightActivity} 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$Floodlightactivities$Insert, - options?: MethodOptions): AxiosPromise; - insert( - params: Params$Resource$Floodlightactivities$Insert, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - insert( - params: Params$Resource$Floodlightactivities$Insert, - callback: BodyResponseCallback): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: Params$Resource$Floodlightactivities$Insert| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Floodlightactivities$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivities$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/floodlightActivities') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.floodlightActivities.list - * @desc Retrieves a list of floodlight activities, possibly filtered. This - * method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var floodlightActivitiesPage = response['floodlightActivities']; - * if (!floodlightActivitiesPage) { - * return; - * } - * for (var i = 0; i < floodlightActivitiesPage.length; i++) { - * // TODO: Change code below to process each resource in - * `floodlightActivitiesPage`: - * console.log(JSON.stringify(floodlightActivitiesPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.floodlightActivities.list(request, handlePage); - * } - * }; - * - * dfareporting.floodlightActivities.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.floodlightActivities.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserId Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. - * @param {string=} params.floodlightActivityGroupIds Select only floodlight activities with the specified floodlight activity group IDs. - * @param {string=} params.floodlightActivityGroupName Select only floodlight activities with the specified floodlight activity group name. - * @param {string=} params.floodlightActivityGroupTagString Select only floodlight activities with the specified floodlight activity group tag string. - * @param {string=} params.floodlightActivityGroupType Select only floodlight activities with the specified floodlight activity group type. - * @param {string=} params.floodlightConfigurationId Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. - * @param {string=} params.ids Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivity*2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015", or simply "floodlightactivity 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015", or simply "floodlightactivity". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {string=} params.tagString Select only floodlight activities with the specified tag string. - * @param {object} [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$Floodlightactivities$List, - options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Floodlightactivities$List, - options: MethodOptions| - BodyResponseCallback, - callback: - BodyResponseCallback): - void; - list( - params: Params$Resource$Floodlightactivities$List, - callback: - BodyResponseCallback): - void; - list(callback: - BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Floodlightactivities$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: - BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Floodlightactivities$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivities$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/floodlightActivities') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * dfareporting.floodlightActivities.patch - * @desc Updates an existing floodlight activity. This method supports patch - * semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Floodlight activity ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.floodlightActivities.patch(request, function(err, - * response) { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.floodlightActivities.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Floodlight activity ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().FloodlightActivity} 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 - */ - patch( - params?: Params$Resource$Floodlightactivities$Patch, - options?: MethodOptions): AxiosPromise; - patch( - params: Params$Resource$Floodlightactivities$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Floodlightactivities$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Floodlightactivities$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Floodlightactivities$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivities$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/floodlightActivities') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.floodlightActivities.update - * @desc Updates an existing floodlight activity. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.floodlightActivities.update(request, function(err, - * response) { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.floodlightActivities.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().FloodlightActivity} 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$Floodlightactivities$Update, - options?: MethodOptions): AxiosPromise; - update( - params: Params$Resource$Floodlightactivities$Update, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - update( - params: Params$Resource$Floodlightactivities$Update, - callback: BodyResponseCallback): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: Params$Resource$Floodlightactivities$Update| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Floodlightactivities$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivities$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/floodlightActivities') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Floodlightactivities$Delete { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Floodlight activity ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Floodlightactivities$Generatetag { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Floodlight activity ID for which we want to generate a tag. - */ - floodlightActivityId?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Floodlightactivities$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Floodlight activity ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Floodlightactivities$Insert { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FloodlightActivity; - } - export interface Params$Resource$Floodlightactivities$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Select only floodlight activities for the specified advertiser ID. Must - * specify either ids, advertiserId, or floodlightConfigurationId for a - * non-empty result. - */ - advertiserId?: string; - /** - * Select only floodlight activities with the specified floodlight activity - * group IDs. - */ - floodlightActivityGroupIds?: string; - /** - * Select only floodlight activities with the specified floodlight activity - * group name. - */ - floodlightActivityGroupName?: string; - /** - * Select only floodlight activities with the specified floodlight activity - * group tag string. - */ - floodlightActivityGroupTagString?: string; - /** - * Select only floodlight activities with the specified floodlight activity - * group type. - */ - floodlightActivityGroupType?: string; - /** - * Select only floodlight activities for the specified floodlight - * configuration ID. Must specify either ids, advertiserId, or - * floodlightConfigurationId for a non-empty result. - */ - floodlightConfigurationId?: string; - /** - * Select only floodlight activities with the specified IDs. Must specify - * either ids, advertiserId, or floodlightConfigurationId for a non-empty - * result. - */ - ids?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "floodlightactivity*2015" will return objects with names - * like "floodlightactivity June 2015", "floodlightactivity April 2015", or - * simply "floodlightactivity 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "floodlightactivity" will match objects with name "my - * floodlightactivity activity", "floodlightactivity 2015", or simply - * "floodlightactivity". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - /** - * Select only floodlight activities with the specified tag string. - */ - tagString?: string; - } - export interface Params$Resource$Floodlightactivities$Patch { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Floodlight activity ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FloodlightActivity; - } - export interface Params$Resource$Floodlightactivities$Update { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FloodlightActivity; - } - - - export class Resource$Floodlightactivitygroups { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.floodlightActivityGroups.get - * @desc Gets one floodlight activity group by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Floodlight activity Group ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.floodlightActivityGroups.get(request, function(err, - * response) { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.floodlightActivityGroups.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Floodlight activity Group ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Floodlightactivitygroups$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Floodlightactivitygroups$Get, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Floodlightactivitygroups$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Floodlightactivitygroups$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Floodlightactivitygroups$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivitygroups$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/floodlightActivityGroups/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.floodlightActivityGroups.insert - * @desc Inserts a new floodlight activity group. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.floodlightActivityGroups.insert(request, function(err, - * response) { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.floodlightActivityGroups.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().FloodlightActivityGroup} 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$Floodlightactivitygroups$Insert, - options?: MethodOptions): AxiosPromise; - insert( - params: Params$Resource$Floodlightactivitygroups$Insert, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - insert( - params: Params$Resource$Floodlightactivitygroups$Insert, - callback: BodyResponseCallback): void; - insert(callback: BodyResponseCallback): - void; - insert( - paramsOrCallback?: Params$Resource$Floodlightactivitygroups$Insert| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Floodlightactivitygroups$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivitygroups$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/floodlightActivityGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.floodlightActivityGroups.list - * @desc Retrieves a list of floodlight activity groups, possibly filtered. - * This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var floodlightActivityGroupsPage = - * response['floodlightActivityGroups']; if (!floodlightActivityGroupsPage) - * { return; - * } - * for (var i = 0; i < floodlightActivityGroupsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `floodlightActivityGroupsPage`: - * console.log(JSON.stringify(floodlightActivityGroupsPage[i], null, - * 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.floodlightActivityGroups.list(request, handlePage); - * } - * }; - * - * dfareporting.floodlightActivityGroups.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.floodlightActivityGroups.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserId Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. - * @param {string=} params.floodlightConfigurationId Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result. - * @param {string=} params.ids Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivitygroup*2015" will return objects with names like "floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or simply "floodlightactivitygroup 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivitygroup" will match objects with name "my floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply "floodlightactivitygroup". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {string=} params.type Select only floodlight activity groups with the specified floodlight activity group type. - * @param {object} [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$Floodlightactivitygroups$List, - options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Floodlightactivitygroups$List, - options: MethodOptions| - BodyResponseCallback, - callback: - BodyResponseCallback): - void; - list( - params: Params$Resource$Floodlightactivitygroups$List, - callback: - BodyResponseCallback): - void; - list(callback: - BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Floodlightactivitygroups$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: - BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Floodlightactivitygroups$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivitygroups$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/floodlightActivityGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * dfareporting.floodlightActivityGroups.patch - * @desc Updates an existing floodlight activity group. This method supports - * patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Floodlight activity Group ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.floodlightActivityGroups.patch(request, function(err, - * response) { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.floodlightActivityGroups.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Floodlight activity Group ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().FloodlightActivityGroup} 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 - */ - patch( - params?: Params$Resource$Floodlightactivitygroups$Patch, - options?: MethodOptions): AxiosPromise; - patch( - params: Params$Resource$Floodlightactivitygroups$Patch, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Floodlightactivitygroups$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Floodlightactivitygroups$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Floodlightactivitygroups$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivitygroups$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/floodlightActivityGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.floodlightActivityGroups.update - * @desc Updates an existing floodlight activity group. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.floodlightActivityGroups.update(request, function(err, - * response) { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.floodlightActivityGroups.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().FloodlightActivityGroup} 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$Floodlightactivitygroups$Update, - options?: MethodOptions): AxiosPromise; - update( - params: Params$Resource$Floodlightactivitygroups$Update, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - update( - params: Params$Resource$Floodlightactivitygroups$Update, - callback: BodyResponseCallback): void; - update(callback: BodyResponseCallback): - void; - update( - paramsOrCallback?: Params$Resource$Floodlightactivitygroups$Update| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Floodlightactivitygroups$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivitygroups$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/floodlightActivityGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Floodlightactivitygroups$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Floodlight activity Group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Floodlightactivitygroups$Insert { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FloodlightActivityGroup; - } - export interface Params$Resource$Floodlightactivitygroups$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Select only floodlight activity groups with the specified advertiser ID. - * Must specify either advertiserId or floodlightConfigurationId for a - * non-empty result. - */ - advertiserId?: string; - /** - * Select only floodlight activity groups with the specified floodlight - * configuration ID. Must specify either advertiserId, or - * floodlightConfigurationId for a non-empty result. - */ - floodlightConfigurationId?: string; - /** - * Select only floodlight activity groups with the specified IDs. Must - * specify either advertiserId or floodlightConfigurationId for a non-empty - * result. - */ - ids?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "floodlightactivitygroup*2015" will return objects with - * names like "floodlightactivitygroup June 2015", "floodlightactivitygroup - * April 2015", or simply "floodlightactivitygroup 2015". Most of the - * searches also add wildcards implicitly at the start and the end of the - * search string. For example, a search string of "floodlightactivitygroup" - * will match objects with name "my floodlightactivitygroup activity", - * "floodlightactivitygroup 2015", or simply "floodlightactivitygroup". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - /** - * Select only floodlight activity groups with the specified floodlight - * activity group type. - */ - type?: string; - } - export interface Params$Resource$Floodlightactivitygroups$Patch { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Floodlight activity Group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FloodlightActivityGroup; - } - export interface Params$Resource$Floodlightactivitygroups$Update { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FloodlightActivityGroup; - } - - - export class Resource$Floodlightconfigurations { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.floodlightConfigurations.get - * @desc Gets one floodlight configuration by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Floodlight configuration ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.floodlightConfigurations.get(request, function(err, - * response) { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.floodlightConfigurations.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Floodlight configuration ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Floodlightconfigurations$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Floodlightconfigurations$Get, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Floodlightconfigurations$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Floodlightconfigurations$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Floodlightconfigurations$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightconfigurations$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/floodlightConfigurations/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.floodlightConfigurations.list - * @desc Retrieves a list of floodlight configurations, possibly filtered. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.floodlightConfigurations.list(request, function(err, - * response) { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.floodlightConfigurations.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.ids Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned. - * @param {string} params.profileId User profile ID associated with 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 - */ - list( - params?: Params$Resource$Floodlightconfigurations$List, - options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Floodlightconfigurations$List, - options: MethodOptions| - BodyResponseCallback, - callback: - BodyResponseCallback): - void; - list( - params: Params$Resource$Floodlightconfigurations$List, - callback: - BodyResponseCallback): - void; - list(callback: - BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Floodlightconfigurations$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: - BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Floodlightconfigurations$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightconfigurations$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/floodlightConfigurations') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * dfareporting.floodlightConfigurations.patch - * @desc Updates an existing floodlight configuration. This method supports - * patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Floodlight configuration ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.floodlightConfigurations.patch(request, function(err, - * response) { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.floodlightConfigurations.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Floodlight configuration ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().FloodlightConfiguration} 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 - */ - patch( - params?: Params$Resource$Floodlightconfigurations$Patch, - options?: MethodOptions): AxiosPromise; - patch( - params: Params$Resource$Floodlightconfigurations$Patch, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Floodlightconfigurations$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Floodlightconfigurations$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Floodlightconfigurations$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightconfigurations$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/floodlightConfigurations') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.floodlightConfigurations.update - * @desc Updates an existing floodlight configuration. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.floodlightConfigurations.update(request, function(err, - * response) { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.floodlightConfigurations.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().FloodlightConfiguration} 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$Floodlightconfigurations$Update, - options?: MethodOptions): AxiosPromise; - update( - params: Params$Resource$Floodlightconfigurations$Update, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - update( - params: Params$Resource$Floodlightconfigurations$Update, - callback: BodyResponseCallback): void; - update(callback: BodyResponseCallback): - void; - update( - paramsOrCallback?: Params$Resource$Floodlightconfigurations$Update| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Floodlightconfigurations$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightconfigurations$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/floodlightConfigurations') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Floodlightconfigurations$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Floodlight configuration ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Floodlightconfigurations$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Set of IDs of floodlight configurations to retrieve. Required field; - * otherwise an empty list will be returned. - */ - ids?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Floodlightconfigurations$Patch { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Floodlight configuration ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FloodlightConfiguration; - } - export interface Params$Resource$Floodlightconfigurations$Update { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FloodlightConfiguration; - } - - - export class Resource$Inventoryitems { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.inventoryItems.get - * @desc Gets one inventory item by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Project ID for order documents. - * projectId: '0', // TODO: Update placeholder value. - * - * // Inventory item ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.inventoryItems.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.inventoryItems.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Inventory item ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string} params.projectId Project ID for order documents. - * @param {object} [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$Inventoryitems$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Inventoryitems$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Inventoryitems$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Inventoryitems$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Inventoryitems$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Inventoryitems$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'projectId', 'id'], - pathParams: ['id', 'profileId', 'projectId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.inventoryItems.list - * @desc Retrieves a list of inventory items, possibly filtered. This method - * supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Project ID for order documents. - * projectId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var inventoryItemsPage = response['inventoryItems']; - * if (!inventoryItemsPage) { - * return; - * } - * for (var i = 0; i < inventoryItemsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `inventoryItemsPage`: console.log(JSON.stringify(inventoryItemsPage[i], - * null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.inventoryItems.list(request, handlePage); - * } - * }; - * - * dfareporting.inventoryItems.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.inventoryItems.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.ids Select only inventory items with these IDs. - * @param {boolean=} params.inPlan Select only inventory items that are in plan. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.orderId Select only inventory items that belong to specified orders. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string} params.projectId Project ID for order documents. - * @param {string=} params.siteId Select only inventory items that are associated with these sites. - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {string=} params.type Select only inventory items with this type. - * @param {object} [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$Inventoryitems$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Inventoryitems$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - list( - params: Params$Resource$Inventoryitems$List, - callback: BodyResponseCallback): - void; - list(callback: BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Inventoryitems$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Inventoryitems$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Inventoryitems$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/projects/{projectId}/inventoryItems') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'projectId'], - pathParams: ['profileId', 'projectId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Inventoryitems$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Inventory item ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Project ID for order documents. - */ - projectId?: string; - } - export interface Params$Resource$Inventoryitems$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Select only inventory items with these IDs. - */ - ids?: string; - /** - * Select only inventory items that are in plan. - */ - inPlan?: boolean; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Select only inventory items that belong to specified orders. - */ - orderId?: string; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Project ID for order documents. - */ - projectId?: string; - /** - * Select only inventory items that are associated with these sites. - */ - siteId?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - /** - * Select only inventory items with this type. - */ - type?: string; - } - - - export class Resource$Landingpages { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.landingPages.delete - * @desc Deletes an existing campaign landing page. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Landing page campaign ID. - * campaignId: '0', // TODO: Update placeholder value. - * - * // Landing page ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.landingPages.delete(request, function(err) { - * if (err) { - * console.error(err); - * return; - * } - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.landingPages.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.campaignId Landing page campaign ID. - * @param {string} params.id Landing page ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - delete( - params?: Params$Resource$Landingpages$Delete, - options?: MethodOptions): AxiosPromise; - delete( - params: Params$Resource$Landingpages$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( - params: Params$Resource$Landingpages$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: Params$Resource$Landingpages$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Landingpages$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Landingpages$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/campaigns/{campaignId}/landingPages/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['profileId', 'campaignId', 'id'], - pathParams: ['campaignId', 'id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.landingPages.get - * @desc Gets one campaign landing page by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Landing page campaign ID. - * campaignId: '0', // TODO: Update placeholder value. - * - * // Landing page ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.landingPages.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.landingPages.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.campaignId Landing page campaign ID. - * @param {string} params.id Landing page ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Landingpages$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Landingpages$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Landingpages$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Landingpages$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Landingpages$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Landingpages$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/campaigns/{campaignId}/landingPages/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'campaignId', 'id'], - pathParams: ['campaignId', 'id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.landingPages.insert - * @desc Inserts a new landing page for the specified campaign. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Landing page campaign ID. - * campaignId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.landingPages.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.landingPages.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.campaignId Landing page campaign ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().LandingPage} 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$Landingpages$Insert, - options?: MethodOptions): AxiosPromise; - insert( - params: Params$Resource$Landingpages$Insert, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - insert( - params: Params$Resource$Landingpages$Insert, - callback: BodyResponseCallback): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: Params$Resource$Landingpages$Insert| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Landingpages$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Landingpages$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/campaigns/{campaignId}/landingPages') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId', 'campaignId'], - pathParams: ['campaignId', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.landingPages.list - * @desc Retrieves the list of landing pages for the specified campaign. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Landing page campaign ID. - * campaignId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.landingPages.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.landingPages.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.campaignId Landing page campaign ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - list(params?: Params$Resource$Landingpages$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Landingpages$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Landingpages$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Landingpages$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Landingpages$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Landingpages$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/campaigns/{campaignId}/landingPages') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'campaignId'], - pathParams: ['campaignId', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.landingPages.patch - * @desc Updates an existing campaign landing page. This method supports - * patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Landing page campaign ID. - * campaignId: '0', // TODO: Update placeholder value. - * - * // Landing page ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.landingPages.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.landingPages.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.campaignId Landing page campaign ID. - * @param {string} params.id Landing page ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().LandingPage} 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 - */ - patch(params?: Params$Resource$Landingpages$Patch, options?: MethodOptions): - AxiosPromise; - patch( - params: Params$Resource$Landingpages$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Landingpages$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Landingpages$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Landingpages$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Landingpages$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/campaigns/{campaignId}/landingPages') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'campaignId', 'id'], - pathParams: ['campaignId', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.landingPages.update - * @desc Updates an existing campaign landing page. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Landing page campaign ID. - * campaignId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.landingPages.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.landingPages.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.campaignId Landing page campaign ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().LandingPage} 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$Landingpages$Update, - options?: MethodOptions): AxiosPromise; - update( - params: Params$Resource$Landingpages$Update, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - update( - params: Params$Resource$Landingpages$Update, - callback: BodyResponseCallback): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: Params$Resource$Landingpages$Update| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Landingpages$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Landingpages$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/campaigns/{campaignId}/landingPages') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId', 'campaignId'], - pathParams: ['campaignId', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Landingpages$Delete { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Landing page campaign ID. - */ - campaignId?: string; - /** - * Landing page ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Landingpages$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Landing page campaign ID. - */ - campaignId?: string; - /** - * Landing page ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Landingpages$Insert { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Landing page campaign ID. - */ - campaignId?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LandingPage; - } - export interface Params$Resource$Landingpages$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Landing page campaign ID. - */ - campaignId?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Landingpages$Patch { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Landing page campaign ID. - */ - campaignId?: string; - /** - * Landing page ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LandingPage; - } - export interface Params$Resource$Landingpages$Update { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Landing page campaign ID. - */ - campaignId?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LandingPage; - } - - - export class Resource$Languages { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.languages.list - * @desc Retrieves a list of languages. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.languages.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.languages.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with 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 - */ - list(params?: Params$Resource$Languages$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Languages$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Languages$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Languages$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Languages$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Languages$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/languages') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Languages$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - - export class Resource$Metros { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.metros.list - * @desc Retrieves a list of metros. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.metros.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.metros.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with 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 - */ - list(params?: Params$Resource$Metros$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Metros$List, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Metros$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Metros$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Metros$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Metros$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/metros') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Metros$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - - export class Resource$Mobilecarriers { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.mobileCarriers.get - * @desc Gets one mobile carrier by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Mobile carrier ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.mobileCarriers.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.mobileCarriers.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Mobile carrier ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Mobilecarriers$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Mobilecarriers$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Mobilecarriers$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Mobilecarriers$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Mobilecarriers$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Mobilecarriers$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/mobileCarriers/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.mobileCarriers.list - * @desc Retrieves a list of mobile carriers. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.mobileCarriers.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.mobileCarriers.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with 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 - */ - list(params?: Params$Resource$Mobilecarriers$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Mobilecarriers$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - list( - params: Params$Resource$Mobilecarriers$List, - callback: BodyResponseCallback): - void; - list(callback: BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Mobilecarriers$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Mobilecarriers$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Mobilecarriers$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/mobileCarriers') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Mobilecarriers$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Mobile carrier ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Mobilecarriers$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - - export class Resource$Operatingsystems { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.operatingSystems.get - * @desc Gets one operating system by DART ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Operating system DART ID. - * dartId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.operatingSystems.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.operatingSystems.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.dartId Operating system DART ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Operatingsystems$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Operatingsystems$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Operatingsystems$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Operatingsystems$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Operatingsystems$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Operatingsystems$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/operatingSystems/{dartId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'dartId'], - pathParams: ['dartId', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.operatingSystems.list - * @desc Retrieves a list of operating systems. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.operatingSystems.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.operatingSystems.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with 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 - */ - list( - params?: Params$Resource$Operatingsystems$List, - options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Operatingsystems$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - list( - params: Params$Resource$Operatingsystems$List, - callback: BodyResponseCallback): - void; - list(callback: BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Operatingsystems$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Operatingsystems$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Operatingsystems$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/operatingSystems') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - } - - export interface Params$Resource$Operatingsystems$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Operating system DART ID. - */ - dartId?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Operatingsystems$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - - export class Resource$Operatingsystemversions { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.operatingSystemVersions.get - * @desc Gets one operating system version by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Operating system version ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.operatingSystemVersions.get(request, function(err, - * response) { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.operatingSystemVersions.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Operating system version ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Operatingsystemversions$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Operatingsystemversions$Get, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Operatingsystemversions$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Operatingsystemversions$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Operatingsystemversions$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Operatingsystemversions$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/operatingSystemVersions/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.operatingSystemVersions.list - * @desc Retrieves a list of operating system versions. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.operatingSystemVersions.list(request, function(err, - * response) { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.operatingSystemVersions.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with 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 - */ - list( - params?: Params$Resource$Operatingsystemversions$List, - options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Operatingsystemversions$List, - options: MethodOptions| - BodyResponseCallback, - callback: - BodyResponseCallback): - void; - list( - params: Params$Resource$Operatingsystemversions$List, - callback: - BodyResponseCallback): - void; - list(callback: - BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Operatingsystemversions$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: - BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Operatingsystemversions$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Operatingsystemversions$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/operatingSystemVersions') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - } - - export interface Params$Resource$Operatingsystemversions$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Operating system version ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Operatingsystemversions$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - - export class Resource$Orderdocuments { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.orderDocuments.get - * @desc Gets one order document by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Project ID for order documents. - * projectId: '0', // TODO: Update placeholder value. - * - * // Order document ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.orderDocuments.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.orderDocuments.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Order document ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string} params.projectId Project ID for order documents. - * @param {object} [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$Orderdocuments$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Orderdocuments$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Orderdocuments$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Orderdocuments$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Orderdocuments$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orderdocuments$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'projectId', 'id'], - pathParams: ['id', 'profileId', 'projectId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.orderDocuments.list - * @desc Retrieves a list of order documents, possibly filtered. This method - * supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Project ID for order documents. - * projectId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var orderDocumentsPage = response['orderDocuments']; - * if (!orderDocumentsPage) { - * return; - * } - * for (var i = 0; i < orderDocumentsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `orderDocumentsPage`: console.log(JSON.stringify(orderDocumentsPage[i], - * null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.orderDocuments.list(request, handlePage); - * } - * }; - * - * dfareporting.orderDocuments.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.orderDocuments.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.approved Select only order documents that have been approved by at least one user. - * @param {string=} params.ids Select only order documents with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.orderId Select only order documents for specified orders. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string} params.projectId Project ID for order documents. - * @param {string=} params.searchString Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, "orderdocument*2015" will return order documents with names like "orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "orderdocument" will match order documents with name "my orderdocument", "orderdocument 2015", or simply "orderdocument". - * @param {string=} params.siteId Select only order documents that are associated with these sites. - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted 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 - */ - list(params?: Params$Resource$Orderdocuments$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Orderdocuments$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - list( - params: Params$Resource$Orderdocuments$List, - callback: BodyResponseCallback): - void; - list(callback: BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Orderdocuments$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Orderdocuments$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orderdocuments$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/projects/{projectId}/orderDocuments') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'projectId'], - pathParams: ['profileId', 'projectId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Orderdocuments$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Order document ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Project ID for order documents. - */ - projectId?: string; - } - export interface Params$Resource$Orderdocuments$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Select only order documents that have been approved by at least one user. - */ - approved?: boolean; - /** - * Select only order documents with these IDs. - */ - ids?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Select only order documents for specified orders. - */ - orderId?: string; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Project ID for order documents. - */ - projectId?: string; - /** - * Allows searching for order documents by name or ID. Wildcards (*) are - * allowed. For example, "orderdocument*2015" will return order documents - * with names like "orderdocument June 2015", "orderdocument April 2015", or - * simply "orderdocument 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "orderdocument" will match order documents with name "my - * orderdocument", "orderdocument 2015", or simply "orderdocument". - */ - searchString?: string; - /** - * Select only order documents that are associated with these sites. - */ - siteId?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - - - export class Resource$Orders { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.orders.get - * @desc Gets one order by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Project ID for orders. - * projectId: '0', // TODO: Update placeholder value. - * - * // Order ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.orders.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.orders.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Order ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string} params.projectId Project ID for orders. - * @param {object} [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$Orders$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Orders$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Orders$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Orders$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Orders$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orders$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/projects/{projectId}/orders/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'projectId', 'id'], - pathParams: ['id', 'profileId', 'projectId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.orders.list - * @desc Retrieves a list of orders, possibly filtered. This method supports - * paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Project ID for orders. - * projectId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var ordersPage = response['orders']; - * if (!ordersPage) { - * return; - * } - * for (var i = 0; i < ordersPage.length; i++) { - * // TODO: Change code below to process each resource in - * `ordersPage`: console.log(JSON.stringify(ordersPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.orders.list(request, handlePage); - * } - * }; - * - * dfareporting.orders.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.orders.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.ids Select only orders with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string} params.projectId Project ID for orders. - * @param {string=} params.searchString Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, "order*2015" will return orders with names like "order June 2015", "order April 2015", or simply "order 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "order" will match orders with name "my order", "order 2015", or simply "order". - * @param {string=} params.siteId Select only orders that are associated with these site IDs. - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted 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 - */ - list(params?: Params$Resource$Orders$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Orders$List, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Orders$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Orders$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Orders$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orders$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/projects/{projectId}/orders') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'projectId'], - pathParams: ['profileId', 'projectId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Orders$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Order ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Project ID for orders. - */ - projectId?: string; - } - export interface Params$Resource$Orders$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Select only orders with these IDs. - */ - ids?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Project ID for orders. - */ - projectId?: string; - /** - * Allows searching for orders by name or ID. Wildcards (*) are allowed. For - * example, "order*2015" will return orders with names like "order June - * 2015", "order April 2015", or simply "order 2015". Most of the searches - * also add wildcards implicitly at the start and the end of the search - * string. For example, a search string of "order" will match orders with - * name "my order", "order 2015", or simply "order". - */ - searchString?: string; - /** - * Select only orders that are associated with these site IDs. - */ - siteId?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - - - export class Resource$Placementgroups { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.placementGroups.get - * @desc Gets one placement group by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Placement group ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.placementGroups.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placementGroups.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Placement group ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Placementgroups$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Placementgroups$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Placementgroups$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Placementgroups$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Placementgroups$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementgroups$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/placementGroups/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.placementGroups.insert - * @desc Inserts a new placement group. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.placementGroups.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placementGroups.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().PlacementGroup} 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$Placementgroups$Insert, - options?: MethodOptions): AxiosPromise; - insert( - params: Params$Resource$Placementgroups$Insert, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - insert( - params: Params$Resource$Placementgroups$Insert, - callback: BodyResponseCallback): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: Params$Resource$Placementgroups$Insert| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Placementgroups$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementgroups$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/placementGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.placementGroups.list - * @desc Retrieves a list of placement groups, possibly filtered. This - * method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var placementGroupsPage = response['placementGroups']; - * if (!placementGroupsPage) { - * return; - * } - * for (var i = 0; i < placementGroupsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `placementGroupsPage`: console.log(JSON.stringify(placementGroupsPage[i], - * null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.placementGroups.list(request, handlePage); - * } - * }; - * - * dfareporting.placementGroups.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placementGroups.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserIds Select only placement groups that belong to these advertisers. - * @param {boolean=} params.archived Select only archived placements. Don't set this field to select both archived and non-archived placements. - * @param {string=} params.campaignIds Select only placement groups that belong to these campaigns. - * @param {string=} params.contentCategoryIds Select only placement groups that are associated with these content categories. - * @param {string=} params.directorySiteIds Select only placement groups that are associated with these directory sites. - * @param {string=} params.ids Select only placement groups with these IDs. - * @param {string=} params.maxEndDate Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.maxStartDate Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". - * @param {string=} params.minEndDate Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd". - * @param {string=} params.minStartDate Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd". - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string=} params.placementGroupType Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. - * @param {string=} params.placementStrategyIds Select only placement groups that are associated with these placement strategies. - * @param {string=} params.pricingTypes Select only placement groups with these pricing types. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placement groups with names like "placement group June 2015", "placement group May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementgroup" will match placement groups with name "my placementgroup", "placementgroup 2015", or simply "placementgroup". - * @param {string=} params.siteIds Select only placement groups that are associated with these sites. - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted 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 - */ - list( - params?: Params$Resource$Placementgroups$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Placementgroups$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - list( - params: Params$Resource$Placementgroups$List, - callback: BodyResponseCallback): - void; - list(callback: BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Placementgroups$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Placementgroups$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementgroups$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/placementGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.placementGroups.patch - * @desc Updates an existing placement group. This method supports patch - * semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Placement group ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.placementGroups.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placementGroups.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Placement group ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().PlacementGroup} 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 - */ - patch( - params?: Params$Resource$Placementgroups$Patch, - options?: MethodOptions): AxiosPromise; - patch( - params: Params$Resource$Placementgroups$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Placementgroups$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Placementgroups$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Placementgroups$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementgroups$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/placementGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.placementGroups.update - * @desc Updates an existing placement group. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.placementGroups.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placementGroups.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().PlacementGroup} 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$Placementgroups$Update, - options?: MethodOptions): AxiosPromise; - update( - params: Params$Resource$Placementgroups$Update, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - update( - params: Params$Resource$Placementgroups$Update, - callback: BodyResponseCallback): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: Params$Resource$Placementgroups$Update| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Placementgroups$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementgroups$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/placementGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Placementgroups$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Placement group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Placementgroups$Insert { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$PlacementGroup; - } - export interface Params$Resource$Placementgroups$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Select only placement groups that belong to these advertisers. - */ - advertiserIds?: string; - /** - * Select only archived placements. Don't set this field to select both - * archived and non-archived placements. - */ - archived?: boolean; - /** - * Select only placement groups that belong to these campaigns. - */ - campaignIds?: string; - /** - * Select only placement groups that are associated with these content - * categories. - */ - contentCategoryIds?: string; - /** - * Select only placement groups that are associated with these directory - * sites. - */ - directorySiteIds?: string; - /** - * Select only placement groups with these IDs. - */ - ids?: string; - /** - * Select only placements or placement groups whose end date is on or before - * the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". - */ - maxEndDate?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Select only placements or placement groups whose start date is on or - * before the specified maxStartDate. The date should be formatted as - * "yyyy-MM-dd". - */ - maxStartDate?: string; - /** - * Select only placements or placement groups whose end date is on or after - * the specified minEndDate. The date should be formatted as "yyyy-MM-dd". - */ - minEndDate?: string; - /** - * Select only placements or placement groups whose start date is on or - * after the specified minStartDate. The date should be formatted as - * "yyyy-MM-dd". - */ - minStartDate?: string; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * Select only placement groups belonging with this group type. A package is - * a simple group of placements that acts as a single pricing point for a - * group of tags. A roadblock is a group of placements that not only acts as - * a single pricing point but also assumes that all the tags in it will be - * served at the same time. A roadblock requires one of its assigned - * placements to be marked as primary for reporting. - */ - placementGroupType?: string; - /** - * Select only placement groups that are associated with these placement - * strategies. - */ - placementStrategyIds?: string; - /** - * Select only placement groups with these pricing types. - */ - pricingTypes?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for placement groups by name or ID. Wildcards (*) are - * allowed. For example, "placement*2015" will return placement groups with - * names like "placement group June 2015", "placement group May 2015", or - * simply "placements 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "placementgroup" will match placement groups with name - * "my placementgroup", "placementgroup 2015", or simply "placementgroup". - */ - searchString?: string; - /** - * Select only placement groups that are associated with these sites. - */ - siteIds?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Placementgroups$Patch { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Placement group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$PlacementGroup; - } - export interface Params$Resource$Placementgroups$Update { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$PlacementGroup; - } - - - export class Resource$Placements { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.placements.generatetags - * @desc Generates tags for a placement. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.placements.generatetags(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placements.generatetags - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.campaignId Generate placements belonging to this campaign. This is a required field. - * @param {string=} params.placementIds Generate tags for these placements. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.tagFormats Tag formats to generate for these placements. Note: PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - generatetags( - params?: Params$Resource$Placements$Generatetags, - options?: MethodOptions): - AxiosPromise; - generatetags( - params: Params$Resource$Placements$Generatetags, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - generatetags( - params: Params$Resource$Placements$Generatetags, - callback: BodyResponseCallback): - void; - generatetags( - callback: BodyResponseCallback): - void; - generatetags( - paramsOrCallback?: Params$Resource$Placements$Generatetags| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Placements$Generatetags; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placements$Generatetags; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/placements/generatetags') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * dfareporting.placements.get - * @desc Gets one placement by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Placement ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.placements.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placements.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Placement ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Placements$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Placements$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Placements$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Placements$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Placements$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placements$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/placements/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.placements.insert - * @desc Inserts a new placement. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.placements.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placements.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Placement} 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$Placements$Insert, options?: MethodOptions): - AxiosPromise; - insert( - params: Params$Resource$Placements$Insert, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - insert( - params: Params$Resource$Placements$Insert, - callback: BodyResponseCallback): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: Params$Resource$Placements$Insert| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Placements$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placements$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/placements') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.placements.list - * @desc Retrieves a list of placements, possibly filtered. This method - * supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var placementsPage = response['placements']; - * if (!placementsPage) { - * return; - * } - * for (var i = 0; i < placementsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `placementsPage`: console.log(JSON.stringify(placementsPage[i], null, - * 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.placements.list(request, handlePage); - * } - * }; - * - * dfareporting.placements.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placements.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserIds Select only placements that belong to these advertisers. - * @param {boolean=} params.archived Select only archived placements. Don't set this field to select both archived and non-archived placements. - * @param {string=} params.campaignIds Select only placements that belong to these campaigns. - * @param {string=} params.compatibilities Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. - * @param {string=} params.contentCategoryIds Select only placements that are associated with these content categories. - * @param {string=} params.directorySiteIds Select only placements that are associated with these directory sites. - * @param {string=} params.groupIds Select only placements that belong to these placement groups. - * @param {string=} params.ids Select only placements with these IDs. - * @param {string=} params.maxEndDate Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.maxStartDate Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". - * @param {string=} params.minEndDate Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd". - * @param {string=} params.minStartDate Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd". - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string=} params.paymentSource Select only placements with this payment source. - * @param {string=} params.placementStrategyIds Select only placements that are associated with these placement strategies. - * @param {string=} params.pricingTypes Select only placements with these pricing types. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placement" will match placements with name "my placement", "placement 2015", or simply "placement". - * @param {string=} params.siteIds Select only placements that are associated with these sites. - * @param {string=} params.sizeIds Select only placements that are associated with these sizes. - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted 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 - */ - list(params?: Params$Resource$Placements$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Placements$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Placements$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Placements$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Placements$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placements$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/placements') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.placements.patch - * @desc Updates an existing placement. This method supports patch - * semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Placement ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.placements.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placements.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Placement ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Placement} 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 - */ - patch(params?: Params$Resource$Placements$Patch, options?: MethodOptions): - AxiosPromise; - patch( - params: Params$Resource$Placements$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Placements$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Placements$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Placements$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placements$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/placements') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.placements.update - * @desc Updates an existing placement. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.placements.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placements.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Placement} 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$Placements$Update, options?: MethodOptions): - AxiosPromise; - update( - params: Params$Resource$Placements$Update, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - update( - params: Params$Resource$Placements$Update, - callback: BodyResponseCallback): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: Params$Resource$Placements$Update| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Placements$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placements$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/placements') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Placements$Generatetags { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Generate placements belonging to this campaign. This is a required field. - */ - campaignId?: string; - /** - * Generate tags for these placements. - */ - placementIds?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Tag formats to generate for these placements. Note: - * PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements. - */ - tagFormats?: string; - } - export interface Params$Resource$Placements$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Placement ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Placements$Insert { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Placement; - } - export interface Params$Resource$Placements$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Select only placements that belong to these advertisers. - */ - advertiserIds?: string; - /** - * Select only archived placements. Don't set this field to select both - * archived and non-archived placements. - */ - archived?: boolean; - /** - * Select only placements that belong to these campaigns. - */ - campaignIds?: string; - /** - * Select only placements that are associated with these compatibilities. - * DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or - * on mobile devices for regular or interstitial ads respectively. APP and - * APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers - * to rendering in in-stream video ads developed with the VAST standard. - */ - compatibilities?: string; - /** - * Select only placements that are associated with these content categories. - */ - contentCategoryIds?: string; - /** - * Select only placements that are associated with these directory sites. - */ - directorySiteIds?: string; - /** - * Select only placements that belong to these placement groups. - */ - groupIds?: string; - /** - * Select only placements with these IDs. - */ - ids?: string; - /** - * Select only placements or placement groups whose end date is on or before - * the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". - */ - maxEndDate?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Select only placements or placement groups whose start date is on or - * before the specified maxStartDate. The date should be formatted as - * "yyyy-MM-dd". - */ - maxStartDate?: string; - /** - * Select only placements or placement groups whose end date is on or after - * the specified minEndDate. The date should be formatted as "yyyy-MM-dd". - */ - minEndDate?: string; - /** - * Select only placements or placement groups whose start date is on or - * after the specified minStartDate. The date should be formatted as - * "yyyy-MM-dd". - */ - minStartDate?: string; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * Select only placements with this payment source. - */ - paymentSource?: string; - /** - * Select only placements that are associated with these placement - * strategies. - */ - placementStrategyIds?: string; - /** - * Select only placements with these pricing types. - */ - pricingTypes?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for placements by name or ID. Wildcards (*) are allowed. - * For example, "placement*2015" will return placements with names like - * "placement June 2015", "placement May 2015", or simply "placements 2015". - * Most of the searches also add wildcards implicitly at the start and the - * end of the search string. For example, a search string of "placement" - * will match placements with name "my placement", "placement 2015", or - * simply "placement". - */ - searchString?: string; - /** - * Select only placements that are associated with these sites. - */ - siteIds?: string; - /** - * Select only placements that are associated with these sizes. - */ - sizeIds?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Placements$Patch { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Placement ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Placement; - } - export interface Params$Resource$Placements$Update { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Placement; - } - - - export class Resource$Placementstrategies { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.placementStrategies.delete - * @desc Deletes an existing placement strategy. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Placement strategy ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.placementStrategies.delete(request, function(err) { - * if (err) { - * console.error(err); - * return; - * } - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placementStrategies.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Placement strategy ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - delete( - params?: Params$Resource$Placementstrategies$Delete, - options?: MethodOptions): AxiosPromise; - delete( - params: Params$Resource$Placementstrategies$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( - params: Params$Resource$Placementstrategies$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: Params$Resource$Placementstrategies$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Placementstrategies$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementstrategies$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/placementStrategies/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.placementStrategies.get - * @desc Gets one placement strategy by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Placement strategy ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.placementStrategies.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placementStrategies.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Placement strategy ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Placementstrategies$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Placementstrategies$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Placementstrategies$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Placementstrategies$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Placementstrategies$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementstrategies$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/placementStrategies/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.placementStrategies.insert - * @desc Inserts a new placement strategy. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.placementStrategies.insert(request, function(err, - * response) { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placementStrategies.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().PlacementStrategy} 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$Placementstrategies$Insert, - options?: MethodOptions): AxiosPromise; - insert( - params: Params$Resource$Placementstrategies$Insert, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - insert( - params: Params$Resource$Placementstrategies$Insert, - callback: BodyResponseCallback): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: Params$Resource$Placementstrategies$Insert| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Placementstrategies$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementstrategies$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/placementStrategies') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.placementStrategies.list - * @desc Retrieves a list of placement strategies, possibly filtered. This - * method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var placementStrategiesPage = response['placementStrategies']; - * if (!placementStrategiesPage) { - * return; - * } - * for (var i = 0; i < placementStrategiesPage.length; i++) { - * // TODO: Change code below to process each resource in - * `placementStrategiesPage`: - * console.log(JSON.stringify(placementStrategiesPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.placementStrategies.list(request, handlePage); - * } - * }; - * - * dfareporting.placementStrategies.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placementStrategies.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.ids Select only placement strategies with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "placementstrategy*2015" will return objects with names like "placementstrategy June 2015", "placementstrategy April 2015", or simply "placementstrategy 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementstrategy" will match objects with name "my placementstrategy", "placementstrategy 2015", or simply "placementstrategy". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted 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 - */ - list( - params?: Params$Resource$Placementstrategies$List, - options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Placementstrategies$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - list( - params: Params$Resource$Placementstrategies$List, - callback: BodyResponseCallback): - void; - list(callback: - BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Placementstrategies$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: - BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Placementstrategies$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementstrategies$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/placementStrategies') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * dfareporting.placementStrategies.patch - * @desc Updates an existing placement strategy. This method supports patch - * semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Placement strategy ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.placementStrategies.patch(request, function(err, response) - * { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placementStrategies.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Placement strategy ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().PlacementStrategy} 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 - */ - patch( - params?: Params$Resource$Placementstrategies$Patch, - options?: MethodOptions): AxiosPromise; - patch( - params: Params$Resource$Placementstrategies$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Placementstrategies$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Placementstrategies$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Placementstrategies$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementstrategies$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/placementStrategies') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.placementStrategies.update - * @desc Updates an existing placement strategy. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.placementStrategies.update(request, function(err, - * response) { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placementStrategies.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().PlacementStrategy} 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$Placementstrategies$Update, - options?: MethodOptions): AxiosPromise; - update( - params: Params$Resource$Placementstrategies$Update, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - update( - params: Params$Resource$Placementstrategies$Update, - callback: BodyResponseCallback): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: Params$Resource$Placementstrategies$Update| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Placementstrategies$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementstrategies$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/placementStrategies') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Placementstrategies$Delete { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Placement strategy ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Placementstrategies$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Placement strategy ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Placementstrategies$Insert { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$PlacementStrategy; - } - export interface Params$Resource$Placementstrategies$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Select only placement strategies with these IDs. - */ - ids?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "placementstrategy*2015" will return objects with names like - * "placementstrategy June 2015", "placementstrategy April 2015", or simply - * "placementstrategy 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "placementstrategy" will match objects with name "my - * placementstrategy", "placementstrategy 2015", or simply - * "placementstrategy". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Placementstrategies$Patch { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Placement strategy ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$PlacementStrategy; - } - export interface Params$Resource$Placementstrategies$Update { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$PlacementStrategy; - } - - - export class Resource$Platformtypes { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.platformTypes.get - * @desc Gets one platform type by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Platform type ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.platformTypes.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.platformTypes.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Platform type ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Platformtypes$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Platformtypes$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Platformtypes$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Platformtypes$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Platformtypes$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Platformtypes$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/platformTypes/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.platformTypes.list - * @desc Retrieves a list of platform types. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.platformTypes.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.platformTypes.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with 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 - */ - list(params?: Params$Resource$Platformtypes$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Platformtypes$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Platformtypes$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Platformtypes$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Platformtypes$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Platformtypes$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/platformTypes') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Platformtypes$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Platform type ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Platformtypes$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - - export class Resource$Postalcodes { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.postalCodes.get - * @desc Gets one postal code by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Postal code ID. - * code: 'my-code', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.postalCodes.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.postalCodes.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.code Postal code ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Postalcodes$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Postalcodes$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Postalcodes$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Postalcodes$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Postalcodes$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Postalcodes$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/postalCodes/{code}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'code'], - pathParams: ['code', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.postalCodes.list - * @desc Retrieves a list of postal codes. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.postalCodes.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.postalCodes.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with 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 - */ - list(params?: Params$Resource$Postalcodes$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Postalcodes$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Postalcodes$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Postalcodes$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Postalcodes$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Postalcodes$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/postalCodes') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Postalcodes$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Postal code ID. - */ - code?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Postalcodes$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - - export class Resource$Projects { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.projects.get - * @desc Gets one project by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Project ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.projects.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.projects.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Project ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Projects$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Projects$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Projects$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Projects$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Projects$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/projects/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.projects.list - * @desc Retrieves a list of projects, possibly filtered. This method - * supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var projectsPage = response['projects']; - * if (!projectsPage) { - * return; - * } - * for (var i = 0; i < projectsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `projectsPage`: console.log(JSON.stringify(projectsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.projects.list(request, handlePage); - * } - * }; - * - * dfareporting.projects.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.projects.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserIds Select only projects with these advertiser IDs. - * @param {string=} params.ids Select only projects with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, "project*2015" will return projects with names like "project June 2015", "project April 2015", or simply "project 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "project" will match projects with name "my project", "project 2015", or simply "project". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted 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 - */ - list(params?: Params$Resource$Projects$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Projects$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Projects$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Projects$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Projects$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/projects') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Project ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Projects$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Select only projects with these advertiser IDs. - */ - advertiserIds?: string; - /** - * Select only projects with these IDs. - */ - ids?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for projects by name or ID. Wildcards (*) are allowed. - * For example, "project*2015" will return projects with names like "project - * June 2015", "project April 2015", or simply "project 2015". Most of the - * searches also add wildcards implicitly at the start and the end of the - * search string. For example, a search string of "project" will match - * projects with name "my project", "project 2015", or simply "project". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - - - export class Resource$Regions { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.regions.list - * @desc Retrieves a list of regions. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.regions.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.regions.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with 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 - */ - list(params?: Params$Resource$Regions$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Regions$List, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Regions$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Regions$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Regions$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Regions$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/regions') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Regions$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - - export class Resource$Remarketinglists { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.remarketingLists.get - * @desc Gets one remarketing list by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Remarketing list ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.remarketingLists.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.remarketingLists.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Remarketing list ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Remarketinglists$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Remarketinglists$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Remarketinglists$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Remarketinglists$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Remarketinglists$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Remarketinglists$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/remarketingLists/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.remarketingLists.insert - * @desc Inserts a new remarketing list. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.remarketingLists.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.remarketingLists.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().RemarketingList} 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$Remarketinglists$Insert, - options?: MethodOptions): AxiosPromise; - insert( - params: Params$Resource$Remarketinglists$Insert, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - insert( - params: Params$Resource$Remarketinglists$Insert, - callback: BodyResponseCallback): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: Params$Resource$Remarketinglists$Insert| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Remarketinglists$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Remarketinglists$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/remarketingLists') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.remarketingLists.list - * @desc Retrieves a list of remarketing lists, possibly filtered. This - * method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Select only remarketing lists owned by this advertiser. - * advertiserId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var remarketingListsPage = response['remarketingLists']; - * if (!remarketingListsPage) { - * return; - * } - * for (var i = 0; i < remarketingListsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `remarketingListsPage`: - * console.log(JSON.stringify(remarketingListsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.remarketingLists.list(request, handlePage); - * } - * }; - * - * dfareporting.remarketingLists.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.remarketingLists.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.active Select only active or only inactive remarketing lists. - * @param {string} params.advertiserId Select only remarketing lists owned by this advertiser. - * @param {string=} params.floodlightActivityId Select only remarketing lists that have this floodlight activity ID. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.name Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list". - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted 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 - */ - list( - params?: Params$Resource$Remarketinglists$List, - options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Remarketinglists$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - list( - params: Params$Resource$Remarketinglists$List, - callback: BodyResponseCallback): - void; - list(callback: BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Remarketinglists$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Remarketinglists$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Remarketinglists$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/remarketingLists') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'advertiserId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * dfareporting.remarketingLists.patch - * @desc Updates an existing remarketing list. This method supports patch - * semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Remarketing list ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.remarketingLists.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.remarketingLists.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Remarketing list ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().RemarketingList} 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 - */ - patch( - params?: Params$Resource$Remarketinglists$Patch, - options?: MethodOptions): AxiosPromise; - patch( - params: Params$Resource$Remarketinglists$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Remarketinglists$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Remarketinglists$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Remarketinglists$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Remarketinglists$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/remarketingLists') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.remarketingLists.update - * @desc Updates an existing remarketing list. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.remarketingLists.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.remarketingLists.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().RemarketingList} 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$Remarketinglists$Update, - options?: MethodOptions): AxiosPromise; - update( - params: Params$Resource$Remarketinglists$Update, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - update( - params: Params$Resource$Remarketinglists$Update, - callback: BodyResponseCallback): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: Params$Resource$Remarketinglists$Update| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Remarketinglists$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Remarketinglists$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/remarketingLists') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Remarketinglists$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Remarketing list ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Remarketinglists$Insert { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RemarketingList; - } - export interface Params$Resource$Remarketinglists$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Select only active or only inactive remarketing lists. - */ - active?: boolean; - /** - * Select only remarketing lists owned by this advertiser. - */ - advertiserId?: string; - /** - * Select only remarketing lists that have this floodlight activity ID. - */ - floodlightActivityId?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "remarketing list*2015" will return objects with names like - * "remarketing list June 2015", "remarketing list April 2015", or simply - * "remarketing list 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "remarketing list" will match objects with name "my - * remarketing list", "remarketing list 2015", or simply "remarketing list". - */ - name?: string; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Remarketinglists$Patch { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Remarketing list ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RemarketingList; - } - export interface Params$Resource$Remarketinglists$Update { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RemarketingList; - } - - - export class Resource$Remarketinglistshares { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.remarketingListShares.get - * @desc Gets one remarketing list share by remarketing list ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Remarketing list ID. - * remarketingListId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.remarketingListShares.get(request, function(err, response) - * { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.remarketingListShares.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {string} params.remarketingListId Remarketing list 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 - */ - get(params?: Params$Resource$Remarketinglistshares$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Remarketinglistshares$Get, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Remarketinglistshares$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Remarketinglistshares$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Remarketinglistshares$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Remarketinglistshares$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/remarketingListShares/{remarketingListId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'remarketingListId'], - pathParams: ['profileId', 'remarketingListId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.remarketingListShares.patch - * @desc Updates an existing remarketing list share. This method supports - * patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Remarketing list ID. - * remarketingListId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.remarketingListShares.patch(request, function(err, - * response) { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.remarketingListShares.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {string} params.remarketingListId Remarketing list ID. - * @param {().RemarketingListShare} 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 - */ - patch( - params?: Params$Resource$Remarketinglistshares$Patch, - options?: MethodOptions): AxiosPromise; - patch( - params: Params$Resource$Remarketinglistshares$Patch, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Remarketinglistshares$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Remarketinglistshares$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Remarketinglistshares$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Remarketinglistshares$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/remarketingListShares') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'remarketingListId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.remarketingListShares.update - * @desc Updates an existing remarketing list share. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.remarketingListShares.update(request, function(err, - * response) { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.remarketingListShares.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().RemarketingListShare} 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$Remarketinglistshares$Update, - options?: MethodOptions): AxiosPromise; - update( - params: Params$Resource$Remarketinglistshares$Update, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - update( - params: Params$Resource$Remarketinglistshares$Update, - callback: BodyResponseCallback): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: Params$Resource$Remarketinglistshares$Update| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Remarketinglistshares$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Remarketinglistshares$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/remarketingListShares') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Remarketinglistshares$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Remarketing list ID. - */ - remarketingListId?: string; - } - export interface Params$Resource$Remarketinglistshares$Patch { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Remarketing list ID. - */ - remarketingListId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RemarketingListShare; - } - export interface Params$Resource$Remarketinglistshares$Update { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RemarketingListShare; - } - - - export class Resource$Reports { - root: Dfareporting; - compatibleFields: Resource$Reports$Compatiblefields; - files: Resource$Reports$Files; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - this.compatibleFields = new Resource$Reports$Compatiblefields(root); - this.files = new Resource$Reports$Files(root); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.reports.delete - * @desc Deletes a report by its ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // The DFA user profile ID. - * profileId: '0', // TODO: Update placeholder value. - * - * // The ID of the report. - * reportId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.reports.delete(request, function(err) { - * if (err) { - * console.error(err); - * return; - * } - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfareporting' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.reports.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId The DFA user profile ID. - * @param {string} params.reportId The ID of the 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 - */ - delete(params?: Params$Resource$Reports$Delete, options?: MethodOptions): - AxiosPromise; - delete( - params: Params$Resource$Reports$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( - params: Params$Resource$Reports$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: Params$Resource$Reports$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Reports$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reports$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/reports/{reportId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['profileId', 'reportId'], - pathParams: ['profileId', 'reportId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.reports.get - * @desc Retrieves a report by its ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // The DFA user profile ID. - * profileId: '0', // TODO: Update placeholder value. - * - * // The ID of the report. - * reportId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.reports.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfareporting' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.reports.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId The DFA user profile ID. - * @param {string} params.reportId The ID of the 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 - */ - get(params?: Params$Resource$Reports$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Reports$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Reports$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Reports$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Reports$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reports$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/reports/{reportId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'reportId'], - pathParams: ['profileId', 'reportId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.reports.insert - * @desc Creates a report. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // The DFA user profile ID. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.reports.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfareporting' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.reports.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId The DFA user profile ID. - * @param {().Report} 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$Reports$Insert, options?: MethodOptions): - AxiosPromise; - insert( - params: Params$Resource$Reports$Insert, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - insert( - params: Params$Resource$Reports$Insert, - callback: BodyResponseCallback): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: Params$Resource$Reports$Insert| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Reports$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reports$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/reports') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.reports.list - * @desc Retrieves list of reports. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // The DFA user profile ID. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var itemsPage = response['items']; - * if (!itemsPage) { - * return; - * } - * for (var i = 0; i < itemsPage.length; i++) { - * // TODO: Change code below to process each resource in `itemsPage`: - * console.log(JSON.stringify(itemsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.reports.list(request, handlePage); - * } - * }; - * - * dfareporting.reports.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfareporting' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.reports.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken The value of the nextToken from the previous result page. - * @param {string} params.profileId The DFA user profile ID. - * @param {string=} params.scope The scope that defines which results are returned. - * @param {string=} params.sortField The field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted 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 - */ - list(params?: Params$Resource$Reports$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Reports$List, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Reports$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Reports$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Reports$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reports$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/reports') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.reports.patch - * @desc Updates a report. This method supports patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // The DFA user profile ID. - * profileId: '0', // TODO: Update placeholder value. - * - * // The ID of the report. - * reportId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.reports.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfareporting' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.reports.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId The DFA user profile ID. - * @param {string} params.reportId The ID of the report. - * @param {().Report} 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 - */ - patch(params?: Params$Resource$Reports$Patch, options?: MethodOptions): - AxiosPromise; - patch( - params: Params$Resource$Reports$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Reports$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Reports$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Reports$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reports$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/reports/{reportId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'reportId'], - pathParams: ['profileId', 'reportId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.reports.run - * @desc Runs a report. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // The DFA profile ID. - * profileId: '0', // TODO: Update placeholder value. - * - * // The ID of the report. - * reportId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.reports.run(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfareporting' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.reports.run - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId The DFA profile ID. - * @param {string} params.reportId The ID of the report. - * @param {boolean=} params.synchronous If set and true, tries to run the report synchronously. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - run(params?: Params$Resource$Reports$Run, - options?: MethodOptions): AxiosPromise; - run(params: Params$Resource$Reports$Run, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - run(params: Params$Resource$Reports$Run, - callback: BodyResponseCallback): void; - run(callback: BodyResponseCallback): void; - run(paramsOrCallback?: Params$Resource$Reports$Run| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Reports$Run; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reports$Run; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/reports/{reportId}/run') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId', 'reportId'], - pathParams: ['profileId', 'reportId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.reports.update - * @desc Updates a report. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // The DFA user profile ID. - * profileId: '0', // TODO: Update placeholder value. - * - * // The ID of the report. - * reportId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.reports.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfareporting' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.reports.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId The DFA user profile ID. - * @param {string} params.reportId The ID of the report. - * @param {().Report} 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$Reports$Update, options?: MethodOptions): - AxiosPromise; - update( - params: Params$Resource$Reports$Update, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - update( - params: Params$Resource$Reports$Update, - callback: BodyResponseCallback): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: Params$Resource$Reports$Update| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Reports$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reports$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/reports/{reportId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId', 'reportId'], - pathParams: ['profileId', 'reportId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Reports$Delete { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The DFA user profile ID. - */ - profileId?: string; - /** - * The ID of the report. - */ - reportId?: string; - } - export interface Params$Resource$Reports$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The DFA user profile ID. - */ - profileId?: string; - /** - * The ID of the report. - */ - reportId?: string; - } - export interface Params$Resource$Reports$Insert { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The DFA user profile ID. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Report; - } - export interface Params$Resource$Reports$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * The value of the nextToken from the previous result page. - */ - pageToken?: string; - /** - * The DFA user profile ID. - */ - profileId?: string; - /** - * The scope that defines which results are returned. - */ - scope?: string; - /** - * The field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Reports$Patch { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The DFA user profile ID. - */ - profileId?: string; - /** - * The ID of the report. - */ - reportId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Report; - } - export interface Params$Resource$Reports$Run { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The DFA profile ID. - */ - profileId?: string; - /** - * The ID of the report. - */ - reportId?: string; - /** - * If set and true, tries to run the report synchronously. - */ - synchronous?: boolean; - } - export interface Params$Resource$Reports$Update { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The DFA user profile ID. - */ - profileId?: string; - /** - * The ID of the report. - */ - reportId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Report; - } - - export class Resource$Reports$Compatiblefields { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.reports.compatibleFields.query - * @desc Returns the fields that are compatible to be selected in the - * respective sections of a report criteria, given the fields already - * selected in the input report and user permissions. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // The DFA user profile ID. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.reports.compatibleFields.query(request, function(err, - * response) { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfareporting' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.reports.compatibleFields.query - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId The DFA user profile ID. - * @param {().Report} 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 - */ - query( - params?: Params$Resource$Reports$Compatiblefields$Query, - options?: MethodOptions): AxiosPromise; - query( - params: Params$Resource$Reports$Compatiblefields$Query, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - query( - params: Params$Resource$Reports$Compatiblefields$Query, - callback: BodyResponseCallback): void; - query(callback: BodyResponseCallback): void; - query( - paramsOrCallback?: Params$Resource$Reports$Compatiblefields$Query| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Reports$Compatiblefields$Query; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reports$Compatiblefields$Query; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/reports/compatiblefields/query') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Reports$Compatiblefields$Query { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The DFA user profile ID. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Report; - } - - - export class Resource$Reports$Files { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.reports.files.get - * @desc Retrieves a report file. This method supports media download. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // The DFA profile ID. - * profileId: '0', // TODO: Update placeholder value. - * - * // The ID of the report. - * reportId: '0', // TODO: Update placeholder value. - * - * // The ID of the report file. - * fileId: '0', // TODO: Update placeholder value. - * - * // TODO: To download media content, use: - * // - * // alt: 'media', - * - * auth: authClient, - * }; - * - * dfareporting.reports.files.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfareporting' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.reports.files.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.fileId The ID of the report file. - * @param {string} params.profileId The DFA profile ID. - * @param {string} params.reportId The ID of the 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 - */ - get(params?: Params$Resource$Reports$Files$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Reports$Files$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Reports$Files$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Reports$Files$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Reports$Files$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reports$Files$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/reports/{reportId}/files/{fileId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'reportId', 'fileId'], - pathParams: ['fileId', 'profileId', 'reportId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.reports.files.list - * @desc Lists files for a report. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // The DFA profile ID. - * profileId: '0', // TODO: Update placeholder value. - * - * // The ID of the parent report. - * reportId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var itemsPage = response['items']; - * if (!itemsPage) { - * return; - * } - * for (var i = 0; i < itemsPage.length; i++) { - * // TODO: Change code below to process each resource in `itemsPage`: - * console.log(JSON.stringify(itemsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.reports.files.list(request, handlePage); - * } - * }; - * - * dfareporting.reports.files.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfareporting' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.reports.files.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken The value of the nextToken from the previous result page. - * @param {string} params.profileId The DFA profile ID. - * @param {string} params.reportId The ID of the parent report. - * @param {string=} params.sortField The field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted 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 - */ - list(params?: Params$Resource$Reports$Files$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Reports$Files$List, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Reports$Files$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Reports$Files$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Reports$Files$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reports$Files$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/reports/{reportId}/files') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'reportId'], - pathParams: ['profileId', 'reportId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Reports$Files$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the report file. - */ - fileId?: string; - /** - * The DFA profile ID. - */ - profileId?: string; - /** - * The ID of the report. - */ - reportId?: string; - } - export interface Params$Resource$Reports$Files$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * The value of the nextToken from the previous result page. - */ - pageToken?: string; - /** - * The DFA profile ID. - */ - profileId?: string; - /** - * The ID of the parent report. - */ - reportId?: string; - /** - * The field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - - - - export class Resource$Sites { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.sites.get - * @desc Gets one site by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Site ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.sites.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.sites.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Site ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Sites$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Sites$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Sites$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Sites$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Sites$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Sites$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/sites/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.sites.insert - * @desc Inserts a new site. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.sites.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.sites.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Site} 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$Sites$Insert, options?: MethodOptions): - AxiosPromise; - insert( - params: Params$Resource$Sites$Insert, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - insert( - params: Params$Resource$Sites$Insert, - callback: BodyResponseCallback): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: Params$Resource$Sites$Insert| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Sites$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Sites$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/sites') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.sites.list - * @desc Retrieves a list of sites, possibly filtered. This method supports - * paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var sitesPage = response['sites']; - * if (!sitesPage) { - * return; - * } - * for (var i = 0; i < sitesPage.length; i++) { - * // TODO: Change code below to process each resource in `sitesPage`: - * console.log(JSON.stringify(sitesPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.sites.list(request, handlePage); - * } - * }; - * - * dfareporting.sites.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.sites.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.acceptsInStreamVideoPlacements This search filter is no longer supported and will have no effect on the results returned. - * @param {boolean=} params.acceptsInterstitialPlacements This search filter is no longer supported and will have no effect on the results returned. - * @param {boolean=} params.acceptsPublisherPaidPlacements Select only sites that accept publisher paid placements. - * @param {boolean=} params.adWordsSite Select only AdWords sites. - * @param {boolean=} params.approved Select only approved sites. - * @param {string=} params.campaignIds Select only sites with these campaign IDs. - * @param {string=} params.directorySiteIds Select only sites with these directory site IDs. - * @param {string=} params.ids Select only sites with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, "site*2015" will return objects with names like "site June 2015", "site April 2015", or simply "site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "site" will match objects with name "my site", "site 2015", or simply "site". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {string=} params.subaccountId Select only sites with this subaccount ID. - * @param {boolean=} params.unmappedSite Select only sites that have not been mapped to a directory site. - * @param {object} [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$Sites$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Sites$List, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Sites$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Sites$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Sites$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Sites$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/sites') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.sites.patch - * @desc Updates an existing site. This method supports patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Site ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.sites.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.sites.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Site ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Site} 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 - */ - patch(params?: Params$Resource$Sites$Patch, options?: MethodOptions): - AxiosPromise; - patch( - params: Params$Resource$Sites$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Sites$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Sites$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Sites$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Sites$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/sites') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.sites.update - * @desc Updates an existing site. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.sites.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.sites.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Site} 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$Sites$Update, options?: MethodOptions): - AxiosPromise; - update( - params: Params$Resource$Sites$Update, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - update( - params: Params$Resource$Sites$Update, - callback: BodyResponseCallback): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: Params$Resource$Sites$Update| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Sites$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Sites$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/sites') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Sites$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Site ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Sites$Insert { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Site; - } - export interface Params$Resource$Sites$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * This search filter is no longer supported and will have no effect on the - * results returned. - */ - acceptsInStreamVideoPlacements?: boolean; - /** - * This search filter is no longer supported and will have no effect on the - * results returned. - */ - acceptsInterstitialPlacements?: boolean; - /** - * Select only sites that accept publisher paid placements. - */ - acceptsPublisherPaidPlacements?: boolean; - /** - * Select only AdWords sites. - */ - adWordsSite?: boolean; - /** - * Select only approved sites. - */ - approved?: boolean; - /** - * Select only sites with these campaign IDs. - */ - campaignIds?: string; - /** - * Select only sites with these directory site IDs. - */ - directorySiteIds?: string; - /** - * Select only sites with these IDs. - */ - ids?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name, ID or keyName. Wildcards (*) are - * allowed. For example, "site*2015" will return objects with names like - * "site June 2015", "site April 2015", or simply "site 2015". Most of the - * searches also add wildcards implicitly at the start and the end of the - * search string. For example, a search string of "site" will match objects - * with name "my site", "site 2015", or simply "site". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - /** - * Select only sites with this subaccount ID. - */ - subaccountId?: string; - /** - * Select only sites that have not been mapped to a directory site. - */ - unmappedSite?: boolean; - } - export interface Params$Resource$Sites$Patch { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Site ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Site; - } - export interface Params$Resource$Sites$Update { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Site; - } - - - export class Resource$Sizes { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.sizes.get - * @desc Gets one size by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Size ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.sizes.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.sizes.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Size ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Sizes$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Sizes$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Sizes$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Sizes$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Sizes$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Sizes$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/sizes/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.sizes.insert - * @desc Inserts a new size. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.sizes.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.sizes.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Size} 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$Sizes$Insert, options?: MethodOptions): - AxiosPromise; - insert( - params: Params$Resource$Sizes$Insert, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - insert( - params: Params$Resource$Sizes$Insert, - callback: BodyResponseCallback): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: Params$Resource$Sizes$Insert| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Sizes$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Sizes$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/sizes') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.sizes.list - * @desc Retrieves a list of sizes, possibly filtered. Retrieved sizes are - * globally unique and may include values not currently in use by your - * account. Due to this, the list of sizes returned by this method may - * differ from the list seen in the Trafficking UI. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.sizes.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.sizes.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.height Select only sizes with this height. - * @param {boolean=} params.iabStandard Select only IAB standard sizes. - * @param {string=} params.ids Select only sizes with these IDs. - * @param {string} params.profileId User profile ID associated with this request. - * @param {integer=} params.width Select only sizes with this width. - * @param {object} [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$Sizes$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Sizes$List, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Sizes$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Sizes$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Sizes$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Sizes$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/sizes') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Sizes$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Size ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Sizes$Insert { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Size; - } - export interface Params$Resource$Sizes$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Select only sizes with this height. - */ - height?: number; - /** - * Select only IAB standard sizes. - */ - iabStandard?: boolean; - /** - * Select only sizes with these IDs. - */ - ids?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Select only sizes with this width. - */ - width?: number; - } - - - export class Resource$Subaccounts { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.subaccounts.get - * @desc Gets one subaccount by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Subaccount ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.subaccounts.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.subaccounts.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Subaccount ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Subaccounts$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Subaccounts$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Subaccounts$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Subaccounts$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Subaccounts$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Subaccounts$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/subaccounts/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.subaccounts.insert - * @desc Inserts a new subaccount. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.subaccounts.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.subaccounts.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Subaccount} 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$Subaccounts$Insert, - options?: MethodOptions): AxiosPromise; - insert( - params: Params$Resource$Subaccounts$Insert, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - insert( - params: Params$Resource$Subaccounts$Insert, - callback: BodyResponseCallback): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: Params$Resource$Subaccounts$Insert| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Subaccounts$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Subaccounts$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/subaccounts') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.subaccounts.list - * @desc Gets a list of subaccounts, possibly filtered. This method supports - * paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var subaccountsPage = response['subaccounts']; - * if (!subaccountsPage) { - * return; - * } - * for (var i = 0; i < subaccountsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `subaccountsPage`: console.log(JSON.stringify(subaccountsPage[i], null, - * 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.subaccounts.list(request, handlePage); - * } - * }; - * - * dfareporting.subaccounts.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.subaccounts.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.ids Select only subaccounts with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "subaccount*2015" will return objects with names like "subaccount June 2015", "subaccount April 2015", or simply "subaccount 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "subaccount" will match objects with name "my subaccount", "subaccount 2015", or simply "subaccount". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted 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 - */ - list(params?: Params$Resource$Subaccounts$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Subaccounts$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Subaccounts$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Subaccounts$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Subaccounts$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Subaccounts$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/subaccounts') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.subaccounts.patch - * @desc Updates an existing subaccount. This method supports patch - * semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Subaccount ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.subaccounts.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.subaccounts.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Subaccount ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Subaccount} 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 - */ - patch(params?: Params$Resource$Subaccounts$Patch, options?: MethodOptions): - AxiosPromise; - patch( - params: Params$Resource$Subaccounts$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Subaccounts$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Subaccounts$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Subaccounts$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Subaccounts$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/subaccounts') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.subaccounts.update - * @desc Updates an existing subaccount. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.subaccounts.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.subaccounts.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Subaccount} 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$Subaccounts$Update, - options?: MethodOptions): AxiosPromise; - update( - params: Params$Resource$Subaccounts$Update, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - update( - params: Params$Resource$Subaccounts$Update, - callback: BodyResponseCallback): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: Params$Resource$Subaccounts$Update| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Subaccounts$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Subaccounts$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/subaccounts') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Subaccounts$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Subaccount ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Subaccounts$Insert { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Subaccount; - } - export interface Params$Resource$Subaccounts$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Select only subaccounts with these IDs. - */ - ids?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "subaccount*2015" will return objects with names like - * "subaccount June 2015", "subaccount April 2015", or simply "subaccount - * 2015". Most of the searches also add wildcards implicitly at the start - * and the end of the search string. For example, a search string of - * "subaccount" will match objects with name "my subaccount", "subaccount - * 2015", or simply "subaccount". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Subaccounts$Patch { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Subaccount ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Subaccount; - } - export interface Params$Resource$Subaccounts$Update { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Subaccount; - } - - - export class Resource$Targetableremarketinglists { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.targetableRemarketingLists.get - * @desc Gets one remarketing list by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Remarketing list ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.targetableRemarketingLists.get(request, function(err, - * response) { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.targetableRemarketingLists.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Remarketing list ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Targetableremarketinglists$Get, - options?: MethodOptions): - AxiosPromise; - get(params: Params$Resource$Targetableremarketinglists$Get, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Targetableremarketinglists$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Targetableremarketinglists$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Targetableremarketinglists$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Targetableremarketinglists$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/targetableRemarketingLists/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.targetableRemarketingLists.list - * @desc Retrieves a list of targetable remarketing lists, possibly - * filtered. This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Select only targetable remarketing lists targetable by these - * advertisers. advertiserId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var targetableRemarketingListsPage = - * response['targetableRemarketingLists']; if - * (!targetableRemarketingListsPage) { return; - * } - * for (var i = 0; i < targetableRemarketingListsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `targetableRemarketingListsPage`: - * console.log(JSON.stringify(targetableRemarketingListsPage[i], null, - * 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.targetableRemarketingLists.list(request, handlePage); - * } - * }; - * - * dfareporting.targetableRemarketingLists.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.targetableRemarketingLists.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.active Select only active or only inactive targetable remarketing lists. - * @param {string} params.advertiserId Select only targetable remarketing lists targetable by these advertisers. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.name Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list". - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted 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 - */ - list( - params?: Params$Resource$Targetableremarketinglists$List, - options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Targetableremarketinglists$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback< - Schema$TargetableRemarketingListsListResponse>): void; - list( - params: Params$Resource$Targetableremarketinglists$List, - callback: BodyResponseCallback< - Schema$TargetableRemarketingListsListResponse>): void; - list(callback: BodyResponseCallback< - Schema$TargetableRemarketingListsListResponse>): void; - list( - paramsOrCallback?: Params$Resource$Targetableremarketinglists$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$TargetableRemarketingListsListResponse>): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Targetableremarketinglists$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Targetableremarketinglists$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/targetableRemarketingLists') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'advertiserId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - } - - export interface Params$Resource$Targetableremarketinglists$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Remarketing list ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Targetableremarketinglists$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Select only active or only inactive targetable remarketing lists. - */ - active?: boolean; - /** - * Select only targetable remarketing lists targetable by these advertisers. - */ - advertiserId?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "remarketing list*2015" will return objects with names like - * "remarketing list June 2015", "remarketing list April 2015", or simply - * "remarketing list 2015". Most of the searches also add wildcards - * implicitly at the start and the end of the search string. For example, a - * search string of "remarketing list" will match objects with name "my - * remarketing list", "remarketing list 2015", or simply "remarketing list". - */ - name?: string; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - - - export class Resource$Targetingtemplates { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.targetingTemplates.get - * @desc Gets one targeting template by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Targeting template ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.targetingTemplates.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.targetingTemplates.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Targeting template ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Targetingtemplates$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Targetingtemplates$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Targetingtemplates$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Targetingtemplates$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Targetingtemplates$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Targetingtemplates$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/targetingTemplates/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.targetingTemplates.insert - * @desc Inserts a new targeting template. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.targetingTemplates.insert(request, function(err, response) - * { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.targetingTemplates.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().TargetingTemplate} 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$Targetingtemplates$Insert, - options?: MethodOptions): AxiosPromise; - insert( - params: Params$Resource$Targetingtemplates$Insert, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - insert( - params: Params$Resource$Targetingtemplates$Insert, - callback: BodyResponseCallback): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: Params$Resource$Targetingtemplates$Insert| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Targetingtemplates$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Targetingtemplates$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/targetingTemplates') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.targetingTemplates.list - * @desc Retrieves a list of targeting templates, optionally filtered. This - * method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var targetingTemplatesPage = response['targetingTemplates']; - * if (!targetingTemplatesPage) { - * return; - * } - * for (var i = 0; i < targetingTemplatesPage.length; i++) { - * // TODO: Change code below to process each resource in - * `targetingTemplatesPage`: - * console.log(JSON.stringify(targetingTemplatesPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.targetingTemplates.list(request, handlePage); - * } - * }; - * - * dfareporting.targetingTemplates.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.targetingTemplates.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserId Select only targeting templates with this advertiser ID. - * @param {string=} params.ids Select only targeting templates with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "template*2015" will return objects with names like "template June 2015", "template April 2015", or simply "template 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "template" will match objects with name "my template", "template 2015", or simply "template". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted 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 - */ - list( - params?: Params$Resource$Targetingtemplates$List, - options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Targetingtemplates$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - list( - params: Params$Resource$Targetingtemplates$List, - callback: BodyResponseCallback): - void; - list(callback: BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Targetingtemplates$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Targetingtemplates$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Targetingtemplates$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/targetingTemplates') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * dfareporting.targetingTemplates.patch - * @desc Updates an existing targeting template. This method supports patch - * semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Targeting template ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.targetingTemplates.patch(request, function(err, response) - * { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.targetingTemplates.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Targeting template ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().TargetingTemplate} 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 - */ - patch( - params?: Params$Resource$Targetingtemplates$Patch, - options?: MethodOptions): AxiosPromise; - patch( - params: Params$Resource$Targetingtemplates$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Targetingtemplates$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Targetingtemplates$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Targetingtemplates$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Targetingtemplates$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/targetingTemplates') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.targetingTemplates.update - * @desc Updates an existing targeting template. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.targetingTemplates.update(request, function(err, response) - * { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.targetingTemplates.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().TargetingTemplate} 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$Targetingtemplates$Update, - options?: MethodOptions): AxiosPromise; - update( - params: Params$Resource$Targetingtemplates$Update, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - update( - params: Params$Resource$Targetingtemplates$Update, - callback: BodyResponseCallback): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: Params$Resource$Targetingtemplates$Update| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Targetingtemplates$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Targetingtemplates$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/targetingTemplates') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Targetingtemplates$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Targeting template ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Targetingtemplates$Insert { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TargetingTemplate; - } - export interface Params$Resource$Targetingtemplates$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Select only targeting templates with this advertiser ID. - */ - advertiserId?: string; - /** - * Select only targeting templates with these IDs. - */ - ids?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "template*2015" will return objects with names like - * "template June 2015", "template April 2015", or simply "template 2015". - * Most of the searches also add wildcards implicitly at the start and the - * end of the search string. For example, a search string of "template" will - * match objects with name "my template", "template 2015", or simply - * "template". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Targetingtemplates$Patch { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Targeting template ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TargetingTemplate; - } - export interface Params$Resource$Targetingtemplates$Update { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TargetingTemplate; - } - - - export class Resource$Userprofiles { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.userProfiles.get - * @desc Gets one user profile by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // The user profile ID. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.userProfiles.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using one of the following scopes: - * // 'https://www.googleapis.com/auth/dfareporting' - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.userProfiles.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId The user profile 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 - */ - get(params?: Params$Resource$Userprofiles$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Userprofiles$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Userprofiles$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Userprofiles$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Userprofiles$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userprofiles$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/dfareporting/v2.8/userprofiles/{profileId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.userProfiles.list - * @desc Retrieves list of user profiles for a user. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * auth: authClient, - * }; - * - * dfareporting.userProfiles.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using one of the following scopes: - * // 'https://www.googleapis.com/auth/dfareporting' - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.userProfiles.list - * @memberOf! () - * - * @param {object=} params Parameters for 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 - */ - list(params?: Params$Resource$Userprofiles$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Userprofiles$List, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Userprofiles$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Userprofiles$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Userprofiles$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userprofiles$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/dfareporting/v2.8/userprofiles') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: [], - pathParams: [], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Userprofiles$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The user profile ID. - */ - profileId?: string; - } - export interface Params$Resource$Userprofiles$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - } - - - export class Resource$Userrolepermissiongroups { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.userRolePermissionGroups.get - * @desc Gets one user role permission group by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // User role permission group ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.userRolePermissionGroups.get(request, function(err, - * response) { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.userRolePermissionGroups.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id User role permission group ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Userrolepermissiongroups$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Userrolepermissiongroups$Get, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Userrolepermissiongroups$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Userrolepermissiongroups$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Userrolepermissiongroups$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userrolepermissiongroups$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/userRolePermissionGroups/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.userRolePermissionGroups.list - * @desc Gets a list of all supported user role permission groups. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.userRolePermissionGroups.list(request, function(err, - * response) { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.userRolePermissionGroups.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with 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 - */ - list( - params?: Params$Resource$Userrolepermissiongroups$List, - options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Userrolepermissiongroups$List, - options: MethodOptions| - BodyResponseCallback, - callback: - BodyResponseCallback): - void; - list( - params: Params$Resource$Userrolepermissiongroups$List, - callback: - BodyResponseCallback): - void; - list(callback: - BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Userrolepermissiongroups$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: - BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Userrolepermissiongroups$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userrolepermissiongroups$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/userRolePermissionGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - } - - export interface Params$Resource$Userrolepermissiongroups$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User role permission group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Userrolepermissiongroups$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - - export class Resource$Userrolepermissions { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.userRolePermissions.get - * @desc Gets one user role permission by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // User role permission ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.userRolePermissions.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.userRolePermissions.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id User role permission ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Userrolepermissions$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Userrolepermissions$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Userrolepermissions$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Userrolepermissions$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Userrolepermissions$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userrolepermissions$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/userRolePermissions/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.userRolePermissions.list - * @desc Gets a list of user role permissions, possibly filtered. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.userRolePermissions.list(request, function(err, response) - * { if (err) { console.error(err); return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.userRolePermissions.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.ids Select only user role permissions with these IDs. - * @param {string} params.profileId User profile ID associated with 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 - */ - list( - params?: Params$Resource$Userrolepermissions$List, - options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Userrolepermissions$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - list( - params: Params$Resource$Userrolepermissions$List, - callback: BodyResponseCallback): - void; - list(callback: - BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Userrolepermissions$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: - BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Userrolepermissions$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userrolepermissions$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/userRolePermissions') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - } - - export interface Params$Resource$Userrolepermissions$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User role permission ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Userrolepermissions$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Select only user role permissions with these IDs. - */ - ids?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - - export class Resource$Userroles { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.userRoles.delete - * @desc Deletes an existing user role. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // User role ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.userRoles.delete(request, function(err) { - * if (err) { - * console.error(err); - * return; - * } - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.userRoles.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id User role ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - delete(params?: Params$Resource$Userroles$Delete, options?: MethodOptions): - AxiosPromise; - delete( - params: Params$Resource$Userroles$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( - params: Params$Resource$Userroles$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: Params$Resource$Userroles$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Userroles$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userroles$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/userRoles/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.userRoles.get - * @desc Gets one user role by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // User role ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.userRoles.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.userRoles.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id User role ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Userroles$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Userroles$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Userroles$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Userroles$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Userroles$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userroles$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/userRoles/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.userRoles.insert - * @desc Inserts a new user role. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.userRoles.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.userRoles.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().UserRole} 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$Userroles$Insert, options?: MethodOptions): - AxiosPromise; - insert( - params: Params$Resource$Userroles$Insert, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - insert( - params: Params$Resource$Userroles$Insert, - callback: BodyResponseCallback): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: Params$Resource$Userroles$Insert| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Userroles$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userroles$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/userRoles') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.userRoles.list - * @desc Retrieves a list of user roles, possibly filtered. This method - * supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var userRolesPage = response['userRoles']; - * if (!userRolesPage) { - * return; - * } - * for (var i = 0; i < userRolesPage.length; i++) { - * // TODO: Change code below to process each resource in - * `userRolesPage`: console.log(JSON.stringify(userRolesPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.userRoles.list(request, handlePage); - * } - * }; - * - * dfareporting.userRoles.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.userRoles.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.accountUserRoleOnly Select only account level user roles not associated with any specific subaccount. - * @param {string=} params.ids Select only user roles with the specified IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "userrole*2015" will return objects with names like "userrole June 2015", "userrole April 2015", or simply "userrole 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "userrole" will match objects with name "my userrole", "userrole 2015", or simply "userrole". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {string=} params.subaccountId Select only user roles that belong to this subaccount. - * @param {object} [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$Userroles$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Userroles$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Userroles$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Userroles$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Userroles$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userroles$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/userRoles') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.userRoles.patch - * @desc Updates an existing user role. This method supports patch - * semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // User role ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these - * properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.userRoles.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.userRoles.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id User role ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().UserRole} 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 - */ - patch(params?: Params$Resource$Userroles$Patch, options?: MethodOptions): - AxiosPromise; - patch( - params: Params$Resource$Userroles$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Userroles$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Userroles$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Userroles$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userroles$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/userRoles') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.userRoles.update - * @desc Updates an existing user role. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.userRoles.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.userRoles.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().UserRole} 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$Userroles$Update, options?: MethodOptions): - AxiosPromise; - update( - params: Params$Resource$Userroles$Update, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - update( - params: Params$Resource$Userroles$Update, - callback: BodyResponseCallback): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: Params$Resource$Userroles$Update| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Userroles$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userroles$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/userRoles') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Userroles$Delete { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User role ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Userroles$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User role ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Userroles$Insert { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$UserRole; - } - export interface Params$Resource$Userroles$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Select only account level user roles not associated with any specific - * subaccount. - */ - accountUserRoleOnly?: boolean; - /** - * Select only user roles with the specified IDs. - */ - ids?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. - * For example, "userrole*2015" will return objects with names like - * "userrole June 2015", "userrole April 2015", or simply "userrole 2015". - * Most of the searches also add wildcards implicitly at the start and the - * end of the search string. For example, a search string of "userrole" will - * match objects with name "my userrole", "userrole 2015", or simply - * "userrole". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - /** - * Select only user roles that belong to this subaccount. - */ - subaccountId?: string; - } - export interface Params$Resource$Userroles$Patch { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User role ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$UserRole; - } - export interface Params$Resource$Userroles$Update { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$UserRole; - } - - - export class Resource$Videoformats { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.videoFormats.get - * @desc Gets one video format by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Video format ID. - * id: 0, // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.videoFormats.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.videoFormats.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer} params.id Video format ID. - * @param {string} params.profileId User profile ID associated with 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 - */ - get(params?: Params$Resource$Videoformats$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Videoformats$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Videoformats$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Videoformats$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Videoformats$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Videoformats$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/videoFormats/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.videoFormats.list - * @desc Lists available video formats. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking - * API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var dfareporting = google.dfareporting('v2.8'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.videoFormats.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication - * credentials. See - * // - * https://developers.google.com/doubleclick-advertisers/authorizing#examples - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.videoFormats.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with 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 - */ - list(params?: Params$Resource$Videoformats$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Videoformats$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Videoformats$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Videoformats$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Videoformats$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Videoformats$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + - '/dfareporting/v2.8/userprofiles/{profileId}/videoFormats') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Videoformats$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Video format ID. - */ - id?: number; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Videoformats$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } -} diff --git a/src/apis/dfareporting/v3.0.ts b/src/apis/dfareporting/v3.0.ts index 1415f74559..6ef499e5fa 100644 --- a/src/apis/dfareporting/v3.0.ts +++ b/src/apis/dfareporting/v3.0.ts @@ -29,6 +29,40 @@ export namespace dfareporting_v3_0 { version: 'v3_0'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * DCM/DFA Reporting And Trafficking API * @@ -7606,7 +7640,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Accountactiveadsummaries$Get { + export interface Params$Resource$Accountactiveadsummaries$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7782,7 +7817,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Accountpermissiongroups$Get { + export interface Params$Resource$Accountpermissiongroups$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7797,7 +7833,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Accountpermissiongroups$List { + export interface Params$Resource$Accountpermissiongroups$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7964,7 +8001,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Accountpermissions$Get { + export interface Params$Resource$Accountpermissions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7979,7 +8017,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Accountpermissions$List { + export interface Params$Resource$Accountpermissions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8275,7 +8314,7 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Accounts$Get { + export interface Params$Resource$Accounts$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8290,7 +8329,7 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Accounts$List { + export interface Params$Resource$Accounts$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8335,7 +8374,7 @@ export namespace dfareporting_v3_0 { */ sortOrder?: string; } - export interface Params$Resource$Accounts$Patch { + export interface Params$Resource$Accounts$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8355,7 +8394,7 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$Account; } - export interface Params$Resource$Accounts$Update { + export interface Params$Resource$Accounts$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8751,7 +8790,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Accountuserprofiles$Get { + export interface Params$Resource$Accountuserprofiles$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8766,7 +8806,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Accountuserprofiles$Insert { + export interface Params$Resource$Accountuserprofiles$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8782,7 +8823,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$AccountUserProfile; } - export interface Params$Resource$Accountuserprofiles$List { + export interface Params$Resource$Accountuserprofiles$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8835,7 +8877,8 @@ export namespace dfareporting_v3_0 { */ userRoleId?: string; } - export interface Params$Resource$Accountuserprofiles$Patch { + export interface Params$Resource$Accountuserprofiles$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8855,7 +8898,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$AccountUserProfile; } - export interface Params$Resource$Accountuserprofiles$Update { + export interface Params$Resource$Accountuserprofiles$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9233,7 +9277,7 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Ads$Get { + export interface Params$Resource$Ads$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9248,7 +9292,7 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Ads$Insert { + export interface Params$Resource$Ads$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9264,7 +9308,7 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$Ad; } - export interface Params$Resource$Ads$List { + export interface Params$Resource$Ads$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9380,7 +9424,7 @@ export namespace dfareporting_v3_0 { */ type?: string; } - export interface Params$Resource$Ads$Patch { + export interface Params$Resource$Ads$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9400,7 +9444,7 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$Ad; } - export interface Params$Resource$Ads$Update { + export interface Params$Resource$Ads$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9859,7 +9903,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Advertisergroups$Delete { + export interface Params$Resource$Advertisergroups$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9874,7 +9919,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Advertisergroups$Get { + export interface Params$Resource$Advertisergroups$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9889,7 +9935,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Advertisergroups$Insert { + export interface Params$Resource$Advertisergroups$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9905,7 +9952,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$AdvertiserGroup; } - export interface Params$Resource$Advertisergroups$List { + export interface Params$Resource$Advertisergroups$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9946,7 +9994,8 @@ export namespace dfareporting_v3_0 { */ sortOrder?: string; } - export interface Params$Resource$Advertisergroups$Patch { + export interface Params$Resource$Advertisergroups$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9966,7 +10015,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$AdvertiserGroup; } - export interface Params$Resource$Advertisergroups$Update { + export interface Params$Resource$Advertisergroups$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10363,7 +10413,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Advertiserlandingpages$Get { + export interface Params$Resource$Advertiserlandingpages$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10378,7 +10429,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Advertiserlandingpages$Insert { + export interface Params$Resource$Advertiserlandingpages$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10394,7 +10446,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$LandingPage; } - export interface Params$Resource$Advertiserlandingpages$List { + export interface Params$Resource$Advertiserlandingpages$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10448,7 +10501,8 @@ export namespace dfareporting_v3_0 { */ subaccountId?: string; } - export interface Params$Resource$Advertiserlandingpages$Patch { + export interface Params$Resource$Advertiserlandingpages$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10468,7 +10522,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$LandingPage; } - export interface Params$Resource$Advertiserlandingpages$Update { + export interface Params$Resource$Advertiserlandingpages$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10851,7 +10906,7 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Advertisers$Get { + export interface Params$Resource$Advertisers$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -10866,7 +10921,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Advertisers$Insert { + export interface Params$Resource$Advertisers$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10882,7 +10938,7 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$Advertiser; } - export interface Params$Resource$Advertisers$List { + export interface Params$Resource$Advertisers$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -10948,7 +11004,8 @@ export namespace dfareporting_v3_0 { */ subaccountId?: string; } - export interface Params$Resource$Advertisers$Patch { + export interface Params$Resource$Advertisers$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10968,7 +11025,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$Advertiser; } - export interface Params$Resource$Advertisers$Update { + export interface Params$Resource$Advertisers$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -11065,7 +11123,7 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Browsers$List { + export interface Params$Resource$Browsers$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11251,7 +11309,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Campaigncreativeassociations$Insert { + export interface Params$Resource$Campaigncreativeassociations$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -11271,7 +11330,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$CampaignCreativeAssociation; } - export interface Params$Resource$Campaigncreativeassociations$List { + export interface Params$Resource$Campaigncreativeassociations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -11656,7 +11716,7 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Campaigns$Get { + export interface Params$Resource$Campaigns$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11671,7 +11731,7 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Campaigns$Insert { + export interface Params$Resource$Campaigns$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11687,7 +11747,7 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$Campaign; } - export interface Params$Resource$Campaigns$List { + export interface Params$Resource$Campaigns$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11758,7 +11818,7 @@ export namespace dfareporting_v3_0 { */ subaccountId?: string; } - export interface Params$Resource$Campaigns$Patch { + export interface Params$Resource$Campaigns$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11778,7 +11838,7 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$Campaign; } - export interface Params$Resource$Campaigns$Update { + export interface Params$Resource$Campaigns$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11950,7 +12010,7 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Changelogs$Get { + export interface Params$Resource$Changelogs$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11965,7 +12025,7 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Changelogs$List { + export interface Params$Resource$Changelogs$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -12111,7 +12171,7 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Cities$List { + export interface Params$Resource$Cities$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -12292,7 +12352,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Connectiontypes$Get { + export interface Params$Resource$Connectiontypes$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12307,7 +12368,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Connectiontypes$List { + export interface Params$Resource$Connectiontypes$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12761,7 +12823,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Contentcategories$Delete { + export interface Params$Resource$Contentcategories$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12776,7 +12839,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Contentcategories$Get { + export interface Params$Resource$Contentcategories$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12791,7 +12855,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Contentcategories$Insert { + export interface Params$Resource$Contentcategories$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12807,7 +12872,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$ContentCategory; } - export interface Params$Resource$Contentcategories$List { + export interface Params$Resource$Contentcategories$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12848,7 +12914,8 @@ export namespace dfareporting_v3_0 { */ sortOrder?: string; } - export interface Params$Resource$Contentcategories$Patch { + export interface Params$Resource$Contentcategories$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12868,7 +12935,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$ContentCategory; } - export interface Params$Resource$Contentcategories$Update { + export interface Params$Resource$Contentcategories$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13054,7 +13122,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Conversions$Batchinsert { + export interface Params$Resource$Conversions$Batchinsert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13070,7 +13139,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$ConversionsBatchInsertRequest; } - export interface Params$Resource$Conversions$Batchupdate { + export interface Params$Resource$Conversions$Batchupdate extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13231,7 +13301,7 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Countries$Get { + export interface Params$Resource$Countries$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -13246,7 +13316,7 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Countries$List { + export interface Params$Resource$Countries$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -13350,7 +13420,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Creativeassets$Insert { + export interface Params$Resource$Creativeassets$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13826,7 +13897,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Creativefields$Delete { + export interface Params$Resource$Creativefields$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13841,7 +13913,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Creativefields$Get { + export interface Params$Resource$Creativefields$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13856,7 +13929,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Creativefields$Insert { + export interface Params$Resource$Creativefields$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13872,7 +13946,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$CreativeField; } - export interface Params$Resource$Creativefields$List { + export interface Params$Resource$Creativefields$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13917,7 +13992,8 @@ export namespace dfareporting_v3_0 { */ sortOrder?: string; } - export interface Params$Resource$Creativefields$Patch { + export interface Params$Resource$Creativefields$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13937,7 +14013,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$CreativeField; } - export interface Params$Resource$Creativefields$Update { + export interface Params$Resource$Creativefields$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14404,7 +14481,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Creativefieldvalues$Delete { + export interface Params$Resource$Creativefieldvalues$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14423,7 +14501,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Creativefieldvalues$Get { + export interface Params$Resource$Creativefieldvalues$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14442,7 +14521,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Creativefieldvalues$Insert { + export interface Params$Resource$Creativefieldvalues$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14462,7 +14542,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$CreativeFieldValue; } - export interface Params$Resource$Creativefieldvalues$List { + export interface Params$Resource$Creativefieldvalues$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14502,7 +14583,8 @@ export namespace dfareporting_v3_0 { */ sortOrder?: string; } - export interface Params$Resource$Creativefieldvalues$Patch { + export interface Params$Resource$Creativefieldvalues$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14526,7 +14608,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$CreativeFieldValue; } - export interface Params$Resource$Creativefieldvalues$Update { + export interface Params$Resource$Creativefieldvalues$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14920,7 +15003,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Creativegroups$Get { + export interface Params$Resource$Creativegroups$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14935,7 +15019,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Creativegroups$Insert { + export interface Params$Resource$Creativegroups$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14951,7 +15036,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$CreativeGroup; } - export interface Params$Resource$Creativegroups$List { + export interface Params$Resource$Creativegroups$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15000,7 +15086,8 @@ export namespace dfareporting_v3_0 { */ sortOrder?: string; } - export interface Params$Resource$Creativegroups$Patch { + export interface Params$Resource$Creativegroups$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15020,7 +15107,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$CreativeGroup; } - export interface Params$Resource$Creativegroups$Update { + export interface Params$Resource$Creativegroups$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15397,7 +15485,7 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Creatives$Get { + export interface Params$Resource$Creatives$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -15412,7 +15500,7 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Creatives$Insert { + export interface Params$Resource$Creatives$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -15428,7 +15516,7 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$Creative; } - export interface Params$Resource$Creatives$List { + export interface Params$Resource$Creatives$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -15511,7 +15599,7 @@ export namespace dfareporting_v3_0 { */ types?: string; } - export interface Params$Resource$Creatives$Patch { + export interface Params$Resource$Creatives$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -15531,7 +15619,7 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$Creative; } - export interface Params$Resource$Creatives$Update { + export interface Params$Resource$Creatives$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -15633,7 +15721,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Dimensionvalues$Query { + export interface Params$Resource$Dimensionvalues$Query extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15826,7 +15915,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Directorysitecontacts$Get { + export interface Params$Resource$Directorysitecontacts$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15841,7 +15931,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Directorysitecontacts$List { + export interface Params$Resource$Directorysitecontacts$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -16125,7 +16216,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Directorysites$Get { + export interface Params$Resource$Directorysites$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -16140,7 +16232,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Directorysites$Insert { + export interface Params$Resource$Directorysites$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -16156,7 +16249,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$DirectorySite; } - export interface Params$Resource$Directorysites$List { + export interface Params$Resource$Directorysites$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -16471,7 +16565,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Dynamictargetingkeys$Delete { + export interface Params$Resource$Dynamictargetingkeys$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -16497,7 +16592,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Dynamictargetingkeys$Insert { + export interface Params$Resource$Dynamictargetingkeys$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -16513,7 +16609,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$DynamicTargetingKey; } - export interface Params$Resource$Dynamictargetingkeys$List { + export interface Params$Resource$Dynamictargetingkeys$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -16961,7 +17058,7 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Eventtags$Delete { + export interface Params$Resource$Eventtags$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -16976,7 +17073,7 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Eventtags$Get { + export interface Params$Resource$Eventtags$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -16991,7 +17088,7 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Eventtags$Insert { + export interface Params$Resource$Eventtags$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -17007,7 +17104,7 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$EventTag; } - export interface Params$Resource$Eventtags$List { + export interface Params$Resource$Eventtags$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -17078,7 +17175,7 @@ export namespace dfareporting_v3_0 { */ sortOrder?: string; } - export interface Params$Resource$Eventtags$Patch { + export interface Params$Resource$Eventtags$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -17098,7 +17195,7 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$EventTag; } - export interface Params$Resource$Eventtags$Update { + export interface Params$Resource$Eventtags$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -17262,7 +17359,7 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Files$Get { + export interface Params$Resource$Files$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -17277,7 +17374,7 @@ export namespace dfareporting_v3_0 { */ reportId?: string; } - export interface Params$Resource$Files$List { + export interface Params$Resource$Files$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -17840,7 +17937,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Floodlightactivities$Delete { + export interface Params$Resource$Floodlightactivities$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17855,7 +17953,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Floodlightactivities$Generatetag { + export interface Params$Resource$Floodlightactivities$Generatetag extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17870,7 +17969,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Floodlightactivities$Get { + export interface Params$Resource$Floodlightactivities$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17885,7 +17985,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Floodlightactivities$Insert { + export interface Params$Resource$Floodlightactivities$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17901,7 +18002,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$FloodlightActivity; } - export interface Params$Resource$Floodlightactivities$List { + export interface Params$Resource$Floodlightactivities$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17981,7 +18083,8 @@ export namespace dfareporting_v3_0 { */ tagString?: string; } - export interface Params$Resource$Floodlightactivities$Patch { + export interface Params$Resource$Floodlightactivities$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18001,7 +18104,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$FloodlightActivity; } - export interface Params$Resource$Floodlightactivities$Update { + export interface Params$Resource$Floodlightactivities$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18405,7 +18509,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Floodlightactivitygroups$Get { + export interface Params$Resource$Floodlightactivitygroups$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18420,7 +18525,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Floodlightactivitygroups$Insert { + export interface Params$Resource$Floodlightactivitygroups$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18436,7 +18542,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$FloodlightActivityGroup; } - export interface Params$Resource$Floodlightactivitygroups$List { + export interface Params$Resource$Floodlightactivitygroups$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18497,7 +18604,8 @@ export namespace dfareporting_v3_0 { */ type?: string; } - export interface Params$Resource$Floodlightactivitygroups$Patch { + export interface Params$Resource$Floodlightactivitygroups$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18517,7 +18625,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$FloodlightActivityGroup; } - export interface Params$Resource$Floodlightactivitygroups$Update { + export interface Params$Resource$Floodlightactivitygroups$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18840,7 +18949,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Floodlightconfigurations$Get { + export interface Params$Resource$Floodlightconfigurations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18855,7 +18965,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Floodlightconfigurations$List { + export interface Params$Resource$Floodlightconfigurations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18871,7 +18982,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Floodlightconfigurations$Patch { + export interface Params$Resource$Floodlightconfigurations$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18891,7 +19003,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$FloodlightConfiguration; } - export interface Params$Resource$Floodlightconfigurations$Update { + export interface Params$Resource$Floodlightconfigurations$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19072,7 +19185,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Inventoryitems$Get { + export interface Params$Resource$Inventoryitems$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19091,7 +19205,8 @@ export namespace dfareporting_v3_0 { */ projectId?: string; } - export interface Params$Resource$Inventoryitems$List { + export interface Params$Resource$Inventoryitems$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19223,7 +19338,7 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Languages$List { + export interface Params$Resource$Languages$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -19314,7 +19429,7 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Metros$List { + export interface Params$Resource$Metros$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -19478,7 +19593,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Mobilecarriers$Get { + export interface Params$Resource$Mobilecarriers$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19493,7 +19609,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Mobilecarriers$List { + export interface Params$Resource$Mobilecarriers$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19660,7 +19777,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Operatingsystems$Get { + export interface Params$Resource$Operatingsystems$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19675,7 +19793,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Operatingsystems$List { + export interface Params$Resource$Operatingsystems$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19847,7 +19966,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Operatingsystemversions$Get { + export interface Params$Resource$Operatingsystemversions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19862,7 +19982,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Operatingsystemversions$List { + export interface Params$Resource$Operatingsystemversions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -20038,7 +20159,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Orderdocuments$Get { + export interface Params$Resource$Orderdocuments$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -20057,7 +20179,8 @@ export namespace dfareporting_v3_0 { */ projectId?: string; } - export interface Params$Resource$Orderdocuments$List { + export interface Params$Resource$Orderdocuments$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -20269,7 +20392,7 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Orders$Get { + export interface Params$Resource$Orders$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -20288,7 +20411,7 @@ export namespace dfareporting_v3_0 { */ projectId?: string; } - export interface Params$Resource$Orders$List { + export interface Params$Resource$Orders$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -20722,7 +20845,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Placementgroups$Get { + export interface Params$Resource$Placementgroups$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -20737,7 +20861,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Placementgroups$Insert { + export interface Params$Resource$Placementgroups$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -20753,7 +20878,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$PlacementGroup; } - export interface Params$Resource$Placementgroups$List { + export interface Params$Resource$Placementgroups$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -20861,7 +20987,8 @@ export namespace dfareporting_v3_0 { */ sortOrder?: string; } - export interface Params$Resource$Placementgroups$Patch { + export interface Params$Resource$Placementgroups$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -20881,7 +21008,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$PlacementGroup; } - export interface Params$Resource$Placementgroups$Update { + export interface Params$Resource$Placementgroups$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -21351,7 +21479,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Placements$Generatetags { + export interface Params$Resource$Placements$Generatetags extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -21375,7 +21504,7 @@ export namespace dfareporting_v3_0 { */ tagFormats?: string; } - export interface Params$Resource$Placements$Get { + export interface Params$Resource$Placements$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -21390,7 +21519,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Placements$Insert { + export interface Params$Resource$Placements$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -21406,7 +21536,7 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$Placement; } - export interface Params$Resource$Placements$List { + export interface Params$Resource$Placements$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -21523,7 +21653,7 @@ export namespace dfareporting_v3_0 { */ sortOrder?: string; } - export interface Params$Resource$Placements$Patch { + export interface Params$Resource$Placements$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -21543,7 +21673,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$Placement; } - export interface Params$Resource$Placements$Update { + export interface Params$Resource$Placements$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22004,7 +22135,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Placementstrategies$Delete { + export interface Params$Resource$Placementstrategies$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22019,7 +22151,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Placementstrategies$Get { + export interface Params$Resource$Placementstrategies$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22034,7 +22167,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Placementstrategies$Insert { + export interface Params$Resource$Placementstrategies$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22050,7 +22184,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$PlacementStrategy; } - export interface Params$Resource$Placementstrategies$List { + export interface Params$Resource$Placementstrategies$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22092,7 +22227,8 @@ export namespace dfareporting_v3_0 { */ sortOrder?: string; } - export interface Params$Resource$Placementstrategies$Patch { + export interface Params$Resource$Placementstrategies$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22112,7 +22248,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$PlacementStrategy; } - export interface Params$Resource$Placementstrategies$Update { + export interface Params$Resource$Placementstrategies$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22278,7 +22415,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Platformtypes$Get { + export interface Params$Resource$Platformtypes$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22293,7 +22431,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Platformtypes$List { + export interface Params$Resource$Platformtypes$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22450,7 +22589,7 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Postalcodes$Get { + export interface Params$Resource$Postalcodes$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -22465,7 +22604,7 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Postalcodes$List { + export interface Params$Resource$Postalcodes$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -22628,7 +22767,7 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Projects$Get { + export interface Params$Resource$Projects$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -22643,7 +22782,7 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Projects$List { + export interface Params$Resource$Projects$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -22767,7 +22906,7 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Regions$List { + export interface Params$Resource$Regions$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -23155,7 +23294,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Remarketinglists$Get { + export interface Params$Resource$Remarketinglists$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23170,7 +23310,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Remarketinglists$Insert { + export interface Params$Resource$Remarketinglists$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23186,7 +23327,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$RemarketingList; } - export interface Params$Resource$Remarketinglists$List { + export interface Params$Resource$Remarketinglists$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23235,7 +23377,8 @@ export namespace dfareporting_v3_0 { */ sortOrder?: string; } - export interface Params$Resource$Remarketinglists$Patch { + export interface Params$Resource$Remarketinglists$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23255,7 +23398,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$RemarketingList; } - export interface Params$Resource$Remarketinglists$Update { + export interface Params$Resource$Remarketinglists$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23496,7 +23640,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Remarketinglistshares$Get { + export interface Params$Resource$Remarketinglistshares$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23511,7 +23656,8 @@ export namespace dfareporting_v3_0 { */ remarketingListId?: string; } - export interface Params$Resource$Remarketinglistshares$Patch { + export interface Params$Resource$Remarketinglistshares$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23531,7 +23677,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$RemarketingListShare; } - export interface Params$Resource$Remarketinglistshares$Update { + export interface Params$Resource$Remarketinglistshares$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -24033,7 +24180,7 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Reports$Delete { + export interface Params$Resource$Reports$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -24048,7 +24195,7 @@ export namespace dfareporting_v3_0 { */ reportId?: string; } - export interface Params$Resource$Reports$Get { + export interface Params$Resource$Reports$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -24063,7 +24210,7 @@ export namespace dfareporting_v3_0 { */ reportId?: string; } - export interface Params$Resource$Reports$Insert { + export interface Params$Resource$Reports$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -24079,7 +24226,7 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$Report; } - export interface Params$Resource$Reports$List { + export interface Params$Resource$Reports$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -24110,7 +24257,7 @@ export namespace dfareporting_v3_0 { */ sortOrder?: string; } - export interface Params$Resource$Reports$Patch { + export interface Params$Resource$Reports$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -24130,7 +24277,7 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$Report; } - export interface Params$Resource$Reports$Run { + export interface Params$Resource$Reports$Run extends StandardParameters { /** * Auth client or API Key for the request */ @@ -24149,7 +24296,7 @@ export namespace dfareporting_v3_0 { */ synchronous?: boolean; } - export interface Params$Resource$Reports$Update { + export interface Params$Resource$Reports$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -24254,7 +24401,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Reports$Compatiblefields$Query { + export interface Params$Resource$Reports$Compatiblefields$Query extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -24422,7 +24570,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Reports$Files$Get { + export interface Params$Resource$Reports$Files$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -24441,7 +24590,8 @@ export namespace dfareporting_v3_0 { */ reportId?: string; } - export interface Params$Resource$Reports$Files$List { + export interface Params$Resource$Reports$Files$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -24831,7 +24981,7 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Sites$Get { + export interface Params$Resource$Sites$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -24846,7 +24996,7 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Sites$Insert { + export interface Params$Resource$Sites$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -24862,7 +25012,7 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$Site; } - export interface Params$Resource$Sites$List { + export interface Params$Resource$Sites$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -24940,7 +25090,7 @@ export namespace dfareporting_v3_0 { */ unmappedSite?: boolean; } - export interface Params$Resource$Sites$Patch { + export interface Params$Resource$Sites$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -24960,7 +25110,7 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$Site; } - export interface Params$Resource$Sites$Update { + export interface Params$Resource$Sites$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -25192,7 +25342,7 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Sizes$Get { + export interface Params$Resource$Sizes$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -25207,7 +25357,7 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Sizes$Insert { + export interface Params$Resource$Sizes$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -25223,7 +25373,7 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$Size; } - export interface Params$Resource$Sizes$List { + export interface Params$Resource$Sizes$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -25611,7 +25761,7 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Subaccounts$Get { + export interface Params$Resource$Subaccounts$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -25626,7 +25776,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Subaccounts$Insert { + export interface Params$Resource$Subaccounts$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -25642,7 +25793,7 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$Subaccount; } - export interface Params$Resource$Subaccounts$List { + export interface Params$Resource$Subaccounts$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -25683,7 +25834,8 @@ export namespace dfareporting_v3_0 { */ sortOrder?: string; } - export interface Params$Resource$Subaccounts$Patch { + export interface Params$Resource$Subaccounts$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -25703,7 +25855,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$Subaccount; } - export interface Params$Resource$Subaccounts$Update { + export interface Params$Resource$Subaccounts$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -25887,7 +26040,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Targetableremarketinglists$Get { + export interface Params$Resource$Targetableremarketinglists$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -25902,7 +26056,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Targetableremarketinglists$List { + export interface Params$Resource$Targetableremarketinglists$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26323,7 +26478,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Targetingtemplates$Get { + export interface Params$Resource$Targetingtemplates$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26338,7 +26494,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Targetingtemplates$Insert { + export interface Params$Resource$Targetingtemplates$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26354,7 +26511,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$TargetingTemplate; } - export interface Params$Resource$Targetingtemplates$List { + export interface Params$Resource$Targetingtemplates$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26399,7 +26557,8 @@ export namespace dfareporting_v3_0 { */ sortOrder?: string; } - export interface Params$Resource$Targetingtemplates$Patch { + export interface Params$Resource$Targetingtemplates$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26419,7 +26578,8 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$TargetingTemplate; } - export interface Params$Resource$Targetingtemplates$Update { + export interface Params$Resource$Targetingtemplates$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26576,7 +26736,7 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Userprofiles$Get { + export interface Params$Resource$Userprofiles$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -26587,7 +26747,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Userprofiles$List { + export interface Params$Resource$Userprofiles$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26754,7 +26915,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Userrolepermissiongroups$Get { + export interface Params$Resource$Userrolepermissiongroups$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26769,7 +26931,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Userrolepermissiongroups$List { + export interface Params$Resource$Userrolepermissiongroups$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26939,7 +27102,8 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Userrolepermissions$Get { + export interface Params$Resource$Userrolepermissions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26954,7 +27118,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Userrolepermissions$List { + export interface Params$Resource$Userrolepermissions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -27389,7 +27554,7 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Userroles$Delete { + export interface Params$Resource$Userroles$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -27404,7 +27569,7 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Userroles$Get { + export interface Params$Resource$Userroles$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -27419,7 +27584,7 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Userroles$Insert { + export interface Params$Resource$Userroles$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -27435,7 +27600,7 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$UserRole; } - export interface Params$Resource$Userroles$List { + export interface Params$Resource$Userroles$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -27485,7 +27650,7 @@ export namespace dfareporting_v3_0 { */ subaccountId?: string; } - export interface Params$Resource$Userroles$Patch { + export interface Params$Resource$Userroles$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -27505,7 +27670,7 @@ export namespace dfareporting_v3_0 { */ requestBody?: Schema$UserRole; } - export interface Params$Resource$Userroles$Update { + export interface Params$Resource$Userroles$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -27668,7 +27833,7 @@ export namespace dfareporting_v3_0 { } } - export interface Params$Resource$Videoformats$Get { + export interface Params$Resource$Videoformats$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -27683,7 +27848,8 @@ export namespace dfareporting_v3_0 { */ profileId?: string; } - export interface Params$Resource$Videoformats$List { + export interface Params$Resource$Videoformats$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/dfareporting/v3.1.ts b/src/apis/dfareporting/v3.1.ts index ad7af7d224..246e5b4187 100644 --- a/src/apis/dfareporting/v3.1.ts +++ b/src/apis/dfareporting/v3.1.ts @@ -29,6 +29,40 @@ export namespace dfareporting_v3_1 { version: 'v3_1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * DCM/DFA Reporting And Trafficking API * @@ -7694,7 +7728,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Accountactiveadsummaries$Get { + export interface Params$Resource$Accountactiveadsummaries$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7870,7 +7905,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Accountpermissiongroups$Get { + export interface Params$Resource$Accountpermissiongroups$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7885,7 +7921,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Accountpermissiongroups$List { + export interface Params$Resource$Accountpermissiongroups$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8052,7 +8089,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Accountpermissions$Get { + export interface Params$Resource$Accountpermissions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8067,7 +8105,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Accountpermissions$List { + export interface Params$Resource$Accountpermissions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8363,7 +8402,7 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Accounts$Get { + export interface Params$Resource$Accounts$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8378,7 +8417,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Accounts$List { + export interface Params$Resource$Accounts$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8423,7 +8462,7 @@ export namespace dfareporting_v3_1 { */ sortOrder?: string; } - export interface Params$Resource$Accounts$Patch { + export interface Params$Resource$Accounts$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8443,7 +8482,7 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$Account; } - export interface Params$Resource$Accounts$Update { + export interface Params$Resource$Accounts$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8839,7 +8878,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Accountuserprofiles$Get { + export interface Params$Resource$Accountuserprofiles$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8854,7 +8894,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Accountuserprofiles$Insert { + export interface Params$Resource$Accountuserprofiles$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8870,7 +8911,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$AccountUserProfile; } - export interface Params$Resource$Accountuserprofiles$List { + export interface Params$Resource$Accountuserprofiles$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8923,7 +8965,8 @@ export namespace dfareporting_v3_1 { */ userRoleId?: string; } - export interface Params$Resource$Accountuserprofiles$Patch { + export interface Params$Resource$Accountuserprofiles$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8943,7 +8986,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$AccountUserProfile; } - export interface Params$Resource$Accountuserprofiles$Update { + export interface Params$Resource$Accountuserprofiles$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9321,7 +9365,7 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Ads$Get { + export interface Params$Resource$Ads$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9336,7 +9380,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Ads$Insert { + export interface Params$Resource$Ads$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9352,7 +9396,7 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$Ad; } - export interface Params$Resource$Ads$List { + export interface Params$Resource$Ads$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9468,7 +9512,7 @@ export namespace dfareporting_v3_1 { */ type?: string; } - export interface Params$Resource$Ads$Patch { + export interface Params$Resource$Ads$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9488,7 +9532,7 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$Ad; } - export interface Params$Resource$Ads$Update { + export interface Params$Resource$Ads$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9947,7 +9991,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Advertisergroups$Delete { + export interface Params$Resource$Advertisergroups$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9962,7 +10007,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Advertisergroups$Get { + export interface Params$Resource$Advertisergroups$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9977,7 +10023,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Advertisergroups$Insert { + export interface Params$Resource$Advertisergroups$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9993,7 +10040,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$AdvertiserGroup; } - export interface Params$Resource$Advertisergroups$List { + export interface Params$Resource$Advertisergroups$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10034,7 +10082,8 @@ export namespace dfareporting_v3_1 { */ sortOrder?: string; } - export interface Params$Resource$Advertisergroups$Patch { + export interface Params$Resource$Advertisergroups$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10054,7 +10103,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$AdvertiserGroup; } - export interface Params$Resource$Advertisergroups$Update { + export interface Params$Resource$Advertisergroups$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10451,7 +10501,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Advertiserlandingpages$Get { + export interface Params$Resource$Advertiserlandingpages$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10466,7 +10517,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Advertiserlandingpages$Insert { + export interface Params$Resource$Advertiserlandingpages$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10482,7 +10534,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$LandingPage; } - export interface Params$Resource$Advertiserlandingpages$List { + export interface Params$Resource$Advertiserlandingpages$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10536,7 +10589,8 @@ export namespace dfareporting_v3_1 { */ subaccountId?: string; } - export interface Params$Resource$Advertiserlandingpages$Patch { + export interface Params$Resource$Advertiserlandingpages$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10556,7 +10610,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$LandingPage; } - export interface Params$Resource$Advertiserlandingpages$Update { + export interface Params$Resource$Advertiserlandingpages$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10939,7 +10994,7 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Advertisers$Get { + export interface Params$Resource$Advertisers$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -10954,7 +11009,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Advertisers$Insert { + export interface Params$Resource$Advertisers$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10970,7 +11026,7 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$Advertiser; } - export interface Params$Resource$Advertisers$List { + export interface Params$Resource$Advertisers$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11036,7 +11092,8 @@ export namespace dfareporting_v3_1 { */ subaccountId?: string; } - export interface Params$Resource$Advertisers$Patch { + export interface Params$Resource$Advertisers$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -11056,7 +11113,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$Advertiser; } - export interface Params$Resource$Advertisers$Update { + export interface Params$Resource$Advertisers$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -11153,7 +11211,7 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Browsers$List { + export interface Params$Resource$Browsers$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11339,7 +11397,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Campaigncreativeassociations$Insert { + export interface Params$Resource$Campaigncreativeassociations$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -11359,7 +11418,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$CampaignCreativeAssociation; } - export interface Params$Resource$Campaigncreativeassociations$List { + export interface Params$Resource$Campaigncreativeassociations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -11744,7 +11804,7 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Campaigns$Get { + export interface Params$Resource$Campaigns$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11759,7 +11819,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Campaigns$Insert { + export interface Params$Resource$Campaigns$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11775,7 +11835,7 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$Campaign; } - export interface Params$Resource$Campaigns$List { + export interface Params$Resource$Campaigns$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11846,7 +11906,7 @@ export namespace dfareporting_v3_1 { */ subaccountId?: string; } - export interface Params$Resource$Campaigns$Patch { + export interface Params$Resource$Campaigns$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11866,7 +11926,7 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$Campaign; } - export interface Params$Resource$Campaigns$Update { + export interface Params$Resource$Campaigns$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -12038,7 +12098,7 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Changelogs$Get { + export interface Params$Resource$Changelogs$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -12053,7 +12113,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Changelogs$List { + export interface Params$Resource$Changelogs$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -12199,7 +12259,7 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Cities$List { + export interface Params$Resource$Cities$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -12380,7 +12440,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Connectiontypes$Get { + export interface Params$Resource$Connectiontypes$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12395,7 +12456,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Connectiontypes$List { + export interface Params$Resource$Connectiontypes$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12849,7 +12911,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Contentcategories$Delete { + export interface Params$Resource$Contentcategories$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12864,7 +12927,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Contentcategories$Get { + export interface Params$Resource$Contentcategories$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12879,7 +12943,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Contentcategories$Insert { + export interface Params$Resource$Contentcategories$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12895,7 +12960,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$ContentCategory; } - export interface Params$Resource$Contentcategories$List { + export interface Params$Resource$Contentcategories$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12936,7 +13002,8 @@ export namespace dfareporting_v3_1 { */ sortOrder?: string; } - export interface Params$Resource$Contentcategories$Patch { + export interface Params$Resource$Contentcategories$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12956,7 +13023,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$ContentCategory; } - export interface Params$Resource$Contentcategories$Update { + export interface Params$Resource$Contentcategories$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13142,7 +13210,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Conversions$Batchinsert { + export interface Params$Resource$Conversions$Batchinsert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13158,7 +13227,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$ConversionsBatchInsertRequest; } - export interface Params$Resource$Conversions$Batchupdate { + export interface Params$Resource$Conversions$Batchupdate extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13319,7 +13389,7 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Countries$Get { + export interface Params$Resource$Countries$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -13334,7 +13404,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Countries$List { + export interface Params$Resource$Countries$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -13438,7 +13508,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Creativeassets$Insert { + export interface Params$Resource$Creativeassets$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13914,7 +13985,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Creativefields$Delete { + export interface Params$Resource$Creativefields$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13929,7 +14001,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Creativefields$Get { + export interface Params$Resource$Creativefields$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13944,7 +14017,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Creativefields$Insert { + export interface Params$Resource$Creativefields$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13960,7 +14034,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$CreativeField; } - export interface Params$Resource$Creativefields$List { + export interface Params$Resource$Creativefields$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14005,7 +14080,8 @@ export namespace dfareporting_v3_1 { */ sortOrder?: string; } - export interface Params$Resource$Creativefields$Patch { + export interface Params$Resource$Creativefields$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14025,7 +14101,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$CreativeField; } - export interface Params$Resource$Creativefields$Update { + export interface Params$Resource$Creativefields$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14492,7 +14569,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Creativefieldvalues$Delete { + export interface Params$Resource$Creativefieldvalues$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14511,7 +14589,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Creativefieldvalues$Get { + export interface Params$Resource$Creativefieldvalues$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14530,7 +14609,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Creativefieldvalues$Insert { + export interface Params$Resource$Creativefieldvalues$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14550,7 +14630,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$CreativeFieldValue; } - export interface Params$Resource$Creativefieldvalues$List { + export interface Params$Resource$Creativefieldvalues$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14590,7 +14671,8 @@ export namespace dfareporting_v3_1 { */ sortOrder?: string; } - export interface Params$Resource$Creativefieldvalues$Patch { + export interface Params$Resource$Creativefieldvalues$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14614,7 +14696,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$CreativeFieldValue; } - export interface Params$Resource$Creativefieldvalues$Update { + export interface Params$Resource$Creativefieldvalues$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15008,7 +15091,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Creativegroups$Get { + export interface Params$Resource$Creativegroups$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15023,7 +15107,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Creativegroups$Insert { + export interface Params$Resource$Creativegroups$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15039,7 +15124,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$CreativeGroup; } - export interface Params$Resource$Creativegroups$List { + export interface Params$Resource$Creativegroups$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15088,7 +15174,8 @@ export namespace dfareporting_v3_1 { */ sortOrder?: string; } - export interface Params$Resource$Creativegroups$Patch { + export interface Params$Resource$Creativegroups$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15108,7 +15195,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$CreativeGroup; } - export interface Params$Resource$Creativegroups$Update { + export interface Params$Resource$Creativegroups$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15485,7 +15573,7 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Creatives$Get { + export interface Params$Resource$Creatives$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -15500,7 +15588,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Creatives$Insert { + export interface Params$Resource$Creatives$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -15516,7 +15604,7 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$Creative; } - export interface Params$Resource$Creatives$List { + export interface Params$Resource$Creatives$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -15599,7 +15687,7 @@ export namespace dfareporting_v3_1 { */ types?: string; } - export interface Params$Resource$Creatives$Patch { + export interface Params$Resource$Creatives$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -15619,7 +15707,7 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$Creative; } - export interface Params$Resource$Creatives$Update { + export interface Params$Resource$Creatives$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -15721,7 +15809,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Dimensionvalues$Query { + export interface Params$Resource$Dimensionvalues$Query extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15914,7 +16003,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Directorysitecontacts$Get { + export interface Params$Resource$Directorysitecontacts$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15929,7 +16019,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Directorysitecontacts$List { + export interface Params$Resource$Directorysitecontacts$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -16213,7 +16304,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Directorysites$Get { + export interface Params$Resource$Directorysites$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -16228,7 +16320,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Directorysites$Insert { + export interface Params$Resource$Directorysites$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -16244,7 +16337,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$DirectorySite; } - export interface Params$Resource$Directorysites$List { + export interface Params$Resource$Directorysites$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -16559,7 +16653,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Dynamictargetingkeys$Delete { + export interface Params$Resource$Dynamictargetingkeys$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -16585,7 +16680,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Dynamictargetingkeys$Insert { + export interface Params$Resource$Dynamictargetingkeys$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -16601,7 +16697,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$DynamicTargetingKey; } - export interface Params$Resource$Dynamictargetingkeys$List { + export interface Params$Resource$Dynamictargetingkeys$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17049,7 +17146,7 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Eventtags$Delete { + export interface Params$Resource$Eventtags$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -17064,7 +17161,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Eventtags$Get { + export interface Params$Resource$Eventtags$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -17079,7 +17176,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Eventtags$Insert { + export interface Params$Resource$Eventtags$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -17095,7 +17192,7 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$EventTag; } - export interface Params$Resource$Eventtags$List { + export interface Params$Resource$Eventtags$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -17166,7 +17263,7 @@ export namespace dfareporting_v3_1 { */ sortOrder?: string; } - export interface Params$Resource$Eventtags$Patch { + export interface Params$Resource$Eventtags$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -17186,7 +17283,7 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$EventTag; } - export interface Params$Resource$Eventtags$Update { + export interface Params$Resource$Eventtags$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -17350,7 +17447,7 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Files$Get { + export interface Params$Resource$Files$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -17365,7 +17462,7 @@ export namespace dfareporting_v3_1 { */ reportId?: string; } - export interface Params$Resource$Files$List { + export interface Params$Resource$Files$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -17928,7 +18025,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Floodlightactivities$Delete { + export interface Params$Resource$Floodlightactivities$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17943,7 +18041,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Floodlightactivities$Generatetag { + export interface Params$Resource$Floodlightactivities$Generatetag extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17958,7 +18057,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Floodlightactivities$Get { + export interface Params$Resource$Floodlightactivities$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17973,7 +18073,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Floodlightactivities$Insert { + export interface Params$Resource$Floodlightactivities$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17989,7 +18090,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$FloodlightActivity; } - export interface Params$Resource$Floodlightactivities$List { + export interface Params$Resource$Floodlightactivities$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18069,7 +18171,8 @@ export namespace dfareporting_v3_1 { */ tagString?: string; } - export interface Params$Resource$Floodlightactivities$Patch { + export interface Params$Resource$Floodlightactivities$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18089,7 +18192,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$FloodlightActivity; } - export interface Params$Resource$Floodlightactivities$Update { + export interface Params$Resource$Floodlightactivities$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18493,7 +18597,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Floodlightactivitygroups$Get { + export interface Params$Resource$Floodlightactivitygroups$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18508,7 +18613,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Floodlightactivitygroups$Insert { + export interface Params$Resource$Floodlightactivitygroups$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18524,7 +18630,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$FloodlightActivityGroup; } - export interface Params$Resource$Floodlightactivitygroups$List { + export interface Params$Resource$Floodlightactivitygroups$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18585,7 +18692,8 @@ export namespace dfareporting_v3_1 { */ type?: string; } - export interface Params$Resource$Floodlightactivitygroups$Patch { + export interface Params$Resource$Floodlightactivitygroups$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18605,7 +18713,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$FloodlightActivityGroup; } - export interface Params$Resource$Floodlightactivitygroups$Update { + export interface Params$Resource$Floodlightactivitygroups$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18928,7 +19037,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Floodlightconfigurations$Get { + export interface Params$Resource$Floodlightconfigurations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18943,7 +19053,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Floodlightconfigurations$List { + export interface Params$Resource$Floodlightconfigurations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18959,7 +19070,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Floodlightconfigurations$Patch { + export interface Params$Resource$Floodlightconfigurations$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18979,7 +19091,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$FloodlightConfiguration; } - export interface Params$Resource$Floodlightconfigurations$Update { + export interface Params$Resource$Floodlightconfigurations$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19160,7 +19273,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Inventoryitems$Get { + export interface Params$Resource$Inventoryitems$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19179,7 +19293,8 @@ export namespace dfareporting_v3_1 { */ projectId?: string; } - export interface Params$Resource$Inventoryitems$List { + export interface Params$Resource$Inventoryitems$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19311,7 +19426,7 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Languages$List { + export interface Params$Resource$Languages$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -19402,7 +19517,7 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Metros$List { + export interface Params$Resource$Metros$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -19564,7 +19679,7 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Mobileapps$Get { + export interface Params$Resource$Mobileapps$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -19579,7 +19694,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Mobileapps$List { + export interface Params$Resource$Mobileapps$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -19768,7 +19883,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Mobilecarriers$Get { + export interface Params$Resource$Mobilecarriers$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19783,7 +19899,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Mobilecarriers$List { + export interface Params$Resource$Mobilecarriers$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19950,7 +20067,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Operatingsystems$Get { + export interface Params$Resource$Operatingsystems$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19965,7 +20083,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Operatingsystems$List { + export interface Params$Resource$Operatingsystems$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -20137,7 +20256,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Operatingsystemversions$Get { + export interface Params$Resource$Operatingsystemversions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -20152,7 +20272,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Operatingsystemversions$List { + export interface Params$Resource$Operatingsystemversions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -20328,7 +20449,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Orderdocuments$Get { + export interface Params$Resource$Orderdocuments$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -20347,7 +20469,8 @@ export namespace dfareporting_v3_1 { */ projectId?: string; } - export interface Params$Resource$Orderdocuments$List { + export interface Params$Resource$Orderdocuments$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -20559,7 +20682,7 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Orders$Get { + export interface Params$Resource$Orders$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -20578,7 +20701,7 @@ export namespace dfareporting_v3_1 { */ projectId?: string; } - export interface Params$Resource$Orders$List { + export interface Params$Resource$Orders$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -21012,7 +21135,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Placementgroups$Get { + export interface Params$Resource$Placementgroups$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -21027,7 +21151,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Placementgroups$Insert { + export interface Params$Resource$Placementgroups$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -21043,7 +21168,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$PlacementGroup; } - export interface Params$Resource$Placementgroups$List { + export interface Params$Resource$Placementgroups$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -21151,7 +21277,8 @@ export namespace dfareporting_v3_1 { */ sortOrder?: string; } - export interface Params$Resource$Placementgroups$Patch { + export interface Params$Resource$Placementgroups$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -21171,7 +21298,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$PlacementGroup; } - export interface Params$Resource$Placementgroups$Update { + export interface Params$Resource$Placementgroups$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -21641,7 +21769,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Placements$Generatetags { + export interface Params$Resource$Placements$Generatetags extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -21665,7 +21794,7 @@ export namespace dfareporting_v3_1 { */ tagFormats?: string; } - export interface Params$Resource$Placements$Get { + export interface Params$Resource$Placements$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -21680,7 +21809,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Placements$Insert { + export interface Params$Resource$Placements$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -21696,7 +21826,7 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$Placement; } - export interface Params$Resource$Placements$List { + export interface Params$Resource$Placements$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -21813,7 +21943,7 @@ export namespace dfareporting_v3_1 { */ sortOrder?: string; } - export interface Params$Resource$Placements$Patch { + export interface Params$Resource$Placements$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -21833,7 +21963,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$Placement; } - export interface Params$Resource$Placements$Update { + export interface Params$Resource$Placements$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22294,7 +22425,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Placementstrategies$Delete { + export interface Params$Resource$Placementstrategies$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22309,7 +22441,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Placementstrategies$Get { + export interface Params$Resource$Placementstrategies$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22324,7 +22457,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Placementstrategies$Insert { + export interface Params$Resource$Placementstrategies$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22340,7 +22474,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$PlacementStrategy; } - export interface Params$Resource$Placementstrategies$List { + export interface Params$Resource$Placementstrategies$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22382,7 +22517,8 @@ export namespace dfareporting_v3_1 { */ sortOrder?: string; } - export interface Params$Resource$Placementstrategies$Patch { + export interface Params$Resource$Placementstrategies$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22402,7 +22538,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$PlacementStrategy; } - export interface Params$Resource$Placementstrategies$Update { + export interface Params$Resource$Placementstrategies$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22568,7 +22705,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Platformtypes$Get { + export interface Params$Resource$Platformtypes$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22583,7 +22721,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Platformtypes$List { + export interface Params$Resource$Platformtypes$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22740,7 +22879,7 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Postalcodes$Get { + export interface Params$Resource$Postalcodes$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -22755,7 +22894,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Postalcodes$List { + export interface Params$Resource$Postalcodes$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -22918,7 +23057,7 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Projects$Get { + export interface Params$Resource$Projects$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -22933,7 +23072,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Projects$List { + export interface Params$Resource$Projects$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -23057,7 +23196,7 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Regions$List { + export interface Params$Resource$Regions$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -23445,7 +23584,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Remarketinglists$Get { + export interface Params$Resource$Remarketinglists$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23460,7 +23600,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Remarketinglists$Insert { + export interface Params$Resource$Remarketinglists$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23476,7 +23617,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$RemarketingList; } - export interface Params$Resource$Remarketinglists$List { + export interface Params$Resource$Remarketinglists$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23525,7 +23667,8 @@ export namespace dfareporting_v3_1 { */ sortOrder?: string; } - export interface Params$Resource$Remarketinglists$Patch { + export interface Params$Resource$Remarketinglists$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23545,7 +23688,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$RemarketingList; } - export interface Params$Resource$Remarketinglists$Update { + export interface Params$Resource$Remarketinglists$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23786,7 +23930,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Remarketinglistshares$Get { + export interface Params$Resource$Remarketinglistshares$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23801,7 +23946,8 @@ export namespace dfareporting_v3_1 { */ remarketingListId?: string; } - export interface Params$Resource$Remarketinglistshares$Patch { + export interface Params$Resource$Remarketinglistshares$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23821,7 +23967,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$RemarketingListShare; } - export interface Params$Resource$Remarketinglistshares$Update { + export interface Params$Resource$Remarketinglistshares$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -24323,7 +24470,7 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Reports$Delete { + export interface Params$Resource$Reports$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -24338,7 +24485,7 @@ export namespace dfareporting_v3_1 { */ reportId?: string; } - export interface Params$Resource$Reports$Get { + export interface Params$Resource$Reports$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -24353,7 +24500,7 @@ export namespace dfareporting_v3_1 { */ reportId?: string; } - export interface Params$Resource$Reports$Insert { + export interface Params$Resource$Reports$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -24369,7 +24516,7 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$Report; } - export interface Params$Resource$Reports$List { + export interface Params$Resource$Reports$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -24400,7 +24547,7 @@ export namespace dfareporting_v3_1 { */ sortOrder?: string; } - export interface Params$Resource$Reports$Patch { + export interface Params$Resource$Reports$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -24420,7 +24567,7 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$Report; } - export interface Params$Resource$Reports$Run { + export interface Params$Resource$Reports$Run extends StandardParameters { /** * Auth client or API Key for the request */ @@ -24439,7 +24586,7 @@ export namespace dfareporting_v3_1 { */ synchronous?: boolean; } - export interface Params$Resource$Reports$Update { + export interface Params$Resource$Reports$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -24544,7 +24691,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Reports$Compatiblefields$Query { + export interface Params$Resource$Reports$Compatiblefields$Query extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -24712,7 +24860,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Reports$Files$Get { + export interface Params$Resource$Reports$Files$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -24731,7 +24880,8 @@ export namespace dfareporting_v3_1 { */ reportId?: string; } - export interface Params$Resource$Reports$Files$List { + export interface Params$Resource$Reports$Files$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -25121,7 +25271,7 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Sites$Get { + export interface Params$Resource$Sites$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -25136,7 +25286,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Sites$Insert { + export interface Params$Resource$Sites$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -25152,7 +25302,7 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$Site; } - export interface Params$Resource$Sites$List { + export interface Params$Resource$Sites$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -25230,7 +25380,7 @@ export namespace dfareporting_v3_1 { */ unmappedSite?: boolean; } - export interface Params$Resource$Sites$Patch { + export interface Params$Resource$Sites$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -25250,7 +25400,7 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$Site; } - export interface Params$Resource$Sites$Update { + export interface Params$Resource$Sites$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -25482,7 +25632,7 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Sizes$Get { + export interface Params$Resource$Sizes$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -25497,7 +25647,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Sizes$Insert { + export interface Params$Resource$Sizes$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -25513,7 +25663,7 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$Size; } - export interface Params$Resource$Sizes$List { + export interface Params$Resource$Sizes$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -25901,7 +26051,7 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Subaccounts$Get { + export interface Params$Resource$Subaccounts$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -25916,7 +26066,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Subaccounts$Insert { + export interface Params$Resource$Subaccounts$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -25932,7 +26083,7 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$Subaccount; } - export interface Params$Resource$Subaccounts$List { + export interface Params$Resource$Subaccounts$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -25973,7 +26124,8 @@ export namespace dfareporting_v3_1 { */ sortOrder?: string; } - export interface Params$Resource$Subaccounts$Patch { + export interface Params$Resource$Subaccounts$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -25993,7 +26145,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$Subaccount; } - export interface Params$Resource$Subaccounts$Update { + export interface Params$Resource$Subaccounts$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26177,7 +26330,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Targetableremarketinglists$Get { + export interface Params$Resource$Targetableremarketinglists$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26192,7 +26346,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Targetableremarketinglists$List { + export interface Params$Resource$Targetableremarketinglists$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26613,7 +26768,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Targetingtemplates$Get { + export interface Params$Resource$Targetingtemplates$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26628,7 +26784,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Targetingtemplates$Insert { + export interface Params$Resource$Targetingtemplates$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26644,7 +26801,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$TargetingTemplate; } - export interface Params$Resource$Targetingtemplates$List { + export interface Params$Resource$Targetingtemplates$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26689,7 +26847,8 @@ export namespace dfareporting_v3_1 { */ sortOrder?: string; } - export interface Params$Resource$Targetingtemplates$Patch { + export interface Params$Resource$Targetingtemplates$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26709,7 +26868,8 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$TargetingTemplate; } - export interface Params$Resource$Targetingtemplates$Update { + export interface Params$Resource$Targetingtemplates$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26866,7 +27026,7 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Userprofiles$Get { + export interface Params$Resource$Userprofiles$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -26877,7 +27037,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Userprofiles$List { + export interface Params$Resource$Userprofiles$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -27044,7 +27205,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Userrolepermissiongroups$Get { + export interface Params$Resource$Userrolepermissiongroups$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -27059,7 +27221,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Userrolepermissiongroups$List { + export interface Params$Resource$Userrolepermissiongroups$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -27229,7 +27392,8 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Userrolepermissions$Get { + export interface Params$Resource$Userrolepermissions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -27244,7 +27408,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Userrolepermissions$List { + export interface Params$Resource$Userrolepermissions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -27679,7 +27844,7 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Userroles$Delete { + export interface Params$Resource$Userroles$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -27694,7 +27859,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Userroles$Get { + export interface Params$Resource$Userroles$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -27709,7 +27874,7 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Userroles$Insert { + export interface Params$Resource$Userroles$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -27725,7 +27890,7 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$UserRole; } - export interface Params$Resource$Userroles$List { + export interface Params$Resource$Userroles$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -27775,7 +27940,7 @@ export namespace dfareporting_v3_1 { */ subaccountId?: string; } - export interface Params$Resource$Userroles$Patch { + export interface Params$Resource$Userroles$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -27795,7 +27960,7 @@ export namespace dfareporting_v3_1 { */ requestBody?: Schema$UserRole; } - export interface Params$Resource$Userroles$Update { + export interface Params$Resource$Userroles$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -27958,7 +28123,7 @@ export namespace dfareporting_v3_1 { } } - export interface Params$Resource$Videoformats$Get { + export interface Params$Resource$Videoformats$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -27973,7 +28138,8 @@ export namespace dfareporting_v3_1 { */ profileId?: string; } - export interface Params$Resource$Videoformats$List { + export interface Params$Resource$Videoformats$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/dfareporting/v3.2.ts b/src/apis/dfareporting/v3.2.ts index ab9787010d..8b7867d342 100644 --- a/src/apis/dfareporting/v3.2.ts +++ b/src/apis/dfareporting/v3.2.ts @@ -29,6 +29,40 @@ export namespace dfareporting_v3_2 { version: 'v3_2'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * DCM/DFA Reporting And Trafficking API * @@ -7723,7 +7757,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Accountactiveadsummaries$Get { + export interface Params$Resource$Accountactiveadsummaries$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7899,7 +7934,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Accountpermissiongroups$Get { + export interface Params$Resource$Accountpermissiongroups$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7914,7 +7950,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Accountpermissiongroups$List { + export interface Params$Resource$Accountpermissiongroups$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8081,7 +8118,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Accountpermissions$Get { + export interface Params$Resource$Accountpermissions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8096,7 +8134,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Accountpermissions$List { + export interface Params$Resource$Accountpermissions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8392,7 +8431,7 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Accounts$Get { + export interface Params$Resource$Accounts$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8407,7 +8446,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Accounts$List { + export interface Params$Resource$Accounts$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8452,7 +8491,7 @@ export namespace dfareporting_v3_2 { */ sortOrder?: string; } - export interface Params$Resource$Accounts$Patch { + export interface Params$Resource$Accounts$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8472,7 +8511,7 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$Account; } - export interface Params$Resource$Accounts$Update { + export interface Params$Resource$Accounts$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8868,7 +8907,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Accountuserprofiles$Get { + export interface Params$Resource$Accountuserprofiles$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8883,7 +8923,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Accountuserprofiles$Insert { + export interface Params$Resource$Accountuserprofiles$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8899,7 +8940,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$AccountUserProfile; } - export interface Params$Resource$Accountuserprofiles$List { + export interface Params$Resource$Accountuserprofiles$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8952,7 +8994,8 @@ export namespace dfareporting_v3_2 { */ userRoleId?: string; } - export interface Params$Resource$Accountuserprofiles$Patch { + export interface Params$Resource$Accountuserprofiles$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8972,7 +9015,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$AccountUserProfile; } - export interface Params$Resource$Accountuserprofiles$Update { + export interface Params$Resource$Accountuserprofiles$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9350,7 +9394,7 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Ads$Get { + export interface Params$Resource$Ads$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9365,7 +9409,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Ads$Insert { + export interface Params$Resource$Ads$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9381,7 +9425,7 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$Ad; } - export interface Params$Resource$Ads$List { + export interface Params$Resource$Ads$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9497,7 +9541,7 @@ export namespace dfareporting_v3_2 { */ type?: string; } - export interface Params$Resource$Ads$Patch { + export interface Params$Resource$Ads$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9517,7 +9561,7 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$Ad; } - export interface Params$Resource$Ads$Update { + export interface Params$Resource$Ads$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9976,7 +10020,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Advertisergroups$Delete { + export interface Params$Resource$Advertisergroups$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9991,7 +10036,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Advertisergroups$Get { + export interface Params$Resource$Advertisergroups$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10006,7 +10052,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Advertisergroups$Insert { + export interface Params$Resource$Advertisergroups$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10022,7 +10069,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$AdvertiserGroup; } - export interface Params$Resource$Advertisergroups$List { + export interface Params$Resource$Advertisergroups$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10063,7 +10111,8 @@ export namespace dfareporting_v3_2 { */ sortOrder?: string; } - export interface Params$Resource$Advertisergroups$Patch { + export interface Params$Resource$Advertisergroups$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10083,7 +10132,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$AdvertiserGroup; } - export interface Params$Resource$Advertisergroups$Update { + export interface Params$Resource$Advertisergroups$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10481,7 +10531,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Advertiserlandingpages$Get { + export interface Params$Resource$Advertiserlandingpages$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10496,7 +10547,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Advertiserlandingpages$Insert { + export interface Params$Resource$Advertiserlandingpages$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10512,7 +10564,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$LandingPage; } - export interface Params$Resource$Advertiserlandingpages$List { + export interface Params$Resource$Advertiserlandingpages$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10570,7 +10623,8 @@ export namespace dfareporting_v3_2 { */ subaccountId?: string; } - export interface Params$Resource$Advertiserlandingpages$Patch { + export interface Params$Resource$Advertiserlandingpages$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10590,7 +10644,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$LandingPage; } - export interface Params$Resource$Advertiserlandingpages$Update { + export interface Params$Resource$Advertiserlandingpages$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10973,7 +11028,7 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Advertisers$Get { + export interface Params$Resource$Advertisers$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -10988,7 +11043,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Advertisers$Insert { + export interface Params$Resource$Advertisers$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -11004,7 +11060,7 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$Advertiser; } - export interface Params$Resource$Advertisers$List { + export interface Params$Resource$Advertisers$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11070,7 +11126,8 @@ export namespace dfareporting_v3_2 { */ subaccountId?: string; } - export interface Params$Resource$Advertisers$Patch { + export interface Params$Resource$Advertisers$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -11090,7 +11147,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$Advertiser; } - export interface Params$Resource$Advertisers$Update { + export interface Params$Resource$Advertisers$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -11187,7 +11245,7 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Browsers$List { + export interface Params$Resource$Browsers$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11373,7 +11431,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Campaigncreativeassociations$Insert { + export interface Params$Resource$Campaigncreativeassociations$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -11393,7 +11452,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$CampaignCreativeAssociation; } - export interface Params$Resource$Campaigncreativeassociations$List { + export interface Params$Resource$Campaigncreativeassociations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -11778,7 +11838,7 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Campaigns$Get { + export interface Params$Resource$Campaigns$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11793,7 +11853,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Campaigns$Insert { + export interface Params$Resource$Campaigns$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11809,7 +11869,7 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$Campaign; } - export interface Params$Resource$Campaigns$List { + export interface Params$Resource$Campaigns$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11880,7 +11940,7 @@ export namespace dfareporting_v3_2 { */ subaccountId?: string; } - export interface Params$Resource$Campaigns$Patch { + export interface Params$Resource$Campaigns$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11900,7 +11960,7 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$Campaign; } - export interface Params$Resource$Campaigns$Update { + export interface Params$Resource$Campaigns$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -12072,7 +12132,7 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Changelogs$Get { + export interface Params$Resource$Changelogs$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -12087,7 +12147,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Changelogs$List { + export interface Params$Resource$Changelogs$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -12233,7 +12293,7 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Cities$List { + export interface Params$Resource$Cities$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -12414,7 +12474,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Connectiontypes$Get { + export interface Params$Resource$Connectiontypes$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12429,7 +12490,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Connectiontypes$List { + export interface Params$Resource$Connectiontypes$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12883,7 +12945,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Contentcategories$Delete { + export interface Params$Resource$Contentcategories$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12898,7 +12961,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Contentcategories$Get { + export interface Params$Resource$Contentcategories$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12913,7 +12977,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Contentcategories$Insert { + export interface Params$Resource$Contentcategories$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12929,7 +12994,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$ContentCategory; } - export interface Params$Resource$Contentcategories$List { + export interface Params$Resource$Contentcategories$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12970,7 +13036,8 @@ export namespace dfareporting_v3_2 { */ sortOrder?: string; } - export interface Params$Resource$Contentcategories$Patch { + export interface Params$Resource$Contentcategories$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12990,7 +13057,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$ContentCategory; } - export interface Params$Resource$Contentcategories$Update { + export interface Params$Resource$Contentcategories$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13176,7 +13244,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Conversions$Batchinsert { + export interface Params$Resource$Conversions$Batchinsert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13192,7 +13261,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$ConversionsBatchInsertRequest; } - export interface Params$Resource$Conversions$Batchupdate { + export interface Params$Resource$Conversions$Batchupdate extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13353,7 +13423,7 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Countries$Get { + export interface Params$Resource$Countries$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -13368,7 +13438,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Countries$List { + export interface Params$Resource$Countries$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -13472,7 +13542,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Creativeassets$Insert { + export interface Params$Resource$Creativeassets$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13948,7 +14019,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Creativefields$Delete { + export interface Params$Resource$Creativefields$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13963,7 +14035,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Creativefields$Get { + export interface Params$Resource$Creativefields$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13978,7 +14051,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Creativefields$Insert { + export interface Params$Resource$Creativefields$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13994,7 +14068,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$CreativeField; } - export interface Params$Resource$Creativefields$List { + export interface Params$Resource$Creativefields$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14039,7 +14114,8 @@ export namespace dfareporting_v3_2 { */ sortOrder?: string; } - export interface Params$Resource$Creativefields$Patch { + export interface Params$Resource$Creativefields$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14059,7 +14135,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$CreativeField; } - export interface Params$Resource$Creativefields$Update { + export interface Params$Resource$Creativefields$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14526,7 +14603,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Creativefieldvalues$Delete { + export interface Params$Resource$Creativefieldvalues$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14545,7 +14623,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Creativefieldvalues$Get { + export interface Params$Resource$Creativefieldvalues$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14564,7 +14643,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Creativefieldvalues$Insert { + export interface Params$Resource$Creativefieldvalues$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14584,7 +14664,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$CreativeFieldValue; } - export interface Params$Resource$Creativefieldvalues$List { + export interface Params$Resource$Creativefieldvalues$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14624,7 +14705,8 @@ export namespace dfareporting_v3_2 { */ sortOrder?: string; } - export interface Params$Resource$Creativefieldvalues$Patch { + export interface Params$Resource$Creativefieldvalues$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -14648,7 +14730,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$CreativeFieldValue; } - export interface Params$Resource$Creativefieldvalues$Update { + export interface Params$Resource$Creativefieldvalues$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15042,7 +15125,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Creativegroups$Get { + export interface Params$Resource$Creativegroups$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15057,7 +15141,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Creativegroups$Insert { + export interface Params$Resource$Creativegroups$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15073,7 +15158,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$CreativeGroup; } - export interface Params$Resource$Creativegroups$List { + export interface Params$Resource$Creativegroups$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15122,7 +15208,8 @@ export namespace dfareporting_v3_2 { */ sortOrder?: string; } - export interface Params$Resource$Creativegroups$Patch { + export interface Params$Resource$Creativegroups$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15142,7 +15229,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$CreativeGroup; } - export interface Params$Resource$Creativegroups$Update { + export interface Params$Resource$Creativegroups$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15519,7 +15607,7 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Creatives$Get { + export interface Params$Resource$Creatives$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -15534,7 +15622,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Creatives$Insert { + export interface Params$Resource$Creatives$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -15550,7 +15638,7 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$Creative; } - export interface Params$Resource$Creatives$List { + export interface Params$Resource$Creatives$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -15633,7 +15721,7 @@ export namespace dfareporting_v3_2 { */ types?: string; } - export interface Params$Resource$Creatives$Patch { + export interface Params$Resource$Creatives$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -15653,7 +15741,7 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$Creative; } - export interface Params$Resource$Creatives$Update { + export interface Params$Resource$Creatives$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -15755,7 +15843,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Dimensionvalues$Query { + export interface Params$Resource$Dimensionvalues$Query extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15948,7 +16037,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Directorysitecontacts$Get { + export interface Params$Resource$Directorysitecontacts$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -15963,7 +16053,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Directorysitecontacts$List { + export interface Params$Resource$Directorysitecontacts$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -16247,7 +16338,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Directorysites$Get { + export interface Params$Resource$Directorysites$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -16262,7 +16354,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Directorysites$Insert { + export interface Params$Resource$Directorysites$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -16278,7 +16371,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$DirectorySite; } - export interface Params$Resource$Directorysites$List { + export interface Params$Resource$Directorysites$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -16593,7 +16687,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Dynamictargetingkeys$Delete { + export interface Params$Resource$Dynamictargetingkeys$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -16619,7 +16714,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Dynamictargetingkeys$Insert { + export interface Params$Resource$Dynamictargetingkeys$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -16635,7 +16731,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$DynamicTargetingKey; } - export interface Params$Resource$Dynamictargetingkeys$List { + export interface Params$Resource$Dynamictargetingkeys$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17083,7 +17180,7 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Eventtags$Delete { + export interface Params$Resource$Eventtags$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -17098,7 +17195,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Eventtags$Get { + export interface Params$Resource$Eventtags$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -17113,7 +17210,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Eventtags$Insert { + export interface Params$Resource$Eventtags$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -17129,7 +17226,7 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$EventTag; } - export interface Params$Resource$Eventtags$List { + export interface Params$Resource$Eventtags$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -17200,7 +17297,7 @@ export namespace dfareporting_v3_2 { */ sortOrder?: string; } - export interface Params$Resource$Eventtags$Patch { + export interface Params$Resource$Eventtags$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -17220,7 +17317,7 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$EventTag; } - export interface Params$Resource$Eventtags$Update { + export interface Params$Resource$Eventtags$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -17384,7 +17481,7 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Files$Get { + export interface Params$Resource$Files$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -17399,7 +17496,7 @@ export namespace dfareporting_v3_2 { */ reportId?: string; } - export interface Params$Resource$Files$List { + export interface Params$Resource$Files$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -17962,7 +18059,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Floodlightactivities$Delete { + export interface Params$Resource$Floodlightactivities$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17977,7 +18075,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Floodlightactivities$Generatetag { + export interface Params$Resource$Floodlightactivities$Generatetag extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -17992,7 +18091,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Floodlightactivities$Get { + export interface Params$Resource$Floodlightactivities$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18007,7 +18107,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Floodlightactivities$Insert { + export interface Params$Resource$Floodlightactivities$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18023,7 +18124,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$FloodlightActivity; } - export interface Params$Resource$Floodlightactivities$List { + export interface Params$Resource$Floodlightactivities$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18103,7 +18205,8 @@ export namespace dfareporting_v3_2 { */ tagString?: string; } - export interface Params$Resource$Floodlightactivities$Patch { + export interface Params$Resource$Floodlightactivities$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18123,7 +18226,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$FloodlightActivity; } - export interface Params$Resource$Floodlightactivities$Update { + export interface Params$Resource$Floodlightactivities$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18527,7 +18631,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Floodlightactivitygroups$Get { + export interface Params$Resource$Floodlightactivitygroups$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18542,7 +18647,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Floodlightactivitygroups$Insert { + export interface Params$Resource$Floodlightactivitygroups$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18558,7 +18664,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$FloodlightActivityGroup; } - export interface Params$Resource$Floodlightactivitygroups$List { + export interface Params$Resource$Floodlightactivitygroups$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18619,7 +18726,8 @@ export namespace dfareporting_v3_2 { */ type?: string; } - export interface Params$Resource$Floodlightactivitygroups$Patch { + export interface Params$Resource$Floodlightactivitygroups$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18639,7 +18747,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$FloodlightActivityGroup; } - export interface Params$Resource$Floodlightactivitygroups$Update { + export interface Params$Resource$Floodlightactivitygroups$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18962,7 +19071,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Floodlightconfigurations$Get { + export interface Params$Resource$Floodlightconfigurations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18977,7 +19087,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Floodlightconfigurations$List { + export interface Params$Resource$Floodlightconfigurations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -18993,7 +19104,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Floodlightconfigurations$Patch { + export interface Params$Resource$Floodlightconfigurations$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19013,7 +19125,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$FloodlightConfiguration; } - export interface Params$Resource$Floodlightconfigurations$Update { + export interface Params$Resource$Floodlightconfigurations$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19194,7 +19307,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Inventoryitems$Get { + export interface Params$Resource$Inventoryitems$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19213,7 +19327,8 @@ export namespace dfareporting_v3_2 { */ projectId?: string; } - export interface Params$Resource$Inventoryitems$List { + export interface Params$Resource$Inventoryitems$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19345,7 +19460,7 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Languages$List { + export interface Params$Resource$Languages$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -19436,7 +19551,7 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Metros$List { + export interface Params$Resource$Metros$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -19598,7 +19713,7 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Mobileapps$Get { + export interface Params$Resource$Mobileapps$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -19613,7 +19728,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Mobileapps$List { + export interface Params$Resource$Mobileapps$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -19802,7 +19917,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Mobilecarriers$Get { + export interface Params$Resource$Mobilecarriers$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19817,7 +19933,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Mobilecarriers$List { + export interface Params$Resource$Mobilecarriers$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19984,7 +20101,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Operatingsystems$Get { + export interface Params$Resource$Operatingsystems$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -19999,7 +20117,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Operatingsystems$List { + export interface Params$Resource$Operatingsystems$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -20171,7 +20290,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Operatingsystemversions$Get { + export interface Params$Resource$Operatingsystemversions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -20186,7 +20306,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Operatingsystemversions$List { + export interface Params$Resource$Operatingsystemversions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -20362,7 +20483,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Orderdocuments$Get { + export interface Params$Resource$Orderdocuments$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -20381,7 +20503,8 @@ export namespace dfareporting_v3_2 { */ projectId?: string; } - export interface Params$Resource$Orderdocuments$List { + export interface Params$Resource$Orderdocuments$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -20593,7 +20716,7 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Orders$Get { + export interface Params$Resource$Orders$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -20612,7 +20735,7 @@ export namespace dfareporting_v3_2 { */ projectId?: string; } - export interface Params$Resource$Orders$List { + export interface Params$Resource$Orders$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -21046,7 +21169,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Placementgroups$Get { + export interface Params$Resource$Placementgroups$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -21061,7 +21185,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Placementgroups$Insert { + export interface Params$Resource$Placementgroups$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -21077,7 +21202,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$PlacementGroup; } - export interface Params$Resource$Placementgroups$List { + export interface Params$Resource$Placementgroups$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -21185,7 +21311,8 @@ export namespace dfareporting_v3_2 { */ sortOrder?: string; } - export interface Params$Resource$Placementgroups$Patch { + export interface Params$Resource$Placementgroups$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -21205,7 +21332,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$PlacementGroup; } - export interface Params$Resource$Placementgroups$Update { + export interface Params$Resource$Placementgroups$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -21675,7 +21803,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Placements$Generatetags { + export interface Params$Resource$Placements$Generatetags extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -21699,7 +21828,7 @@ export namespace dfareporting_v3_2 { */ tagFormats?: string; } - export interface Params$Resource$Placements$Get { + export interface Params$Resource$Placements$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -21714,7 +21843,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Placements$Insert { + export interface Params$Resource$Placements$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -21730,7 +21860,7 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$Placement; } - export interface Params$Resource$Placements$List { + export interface Params$Resource$Placements$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -21847,7 +21977,7 @@ export namespace dfareporting_v3_2 { */ sortOrder?: string; } - export interface Params$Resource$Placements$Patch { + export interface Params$Resource$Placements$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -21867,7 +21997,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$Placement; } - export interface Params$Resource$Placements$Update { + export interface Params$Resource$Placements$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22328,7 +22459,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Placementstrategies$Delete { + export interface Params$Resource$Placementstrategies$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22343,7 +22475,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Placementstrategies$Get { + export interface Params$Resource$Placementstrategies$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22358,7 +22491,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Placementstrategies$Insert { + export interface Params$Resource$Placementstrategies$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22374,7 +22508,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$PlacementStrategy; } - export interface Params$Resource$Placementstrategies$List { + export interface Params$Resource$Placementstrategies$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22416,7 +22551,8 @@ export namespace dfareporting_v3_2 { */ sortOrder?: string; } - export interface Params$Resource$Placementstrategies$Patch { + export interface Params$Resource$Placementstrategies$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22436,7 +22572,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$PlacementStrategy; } - export interface Params$Resource$Placementstrategies$Update { + export interface Params$Resource$Placementstrategies$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22602,7 +22739,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Platformtypes$Get { + export interface Params$Resource$Platformtypes$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22617,7 +22755,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Platformtypes$List { + export interface Params$Resource$Platformtypes$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -22774,7 +22913,7 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Postalcodes$Get { + export interface Params$Resource$Postalcodes$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -22789,7 +22928,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Postalcodes$List { + export interface Params$Resource$Postalcodes$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -22952,7 +23091,7 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Projects$Get { + export interface Params$Resource$Projects$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -22967,7 +23106,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Projects$List { + export interface Params$Resource$Projects$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -23091,7 +23230,7 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Regions$List { + export interface Params$Resource$Regions$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -23479,7 +23618,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Remarketinglists$Get { + export interface Params$Resource$Remarketinglists$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23494,7 +23634,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Remarketinglists$Insert { + export interface Params$Resource$Remarketinglists$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23510,7 +23651,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$RemarketingList; } - export interface Params$Resource$Remarketinglists$List { + export interface Params$Resource$Remarketinglists$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23559,7 +23701,8 @@ export namespace dfareporting_v3_2 { */ sortOrder?: string; } - export interface Params$Resource$Remarketinglists$Patch { + export interface Params$Resource$Remarketinglists$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23579,7 +23722,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$RemarketingList; } - export interface Params$Resource$Remarketinglists$Update { + export interface Params$Resource$Remarketinglists$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23820,7 +23964,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Remarketinglistshares$Get { + export interface Params$Resource$Remarketinglistshares$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23835,7 +23980,8 @@ export namespace dfareporting_v3_2 { */ remarketingListId?: string; } - export interface Params$Resource$Remarketinglistshares$Patch { + export interface Params$Resource$Remarketinglistshares$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -23855,7 +24001,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$RemarketingListShare; } - export interface Params$Resource$Remarketinglistshares$Update { + export interface Params$Resource$Remarketinglistshares$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -24357,7 +24504,7 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Reports$Delete { + export interface Params$Resource$Reports$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -24372,7 +24519,7 @@ export namespace dfareporting_v3_2 { */ reportId?: string; } - export interface Params$Resource$Reports$Get { + export interface Params$Resource$Reports$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -24387,7 +24534,7 @@ export namespace dfareporting_v3_2 { */ reportId?: string; } - export interface Params$Resource$Reports$Insert { + export interface Params$Resource$Reports$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -24403,7 +24550,7 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$Report; } - export interface Params$Resource$Reports$List { + export interface Params$Resource$Reports$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -24434,7 +24581,7 @@ export namespace dfareporting_v3_2 { */ sortOrder?: string; } - export interface Params$Resource$Reports$Patch { + export interface Params$Resource$Reports$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -24454,7 +24601,7 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$Report; } - export interface Params$Resource$Reports$Run { + export interface Params$Resource$Reports$Run extends StandardParameters { /** * Auth client or API Key for the request */ @@ -24473,7 +24620,7 @@ export namespace dfareporting_v3_2 { */ synchronous?: boolean; } - export interface Params$Resource$Reports$Update { + export interface Params$Resource$Reports$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -24578,7 +24725,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Reports$Compatiblefields$Query { + export interface Params$Resource$Reports$Compatiblefields$Query extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -24746,7 +24894,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Reports$Files$Get { + export interface Params$Resource$Reports$Files$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -24765,7 +24914,8 @@ export namespace dfareporting_v3_2 { */ reportId?: string; } - export interface Params$Resource$Reports$Files$List { + export interface Params$Resource$Reports$Files$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -25155,7 +25305,7 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Sites$Get { + export interface Params$Resource$Sites$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -25170,7 +25320,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Sites$Insert { + export interface Params$Resource$Sites$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -25186,7 +25336,7 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$Site; } - export interface Params$Resource$Sites$List { + export interface Params$Resource$Sites$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -25264,7 +25414,7 @@ export namespace dfareporting_v3_2 { */ unmappedSite?: boolean; } - export interface Params$Resource$Sites$Patch { + export interface Params$Resource$Sites$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -25284,7 +25434,7 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$Site; } - export interface Params$Resource$Sites$Update { + export interface Params$Resource$Sites$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -25516,7 +25666,7 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Sizes$Get { + export interface Params$Resource$Sizes$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -25531,7 +25681,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Sizes$Insert { + export interface Params$Resource$Sizes$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -25547,7 +25697,7 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$Size; } - export interface Params$Resource$Sizes$List { + export interface Params$Resource$Sizes$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -25935,7 +26085,7 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Subaccounts$Get { + export interface Params$Resource$Subaccounts$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -25950,7 +26100,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Subaccounts$Insert { + export interface Params$Resource$Subaccounts$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -25966,7 +26117,7 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$Subaccount; } - export interface Params$Resource$Subaccounts$List { + export interface Params$Resource$Subaccounts$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -26007,7 +26158,8 @@ export namespace dfareporting_v3_2 { */ sortOrder?: string; } - export interface Params$Resource$Subaccounts$Patch { + export interface Params$Resource$Subaccounts$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26027,7 +26179,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$Subaccount; } - export interface Params$Resource$Subaccounts$Update { + export interface Params$Resource$Subaccounts$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26211,7 +26364,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Targetableremarketinglists$Get { + export interface Params$Resource$Targetableremarketinglists$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26226,7 +26380,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Targetableremarketinglists$List { + export interface Params$Resource$Targetableremarketinglists$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26647,7 +26802,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Targetingtemplates$Get { + export interface Params$Resource$Targetingtemplates$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26662,7 +26818,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Targetingtemplates$Insert { + export interface Params$Resource$Targetingtemplates$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26678,7 +26835,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$TargetingTemplate; } - export interface Params$Resource$Targetingtemplates$List { + export interface Params$Resource$Targetingtemplates$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26723,7 +26881,8 @@ export namespace dfareporting_v3_2 { */ sortOrder?: string; } - export interface Params$Resource$Targetingtemplates$Patch { + export interface Params$Resource$Targetingtemplates$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26743,7 +26902,8 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$TargetingTemplate; } - export interface Params$Resource$Targetingtemplates$Update { + export interface Params$Resource$Targetingtemplates$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -26900,7 +27060,7 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Userprofiles$Get { + export interface Params$Resource$Userprofiles$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -26911,7 +27071,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Userprofiles$List { + export interface Params$Resource$Userprofiles$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -27078,7 +27239,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Userrolepermissiongroups$Get { + export interface Params$Resource$Userrolepermissiongroups$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -27093,7 +27255,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Userrolepermissiongroups$List { + export interface Params$Resource$Userrolepermissiongroups$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -27263,7 +27426,8 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Userrolepermissions$Get { + export interface Params$Resource$Userrolepermissions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -27278,7 +27442,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Userrolepermissions$List { + export interface Params$Resource$Userrolepermissions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -27713,7 +27878,7 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Userroles$Delete { + export interface Params$Resource$Userroles$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -27728,7 +27893,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Userroles$Get { + export interface Params$Resource$Userroles$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -27743,7 +27908,7 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Userroles$Insert { + export interface Params$Resource$Userroles$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -27759,7 +27924,7 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$UserRole; } - export interface Params$Resource$Userroles$List { + export interface Params$Resource$Userroles$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -27809,7 +27974,7 @@ export namespace dfareporting_v3_2 { */ subaccountId?: string; } - export interface Params$Resource$Userroles$Patch { + export interface Params$Resource$Userroles$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -27829,7 +27994,7 @@ export namespace dfareporting_v3_2 { */ requestBody?: Schema$UserRole; } - export interface Params$Resource$Userroles$Update { + export interface Params$Resource$Userroles$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -27992,7 +28157,7 @@ export namespace dfareporting_v3_2 { } } - export interface Params$Resource$Videoformats$Get { + export interface Params$Resource$Videoformats$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -28007,7 +28172,8 @@ export namespace dfareporting_v3_2 { */ profileId?: string; } - export interface Params$Resource$Videoformats$List { + export interface Params$Resource$Videoformats$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/dialogflow/README.md b/src/apis/dialogflow/README.md index 3b6e1245e1..fb9c7905a5 100644 --- a/src/apis/dialogflow/README.md +++ b/src/apis/dialogflow/README.md @@ -2,7 +2,7 @@ # @google/dialogflow -> An end-to-end development suite for conversational interfaces (e.g., chatbots, voice-powered apps and devices). +> Builds conversational interfaces (for example, chatbots, and voice-powered apps and devices). ## Installation diff --git a/src/apis/dialogflow/v2.ts b/src/apis/dialogflow/v2.ts index 1f4d2f4e10..f5a8416b95 100644 --- a/src/apis/dialogflow/v2.ts +++ b/src/apis/dialogflow/v2.ts @@ -29,11 +29,62 @@ export namespace dialogflow_v2 { version: 'v2'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Dialogflow API * - * An end-to-end development suite for conversational interfaces (e.g., - * chatbots, voice-powered apps and devices). + * Builds conversational interfaces (for example, chatbots, and voice-powered + * apps and devices). * * @example * const {google} = require('googleapis'); @@ -324,6 +375,27 @@ export namespace dialogflow_v2 { */ parameters?: any; } + /** + * Represents a notification sent to Cloud Pub/Sub subscribers for + * conversation lifecycle events. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ConversationEvent { + /** + * Required. The unique identifier of the conversation this notification + * refers to. Format: `projects/<Project + * ID>/conversations/<Conversation ID>`. + */ + conversation?: string; + /** + * Optional. More detailed information about an error. Only set for type + * UNRECOVERABLE_ERROR_IN_PHONE_CALL. + */ + errorStatus?: Schema$GoogleRpcStatus; + /** + * Required. The type of the event that this notification refers to. + */ + type?: string; + } /** * Represents an entity type. Entity types serve as a tool for extracting * parameter values from natural language queries. @@ -335,7 +407,7 @@ export namespace dialogflow_v2 { */ autoExpansionMode?: string; /** - * Required. The name of the entity. + * Required. The name of the entity type. */ displayName?: string; /** @@ -416,6 +488,21 @@ export namespace dialogflow_v2 { */ agentUri?: string; } + /** + * Represents a notification sent to Cloud Pub/Sub subscribers for agent + * assistant events in a specific conversation. + */ + export interface Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistantEvent { + /** + * Required. The conversation this notification refers to. Format: + * `projects/<Project ID>/conversations/<Conversation ID>`. + */ + conversation?: string; + /** + * Required. The type of the event that this notification refers to. + */ + type?: string; + } /** * Represents an intent. Intents convert a number of user expressions or * patterns into an action. An action is an extraction of a user command or @@ -1279,7 +1366,9 @@ export namespace dialogflow_v2 { /** * The unique identifier of detectIntent request session. Can be used to * identify end-user inside webhook implementation. Format: - * `projects/<Project ID>/agent/sessions/<Session ID>`. + * `projects/<Project ID>/agent/sessions/<Session ID>`, or + * `projects/<Project ID>/agent/environments/<Environment + * ID>/users/<User ID>/sessions/<Session ID>`. */ session?: string; } @@ -1339,7 +1428,7 @@ export namespace dialogflow_v2 { /** * Optional. The number of conversational query requests after which the * context expires. If set to `0` (the default) the context expires - * immediately. Contexts expire automatically after 10 minutes even if there + * immediately. Contexts expire automatically after 20 minutes even if there * are no matching queries. */ lifespanCount?: number; @@ -1393,8 +1482,7 @@ export namespace dialogflow_v2 { */ responseId?: string; /** - * Specifies the status of the webhook request. `webhook_status` is never - * populated in webhook requests. + * Specifies the status of the webhook request. */ webhookStatus?: Schema$GoogleRpcStatus; } @@ -1409,7 +1497,7 @@ export namespace dialogflow_v2 { */ autoExpansionMode?: string; /** - * Required. The name of the entity. + * Required. The name of the entity type. */ displayName?: string; /** @@ -2248,9 +2336,9 @@ export namespace dialogflow_v2 { */ resetContexts?: boolean; /** - * Optional. The collection of session entity types to replace or extend - * developer entities with for this query only. The entity synonyms apply to - * all languages. + * Optional. Additional session entity types to replace or extend developer + * entity types with. The entity synonyms apply to all languages and persist + * for the session of this query. */ sessionEntityTypes?: Schema$GoogleCloudDialogflowV2SessionEntityType[]; /** @@ -2406,7 +2494,9 @@ export namespace dialogflow_v2 { /** * Required. The unique identifier of this session entity type. Format: * `projects/<Project ID>/agent/sessions/<Session - * ID>/entityTypes/<Entity Type Display Name>`. + * ID>/entityTypes/<Entity Type Display Name>`. `<Entity Type + * Display Name>` must be the display name of an existing entity type in + * the same agent that will be overridden or supplemented. */ name?: string; } @@ -2454,7 +2544,9 @@ export namespace dialogflow_v2 { /** * The unique identifier of detectIntent request session. Can be used to * identify end-user inside webhook implementation. Format: - * `projects/<Project ID>/agent/sessions/<Session ID>`. + * `projects/<Project ID>/agent/sessions/<Session ID>`, or + * `projects/<Project ID>/agent/environments/<Environment + * ID>/users/<User ID>/sessions/<Session ID>`. */ session?: string; } @@ -2710,7 +2802,8 @@ export namespace dialogflow_v2 { } } - export interface Params$Resource$Projects$Getagent { + export interface Params$Resource$Projects$Getagent extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3084,7 +3177,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall } } - export interface Params$Resource$Projects$Agent$Export { + export interface Params$Resource$Projects$Agent$Export extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3101,7 +3195,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ requestBody?: Schema$GoogleCloudDialogflowV2ExportAgentRequest; } - export interface Params$Resource$Projects$Agent$Import { + export interface Params$Resource$Projects$Agent$Import extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3118,7 +3213,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ requestBody?: Schema$GoogleCloudDialogflowV2ImportAgentRequest; } - export interface Params$Resource$Projects$Agent$Restore { + export interface Params$Resource$Projects$Agent$Restore extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3135,7 +3231,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ requestBody?: Schema$GoogleCloudDialogflowV2RestoreAgentRequest; } - export interface Params$Resource$Projects$Agent$Search { + export interface Params$Resource$Projects$Agent$Search extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3157,7 +3254,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ parent?: string; } - export interface Params$Resource$Projects$Agent$Train { + export interface Params$Resource$Projects$Agent$Train extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3723,7 +3821,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall } } - export interface Params$Resource$Projects$Agent$Entitytypes$Batchdelete { + export interface Params$Resource$Projects$Agent$Entitytypes$Batchdelete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3740,7 +3839,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ requestBody?: Schema$GoogleCloudDialogflowV2BatchDeleteEntityTypesRequest; } - export interface Params$Resource$Projects$Agent$Entitytypes$Batchupdate { + export interface Params$Resource$Projects$Agent$Entitytypes$Batchupdate + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3757,7 +3857,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ requestBody?: Schema$GoogleCloudDialogflowV2BatchUpdateEntityTypesRequest; } - export interface Params$Resource$Projects$Agent$Entitytypes$Create { + export interface Params$Resource$Projects$Agent$Entitytypes$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3781,7 +3882,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ requestBody?: Schema$GoogleCloudDialogflowV2EntityType; } - export interface Params$Resource$Projects$Agent$Entitytypes$Delete { + export interface Params$Resource$Projects$Agent$Entitytypes$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3793,7 +3895,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ name?: string; } - export interface Params$Resource$Projects$Agent$Entitytypes$Get { + export interface Params$Resource$Projects$Agent$Entitytypes$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3812,7 +3915,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ name?: string; } - export interface Params$Resource$Projects$Agent$Entitytypes$List { + export interface Params$Resource$Projects$Agent$Entitytypes$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3841,7 +3945,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ parent?: string; } - export interface Params$Resource$Projects$Agent$Entitytypes$Patch { + export interface Params$Resource$Projects$Agent$Entitytypes$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4123,7 +4228,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall } } - export interface Params$Resource$Projects$Agent$Entitytypes$Entities$Batchcreate { + export interface Params$Resource$Projects$Agent$Entitytypes$Entities$Batchcreate + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4140,7 +4246,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ requestBody?: Schema$GoogleCloudDialogflowV2BatchCreateEntitiesRequest; } - export interface Params$Resource$Projects$Agent$Entitytypes$Entities$Batchdelete { + export interface Params$Resource$Projects$Agent$Entitytypes$Entities$Batchdelete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4157,7 +4264,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ requestBody?: Schema$GoogleCloudDialogflowV2BatchDeleteEntitiesRequest; } - export interface Params$Resource$Projects$Agent$Entitytypes$Entities$Batchupdate { + export interface Params$Resource$Projects$Agent$Entitytypes$Entities$Batchupdate + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4713,7 +4821,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall } } - export interface Params$Resource$Projects$Agent$Intents$Batchdelete { + export interface Params$Resource$Projects$Agent$Intents$Batchdelete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4730,7 +4839,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ requestBody?: Schema$GoogleCloudDialogflowV2BatchDeleteIntentsRequest; } - export interface Params$Resource$Projects$Agent$Intents$Batchupdate { + export interface Params$Resource$Projects$Agent$Intents$Batchupdate extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4747,7 +4857,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ requestBody?: Schema$GoogleCloudDialogflowV2BatchUpdateIntentsRequest; } - export interface Params$Resource$Projects$Agent$Intents$Create { + export interface Params$Resource$Projects$Agent$Intents$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4776,7 +4887,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ requestBody?: Schema$GoogleCloudDialogflowV2Intent; } - export interface Params$Resource$Projects$Agent$Intents$Delete { + export interface Params$Resource$Projects$Agent$Intents$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4789,7 +4901,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ name?: string; } - export interface Params$Resource$Projects$Agent$Intents$Get { + export interface Params$Resource$Projects$Agent$Intents$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4813,7 +4926,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ name?: string; } - export interface Params$Resource$Projects$Agent$Intents$List { + export interface Params$Resource$Projects$Agent$Intents$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4847,7 +4961,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ parent?: string; } - export interface Params$Resource$Projects$Agent$Intents$Patch { + export interface Params$Resource$Projects$Agent$Intents$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5048,7 +5163,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall } } - export interface Params$Resource$Projects$Agent$Sessions$Deletecontexts { + export interface Params$Resource$Projects$Agent$Sessions$Deletecontexts + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5060,7 +5176,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ parent?: string; } - export interface Params$Resource$Projects$Agent$Sessions$Detectintent { + export interface Params$Resource$Projects$Agent$Sessions$Detectintent extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5095,7 +5212,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall /** * dialogflow.projects.agent.sessions.contexts.create - * @desc Creates a context. + * @desc Creates a context. If the specified context already exists, + * overrides the context. * @alias dialogflow.projects.agent.sessions.contexts.create * @memberOf! () * @@ -5462,7 +5580,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall } } - export interface Params$Resource$Projects$Agent$Sessions$Contexts$Create { + export interface Params$Resource$Projects$Agent$Sessions$Contexts$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5479,7 +5598,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ requestBody?: Schema$GoogleCloudDialogflowV2Context; } - export interface Params$Resource$Projects$Agent$Sessions$Contexts$Delete { + export interface Params$Resource$Projects$Agent$Sessions$Contexts$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5491,7 +5611,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ name?: string; } - export interface Params$Resource$Projects$Agent$Sessions$Contexts$Get { + export interface Params$Resource$Projects$Agent$Sessions$Contexts$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5503,7 +5624,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ name?: string; } - export interface Params$Resource$Projects$Agent$Sessions$Contexts$List { + export interface Params$Resource$Projects$Agent$Sessions$Contexts$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5525,7 +5647,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ parent?: string; } - export interface Params$Resource$Projects$Agent$Sessions$Contexts$Patch { + export interface Params$Resource$Projects$Agent$Sessions$Contexts$Patch + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5563,7 +5686,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall /** * dialogflow.projects.agent.sessions.entityTypes.create - * @desc Creates a session entity type. + * @desc Creates a session entity type. If the specified session entity + * type already exists, overrides the session entity type. * @alias dialogflow.projects.agent.sessions.entityTypes.create * @memberOf! () * @@ -5871,7 +5995,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The unique identifier of this session entity type. Format: `projects//agent/sessions//entityTypes/`. + * @param {string} params.name Required. The unique identifier of this session entity type. Format: `projects//agent/sessions//entityTypes/`. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented. * @param {string=} params.updateMask Optional. The mask to control which fields get updated. * @param {().GoogleCloudDialogflowV2SessionEntityType} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5942,7 +6066,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall } } - export interface Params$Resource$Projects$Agent$Sessions$Entitytypes$Create { + export interface Params$Resource$Projects$Agent$Sessions$Entitytypes$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5959,7 +6084,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ requestBody?: Schema$GoogleCloudDialogflowV2SessionEntityType; } - export interface Params$Resource$Projects$Agent$Sessions$Entitytypes$Delete { + export interface Params$Resource$Projects$Agent$Sessions$Entitytypes$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5972,7 +6098,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ name?: string; } - export interface Params$Resource$Projects$Agent$Sessions$Entitytypes$Get { + export interface Params$Resource$Projects$Agent$Sessions$Entitytypes$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5984,7 +6111,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ name?: string; } - export interface Params$Resource$Projects$Agent$Sessions$Entitytypes$List { + export interface Params$Resource$Projects$Agent$Sessions$Entitytypes$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6006,7 +6134,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ parent?: string; } - export interface Params$Resource$Projects$Agent$Sessions$Entitytypes$Patch { + export interface Params$Resource$Projects$Agent$Sessions$Entitytypes$Patch + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6015,7 +6144,9 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall /** * Required. The unique identifier of this session entity type. Format: * `projects//agent/sessions//entityTypes/`. + * Type Display Name>`. `` must be the display + * name of an existing entity type in the same agent that will be overridden + * or supplemented. */ name?: string; /** @@ -6113,7 +6244,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall } } - export interface Params$Resource$Projects$Operations$Get { + export interface Params$Resource$Projects$Operations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/dialogflow/v2beta1.ts b/src/apis/dialogflow/v2beta1.ts index 9bb32913c7..1ecfd6b350 100644 --- a/src/apis/dialogflow/v2beta1.ts +++ b/src/apis/dialogflow/v2beta1.ts @@ -29,11 +29,62 @@ export namespace dialogflow_v2beta1 { version: 'v2beta1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Dialogflow API * - * An end-to-end development suite for conversational interfaces (e.g., - * chatbots, voice-powered apps and devices). + * Builds conversational interfaces (for example, chatbots, and voice-powered + * apps and devices). * * @example * const {google} = require('googleapis'); @@ -83,11 +134,6 @@ export namespace dialogflow_v2beta1 { */ intents?: Schema$GoogleCloudDialogflowV2Intent[]; } - /** - * The request message for Conversations.AddConversationPhoneNumber. - */ - export interface Schema$GoogleCloudDialogflowV2beta1AddConversationPhoneNumberRequest { - } /** * Represents a conversational agent. */ @@ -149,85 +195,6 @@ export namespace dialogflow_v2beta1 { */ timeZone?: string; } - /** - * The request message for Conversations.AnalyzeContent. - */ - export interface Schema$GoogleCloudDialogflowV2beta1AnalyzeContentRequest { - /** - * The natural language speech audio to be processed. - */ - audio?: Schema$GoogleCloudDialogflowV2beta1InputAudio; - /** - * Optional. Instructs the speech synthesizer how to generate the output - * audio. - */ - replyAudioConfig?: Schema$GoogleCloudDialogflowV2beta1OutputAudioConfig; - /** - * The natural language text to be processed. - */ - text?: Schema$GoogleCloudDialogflowV2beta1InputText; - } - /** - * The response message for Conversations.AnalyzeContent. - */ - export interface Schema$GoogleCloudDialogflowV2beta1AnalyzeContentResponse { - /** - * Optional. Only set if a Dialogflow automated agent has responded. - */ - automatedAgentReply?: - Schema$GoogleCloudDialogflowV2beta1AutomatedAgentReply; - /** - * Optional. The audio data bytes encoded as specified in the request. This - * field is set if: - `reply_audio_config` was specified in the request, or - * - The automated agent responded with audio to play to the user. In such - * case, `reply_audio.config` contains settings used to synthesize the - * speech. - */ - replyAudio?: Schema$GoogleCloudDialogflowV2beta1OutputAudio; - /** - * Output only. The output text content. This field is set if the automated - * agent responded with text to show to the user. - */ - replyText?: string; - } - /** - * Defines article suggestions that a human agent assistant can provide. - */ - export interface Schema$GoogleCloudDialogflowV2beta1ArticleSuggestionConfig { - /** - * Required. Settings for knowledge base, Format: `projects/<Project - * ID>/knowledgeBases/<Knowledge Base ID>`. - */ - knowledgeBaseName?: string; - } - /** - * Defines the Automated Agent to connect to a conversation. - */ - export interface Schema$GoogleCloudDialogflowV2beta1AutomatedAgentConfig { - /** - * Required. ID of the Dialogflow agent environment to use. This project - * needs to either be the same project as the conversation or you need to - * grant `service-<Conversation Project - * Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` the `Dialogflow API - * Service Agent` role in this project. Format: `projects/<Project - * ID>/agent/environments/<Environment ID or '-'>` If - * environment is not specified, the default `draft` environment is used. - * Refer to - * [DetectIntentRequest](/dialogflow-enterprise/docs/reference/rpc/google.cloud.dialogflow.v2beta1#google.cloud.dialogflow.v2beta1.DetectIntentRequest) - * for more details. - */ - agent?: string; - } - /** - * Represent a response from an automated agent. - */ - export interface Schema$GoogleCloudDialogflowV2beta1AutomatedAgentReply { - /** - * Required. Response of the Dialogflow Sessions.DetectIntent call. - */ - detectIntentResponse?: - Schema$GoogleCloudDialogflowV2beta1DetectIntentResponse; - } /** * The request message for EntityTypes.BatchCreateEntities. */ @@ -379,34 +346,6 @@ export namespace dialogflow_v2beta1 { */ intents?: Schema$GoogleCloudDialogflowV2beta1Intent[]; } - /** - * The request message for PhoneNumberOrders.CancelPhoneNumberOrder. - */ - export interface Schema$GoogleCloudDialogflowV2beta1CancelPhoneNumberOrderRequest { - } - /** - * The request message for HumanAgentAssistants.RequestCompileSuggestions. - */ - export interface Schema$GoogleCloudDialogflowV2beta1CompileSuggestionsRequest { - /** - * Required. List of messages in a conversation in chronological order. - */ - messages?: Schema$GoogleCloudDialogflowV2beta1Message[]; - } - /** - * The response message for HumanAgentAssistants.RequestCompileSuggestions - */ - export interface Schema$GoogleCloudDialogflowV2beta1CompileSuggestionsResponse { - /** - * Required. - */ - suggestions?: Schema$GoogleCloudDialogflowV2beta1Suggestion[]; - } - /** - * The request message for Conversations.CompleteConversation. - */ - export interface Schema$GoogleCloudDialogflowV2beta1CompleteConversationRequest { - } /** * Represents a context. */ @@ -437,84 +376,25 @@ export namespace dialogflow_v2beta1 { parameters?: any; } /** - * Represents a conversation. A conversation is an interaction between an - * agent, including live agents and Dialogflow agents, and a support customer. - * Conversations can include phone calls and text-based chat sessions. - */ - export interface Schema$GoogleCloudDialogflowV2beta1Conversation { - /** - * Required. The Conversation Profile to be used to configure this - * Conversation. This field cannot be updated. Format: `projects/<Project - * ID>/conversationProfiles/<Conversation Profile ID>`. - */ - conversationProfile?: string; - /** - * Output only. The time the conversation was finished. - */ - endTime?: string; - /** - * Output only. The current state of the Conversation. - */ - lifecycleState?: string; - /** - * The unique identifier of this conversation. Required for all methods - * except `create` (`create` populates the name automatically). Format: - * `projects/<Project ID>/conversations/<Conversation ID>`. - */ - name?: string; - /** - * Output only. Required if the conversation is to be connected over - * telephony. - */ - phoneNumber?: Schema$GoogleCloudDialogflowV2beta1ConversationPhoneNumber; - /** - * Output only. The time the conversation was started. - */ - startTime?: string; - } - /** - * Represents a phone number for telephony integration. It allows for - * connecting a particular conversation over telephony. - */ - export interface Schema$GoogleCloudDialogflowV2beta1ConversationPhoneNumber { - /** - * Output only. The phone number to connect to this conversation. - */ - phoneNumber?: string; - } - /** - * Defines the services to connect to incoming Dialogflow conversations. + * Represents a notification sent to Cloud Pub/Sub subscribers for + * conversation lifecycle events. */ - export interface Schema$GoogleCloudDialogflowV2beta1ConversationProfile { - /** - * Optional. Configuration for an automated agent to use with this profile. - */ - automatedAgentConfig?: - Schema$GoogleCloudDialogflowV2beta1AutomatedAgentConfig; - /** - * Required. Human readable name for this profile. Max length 1024 bytes. - */ - displayName?: string; + export interface Schema$GoogleCloudDialogflowV2beta1ConversationEvent { /** - * Optional. Configuration for agent assistance to use with this profile. + * Required. The unique identifier of the conversation this notification + * refers to. Format: `projects/<Project + * ID>/conversations/<Conversation ID>`. */ - humanAgentAssistantConfig?: - Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistantConfig; + conversation?: string; /** - * Optional. Configuration for logging conversation lifecycle events. + * Optional. More detailed information about an error. Only set for type + * UNRECOVERABLE_ERROR_IN_PHONE_CALL. */ - loggingConfig?: Schema$GoogleCloudDialogflowV2beta1LoggingConfig; - /** - * Required for all methods except `create` (`create` populates the name - * automatically). The unique identifier of this conversation profile. - * Format: `projects/<Project - * ID>/conversationProfiles/<Conversation Profile ID>`. - */ - name?: string; + errorStatus?: Schema$GoogleRpcStatus; /** - * Optional. Configuration for publishing conversation lifecycle events. + * Required. The type of the event that this notification refers to. */ - notificationConfig?: Schema$GoogleCloudDialogflowV2beta1NotificationConfig; + type?: string; } /** * The request to detect user's intent. @@ -580,8 +460,7 @@ export namespace dialogflow_v2beta1 { */ responseId?: string; /** - * Specifies the status of the webhook request. `webhook_status` is never - * populated in webhook requests. + * Specifies the status of the webhook request. */ webhookStatus?: Schema$GoogleRpcStatus; } @@ -748,55 +627,19 @@ export namespace dialogflow_v2beta1 { agentUri?: string; } /** - * Defines FAQ responses that a human agent assistant can provide. - */ - export interface Schema$GoogleCloudDialogflowV2beta1FaqAnswersConfig { - /** - * Required. Settings for knowledge base, Format: `projects/<Project - * ID>/knowledgeBases/<Knowledge Base ID>`. - */ - knowledgeBaseName?: string; - /** - * Optional. Maximum number of results to return. If unset, defaults to 10. - */ - maxResults?: number; - } - /** - * Represents a human agent assistant that provides suggestions to help human - * agents to resolve customer issues. This defines the types of content that - * the human agent assistant can present to a human agent. - */ - export interface Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistant { - /** - * Optional. Settings for article suggestion. - */ - articleSuggestionConfig?: - Schema$GoogleCloudDialogflowV2beta1ArticleSuggestionConfig; - /** - * Optional. Settings for knowledge service. - */ - faqAnswersConfig?: Schema$GoogleCloudDialogflowV2beta1FaqAnswersConfig; - /** - * Required for all methods except `create` (`create` populates the name - * automatically). The unique identifier of human agent assistant. Format: - * `projects/<Project ID>/humanAgentAssistants/<Human Agent - * Assistant ID>`. - */ - name?: string; - } - /** - * Defines the Human Agent Assistant to connect to a conversation. + * Represents a notification sent to Cloud Pub/Sub subscribers for agent + * assistant events in a specific conversation. */ - export interface Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistantConfig { + export interface Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistantEvent { /** - * Required. ID of the agent assistant to use. Format: `projects/<Project - * ID>/humanAgentAssistants/<Human Agent Assistant ID>`. + * Required. The conversation this notification refers to. Format: + * `projects/<Project ID>/conversations/<Conversation ID>`. */ - name?: string; + conversation?: string; /** - * Optional. Pub/Sub topic on which to publish new agent assistant events. + * Required. The type of the event that this notification refers to. */ - notificationConfig?: Schema$GoogleCloudDialogflowV2beta1NotificationConfig; + type?: string; } /** * The request message for Agents.ImportAgent. @@ -820,22 +663,6 @@ export namespace dialogflow_v2beta1 { */ agentUri?: string; } - /** - * Represents the natural language speech audio to be processed. - */ - export interface Schema$GoogleCloudDialogflowV2beta1InputAudio { - /** - * Required. The natural language speech audio to be processed. A single - * request can contain up to 1 minute of speech audio data. The transcribed - * text cannot contain more than 256 bytes. - */ - audio?: string; - /** - * Required. Instructs the speech recognizer how to process the speech - * audio. - */ - config?: Schema$GoogleCloudDialogflowV2beta1InputAudioConfig; - } /** * Instructs the speech recognizer how to process the audio content. */ @@ -879,33 +706,6 @@ export namespace dialogflow_v2beta1 { */ sampleRateHertz?: number; } - /** - * Represents the natural language text to be processed. - */ - export interface Schema$GoogleCloudDialogflowV2beta1InputText { - /** - * Required. The language of this conversational query. See [Language - * Support](https://dialogflow.com/docs/languages) for a list of the - * currently supported language codes. - */ - languageCode?: string; - /** - * Required. The UTF-8 encoded natural language text to be processed. Text - * length must not exceed 256 bytes. - */ - text?: string; - } - /** - * Defines the language used in the input text. - */ - export interface Schema$GoogleCloudDialogflowV2beta1InputTextConfig { - /** - * Required. The language of this conversational query. See [Language - * Support](https://dialogflow.com/docs/languages) for a list of the - * currently supported language codes. - */ - languageCode?: string; - } /** * Represents an intent. Intents convert a number of user expressions or * patterns into an action. An action is an extraction of a user command or @@ -1630,37 +1430,6 @@ export namespace dialogflow_v2beta1 { */ nextPageToken?: string; } - /** - * The response message for ConversationProfiles.ListConversationProfiles. - */ - export interface Schema$GoogleCloudDialogflowV2beta1ListConversationProfilesResponse { - /** - * The list of project conversation profiles. There is a maximum number of - * items returned based on the page_size field in the request. - */ - conversationProfiles?: - Schema$GoogleCloudDialogflowV2beta1ConversationProfile[]; - /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. - */ - nextPageToken?: string; - } - /** - * The response message for Conversations.ListConversations. - */ - export interface Schema$GoogleCloudDialogflowV2beta1ListConversationsResponse { - /** - * The list of conversations. There will be a maximum number of items - * returned based on the page_size field in the request. - */ - conversations?: Schema$GoogleCloudDialogflowV2beta1Conversation[]; - /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. - */ - nextPageToken?: string; - } /** * Response message for Documents.ListDocuments. */ @@ -1690,22 +1459,6 @@ export namespace dialogflow_v2beta1 { */ nextPageToken?: string; } - /** - * The response message for HumanAgentAssistants.ListHumanAgentAssistants. - */ - export interface Schema$GoogleCloudDialogflowV2beta1ListHumanAgentAssistantsResponse { - /** - * The list of project agent assistants. There is a maximum number of items - * returned based on the page_size field in the request. - */ - humanAgentAssistants?: - Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistant[]; - /** - * Token to retrieve the next page of results or empty if there are no more - * results in the list. - */ - nextPageToken?: string; - } /** * The response message for Intents.ListIntents. */ @@ -1736,322 +1489,79 @@ export namespace dialogflow_v2beta1 { nextPageToken?: string; } /** - * The response message for Conversations.ListMessages. + * The response message for SessionEntityTypes.ListSessionEntityTypes. */ - export interface Schema$GoogleCloudDialogflowV2beta1ListMessagesResponse { + export interface Schema$GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse { /** - * Required. The list of messages. There will be a maximum number of items - * returned based on the page_size field in the request. + * Token to retrieve the next page of results, or empty if there are no more + * results in the list. */ - messages?: Schema$GoogleCloudDialogflowV2beta1Message[]; + nextPageToken?: string; /** - * Optional. Token to retrieve the next page of results, or empty if there - * are no more results in the list. + * The list of session entity types. There will be a maximum number of items + * returned based on the page_size field in the request. */ - nextPageToken?: string; + sessionEntityTypes?: Schema$GoogleCloudDialogflowV2beta1SessionEntityType[]; } /** - * The response message for Conversations.ListParticipants. + * Represents the contents of the original request that was passed to the + * `[Streaming]DetectIntent` call. */ - export interface Schema$GoogleCloudDialogflowV2beta1ListParticipantsResponse { + export interface Schema$GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest { /** - * Token to retrieve the next page of results or empty if there are no more - * results in the list. + * Optional. This field is set to the value of the `QueryParameters.payload` + * field passed in the request. Some integrations that query a Dialogflow + * agent may provide additional information in the payload. In particular + * for the Telephony Gateway this field has the form: <pre>{ + * "telephony": { "caller_id": + * "+18558363987" } }</pre> Note: The caller ID field + * (`caller_id`) will be redacted for Standard Edition agents and populated + * with the caller ID in [E.164 format](https://en.wikipedia.org/wiki/E.164) + * for Enterprise Edition agents. */ - nextPageToken?: string; + payload?: any; /** - * The list of participants. There is a maximum number of items returned - * based on the page_size field in the request. + * The source of this request, e.g., `google`, `facebook`, `slack`. It is + * set by Dialogflow-owned servers. + */ + source?: string; + /** + * Optional. The version of the protocol used for this request. This field + * is AoG-specific. */ - participants?: Schema$GoogleCloudDialogflowV2beta1Participant[]; + version?: string; } /** - * The response message for PhoneNumberOrders.ListPhoneNumberOrders. + * Instructs the speech synthesizer how to generate the output audio content. */ - export interface Schema$GoogleCloudDialogflowV2beta1ListPhoneNumberOrdersResponse { + export interface Schema$GoogleCloudDialogflowV2beta1OutputAudioConfig { /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. + * Required. Audio encoding of the synthesized audio content. */ - nextPageToken?: string; + audioEncoding?: string; + /** + * Optional. The synthesis sample rate (in hertz) for this audio. If not + * provided, then the synthesizer will use the default sample rate based on + * the audio encoding. If this is different from the voice's natural + * sample rate, then the synthesizer will honor this request by converting + * to the desired sample rate (which might result in worse audio quality). + */ + sampleRateHertz?: number; /** - * The list of orders. There is a maximum number of items returned based on - * the page_size field in the request. + * Optional. Configuration of how speech should be synthesized. */ - phoneNumberOrders?: Schema$GoogleCloudDialogflowV2beta1PhoneNumberOrder[]; + synthesizeSpeechConfig?: + Schema$GoogleCloudDialogflowV2beta1SynthesizeSpeechConfig; } /** - * The response message for PhoneNumbers.ListPhoneNumbers. + * Represents the query input. It can contain either: 1. An audio config + * which instructs the speech recognizer how to process the speech audio. + * 2. A conversational query in the form of text,. 3. An event that + * specifies which intent to trigger. */ - export interface Schema$GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse { + export interface Schema$GoogleCloudDialogflowV2beta1QueryInput { /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. - */ - nextPageToken?: string; - /** - * The list of `PhoneNumber` resources. There is a maximum number of items - * returned based on the page_size field in the request. - */ - phoneNumbers?: Schema$GoogleCloudDialogflowV2beta1PhoneNumber[]; - } - /** - * The response message for SessionEntityTypes.ListSessionEntityTypes. - */ - export interface Schema$GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse { - /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. - */ - nextPageToken?: string; - /** - * The list of session entity types. There will be a maximum number of items - * returned based on the page_size field in the request. - */ - sessionEntityTypes?: Schema$GoogleCloudDialogflowV2beta1SessionEntityType[]; - } - /** - * The response message for [Conversations.ListSuggestions] - */ - export interface Schema$GoogleCloudDialogflowV2beta1ListSuggestionsResponse { - /** - * Optional. Token to retrieve the next page of results or empty if there - * are no more results in the list. - */ - nextPageToken?: string; - /** - * Required. - */ - suggestions?: Schema$GoogleCloudDialogflowV2beta1Suggestion[]; - } - /** - * Defines logging behavior for conversation lifecycle events. - */ - export interface Schema$GoogleCloudDialogflowV2beta1LoggingConfig {} - /** - * Represents a message posted into a conversation. - */ - export interface Schema$GoogleCloudDialogflowV2beta1Message { - /** - * Required. The message content. - */ - content?: string; - /** - * Optional. The time when the message was sent. - */ - createTime?: string; - /** - * Required. The message language. This should be a - * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. - * Example: "en-US". - */ - languageCode?: string; - /** - * Required. The unique identifier of the message. Format: - * `projects/<Project ID>/conversations/<Conversation - * ID>/messages/<Message ID>`. - */ - name?: string; - /** - * Required. The participant that said this message. - */ - participant?: string; - /** - * Optional. The role of the participant. - */ - participantRole?: string; - } - /** - * Defines notification behavior for conversation lifecycle events. - */ - export interface Schema$GoogleCloudDialogflowV2beta1NotificationConfig { - /** - * Optional. Name of the Cloud Pub/Sub topic to publish conversation events - * like CONVERSATION_STARTED as serialized ConversationEvent protos. If - * enable_notifications is `true` and no topic is supplied, a new topic is - * created and listed here. Notification works for phone calls, if this - * topic either is in the same project as the conversation or you grant - * `service-<Conversation Project - * Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` the `Dialogflow - * Service Agent` role in the topic project. Format: `projects/<Project - * ID>/topics/<Topic ID>`. - */ - topic?: string; - } - /** - * Represents the contents of the original request that was passed to the - * `[Streaming]DetectIntent` call. - */ - export interface Schema$GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest { - /** - * Optional. This field is set to the value of the `QueryParameters.payload` - * field passed in the request. Some integrations that query a Dialogflow - * agent may provide additional information in the payload. In particular - * for the Telephony Gateway this field has the form: <pre>{ - * "telephony": { "caller_id": - * "+18558363987" } }</pre> Note: The caller ID field - * (`caller_id`) will be redacted for Standard Edition agents and populated - * with the caller ID in [E.164 format](https://en.wikipedia.org/wiki/E.164) - * for Enterprise Edition agents. - */ - payload?: any; - /** - * The source of this request, e.g., `google`, `facebook`, `slack`. It is - * set by Dialogflow-owned servers. - */ - source?: string; - /** - * Optional. The version of the protocol used for this request. This field - * is AoG-specific. - */ - version?: string; - } - /** - * Represents the natural language speech audio to be played to the end user. - */ - export interface Schema$GoogleCloudDialogflowV2beta1OutputAudio { - /** - * Required. The natural language speech audio. - */ - audio?: string; - /** - * Required. Instructs the speech synthesizer how to generate the speech - * audio. - */ - config?: Schema$GoogleCloudDialogflowV2beta1OutputAudioConfig; - } - /** - * Instructs the speech synthesizer how to generate the output audio content. - */ - export interface Schema$GoogleCloudDialogflowV2beta1OutputAudioConfig { - /** - * Required. Audio encoding of the synthesized audio content. - */ - audioEncoding?: string; - /** - * Optional. The synthesis sample rate (in hertz) for this audio. If not - * provided, then the synthesizer will use the default sample rate based on - * the audio encoding. If this is different from the voice's natural - * sample rate, then the synthesizer will honor this request by converting - * to the desired sample rate (which might result in worse audio quality). - */ - sampleRateHertz?: number; - /** - * Optional. Configuration of how speech should be synthesized. - */ - synthesizeSpeechConfig?: - Schema$GoogleCloudDialogflowV2beta1SynthesizeSpeechConfig; - } - /** - * Represents a single side of the conversation. - */ - export interface Schema$GoogleCloudDialogflowV2beta1Participant { - /** - * Required. The unique identifier of this participant. Format: - * `projects/<Project ID>/conversations/<Conversation - * ID>/participants/<Participant ID>`. - */ - name?: string; - /** - * Required. The role this participant plays in the conversation. - */ - role?: string; - } - /** - * Represents a phone number. `PhoneNumber` resources enable phone calls to be - * answered by Dialogflow services and are added to a project through a - * `PhoneNumberOrder`. - */ - export interface Schema$GoogleCloudDialogflowV2beta1PhoneNumber { - /** - * Optional. The conversation profile calls to this `PhoneNumber` should - * use. Format: `projects/<Project - * ID>/conversationProfiles/<ConversationProfile ID>`. - */ - conversationProfile?: string; - /** - * Output only. The state of the `PhoneNumber`. Defaults to `ACTIVE`. - * `PhoneNumber` objects set to `DELETE_REQUESTED` always decline incoming - * calls and can be removed completely within 30 days. - */ - lifecycleState?: string; - /** - * Required. The unique identifier of this phone number. Format: - * `projects/<Project ID>/phoneNumbers/<PhoneNumber ID>`. - */ - name?: string; - /** - * Output only. Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) - * format. An example of a correctly formatted phone number: +15556767888. - */ - phoneNumber?: string; - } - /** - * Represents a phone number order. Orders can assign phone numbers to - * projects. - */ - export interface Schema$GoogleCloudDialogflowV2beta1PhoneNumberOrder { - /** - * Output only. The time this order was created. - */ - createTime?: string; - /** - * Optional. A description of the order, limit is 1024 bytes. - */ - description?: string; - /** - * Output only. The current status of the order. - */ - lifecycleState?: string; - /** - * Required. The unique identifier of this order. Format: - * `projects/<Project ID>/phoneNumberOrders/<Order ID>`. - */ - name?: string; - /** - * Output only. A map of ordered numbers filled so far, keyed by their - * resource name. Key format: `projects/<Project - * ID>/phoneNumbers/<PhoneNumber ID>`. Value format: E.164 phone - * number. Output only. - */ - phoneNumbers?: any; - /** - * Order is for new numbers. - */ - phoneNumberSpec?: Schema$GoogleCloudDialogflowV2beta1PhoneNumberSpec; - /** - * Output only. The time this order was last updated. - */ - updateTime?: string; - } - /** - * Request for new numbers fitting a set of parameters. The country code for - * newly requested numbers defaults to 1 (US) until the service is available - * in other regions. - */ - export interface Schema$GoogleCloudDialogflowV2beta1PhoneNumberSpec { - /** - * Required. Total numbers requested, between 1 and 10 inclusive. - */ - count?: number; - /** - * Optional. Area codes to use. An empty list means 'any code'. Each - * value is treated as equally preferred. Each entry has a limit of 10 - * bytes. "area code" corresponds to "National Destination - * Code" described in [E.164](https://en.wikipedia.org/wiki/E.164) - * standard. - */ - preferredAreaCodes?: string[]; - } - /** - * Represents the query input. It can contain either: 1. An audio config - * which instructs the speech recognizer how to process the speech audio. - * 2. A conversational query in the form of text,. 3. An event that - * specifies which intent to trigger. - */ - export interface Schema$GoogleCloudDialogflowV2beta1QueryInput { - /** - * Instructs the speech recognizer how to process the speech audio. + * Instructs the speech recognizer how to process the speech audio. */ audioConfig?: Schema$GoogleCloudDialogflowV2beta1InputAudioConfig; /** @@ -2318,204 +1828,6 @@ export namespace dialogflow_v2beta1 { */ name?: string; } - /** - * The top-level message sent by the client to the `StreamingAnalyzeContent` - * method. Multiple request messages must be sent in the following order: 1. - * The first message must contain `participant` and `config` fields. To - * receive an audio response, the first message must also contain the - * `reply_audio_config` field. The first message must not contain `input`. 2. - * All subsequent messages must contain only input data. Specifically: - - * If the `config` in the first message was set to `audio_config`, then all - * subsequent messages must contain only `input_audio`. It is a good practice - * to split the input audio into short chunks and deliver each chunk in - * a separate message. - If the `config` in the first message was set to - * `text_config`, then the second message must contain only - * `input_text`. Moreover, the `input_text` field can be only sent once. - * After all input is delivered, the client must half-close, or abort the - * request stream. - */ - export interface Schema$GoogleCloudDialogflowV2beta1StreamingAnalyzeContentRequest { - /** - * Instructs the speech recognizer how to process the speech audio. - */ - audioConfig?: Schema$GoogleCloudDialogflowV2beta1InputAudioConfig; - /** - * The input audio content to be recognized. Must be sent if `audio_config` - * is set in the first message. The complete audio over all streaming - * messages must not exceed 1 minute. - */ - inputAudio?: string; - /** - * The UTF-8 encoded natural language text to be processed. Must be sent if - * `text_config` is set in the first message. Text length must not exceed - * 256 bytes. The `input_text` field can be only sent once. - */ - inputText?: string; - /** - * Optional. Instructs the speech synthesizer how to generate the output - * audio. - */ - replyAudioConfig?: Schema$GoogleCloudDialogflowV2beta1OutputAudioConfig; - /** - * The natural language text to be processed. - */ - textConfig?: Schema$GoogleCloudDialogflowV2beta1InputTextConfig; - } - /** - * The top-level message returned from the `StreamingAnalyzeContent` method. - * Multiple response messages can be returned in order: 1. If the input was - * set to streaming audio, the first one or more messages contain - * `recognition_result`. Each `recognition_result` represents a more complete - * transcript of what the user said. The last `recognition_result` has - * `is_final` set to `true`. 2. The next message contains `reply_text` and - * optionally `reply_audio` returned by an agent. This message may also - * contain `automated_agent_reply`. - */ - export interface Schema$GoogleCloudDialogflowV2beta1StreamingAnalyzeContentResponse { - /** - * Optional. Only set if a Dialogflow automated agent has responded. - */ - automatedAgentReply?: - Schema$GoogleCloudDialogflowV2beta1AutomatedAgentReply; - /** - * The result of speech recognition. - */ - recognitionResult?: - Schema$GoogleCloudDialogflowV2beta1StreamingRecognitionResult; - /** - * Optional. The audio data bytes encoded as specified in the request. This - * field is set if: - The `reply_audio_config` field is specified in the - * request. - The automated agent, which this output comes from, responded - * with audio. In such case, the `reply_audio.config` field contains - * settings used to synthesize the speech. - */ - replyAudio?: Schema$GoogleCloudDialogflowV2beta1OutputAudio; - /** - * Optional. The output text content. This field is set if an automated - * agent responded with a text for the user. - */ - replyText?: string; - } - /** - * Contains a speech recognition result corresponding to a portion of the - * audio that is currently being processed or an indication that this is the - * end of the single requested utterance. Example: 1. transcript: - * "tube" 2. transcript: "to be a" 3. transcript: - * "to be" 4. transcript: "to be or not to be" is_final: - * true 5. transcript: " that's" 6. transcript: " that - * is" 7. recognition_event_type: - * `RECOGNITION_EVENT_END_OF_SINGLE_UTTERANCE` 8. transcript: " that is - * the question" is_final: true Only two of the responses contain - * final results (#4 and #8 indicated by `is_final: true`). Concatenating - * these generates the full transcript: "to be or not to be that is the - * question". In each response we populate: * for - * `MESSAGE_TYPE_TRANSCRIPT`: `transcript` and possibly `is_final`. * for - * `MESSAGE_TYPE_END_OF_SINGLE_UTTERANCE`: only `event_type`. - */ - export interface Schema$GoogleCloudDialogflowV2beta1StreamingRecognitionResult { - /** - * The Speech confidence between 0.0 and 1.0 for the current portion of - * audio. A higher number indicates an estimated greater likelihood that the - * recognized words are correct. The default of 0.0 is a sentinel value - * indicating that confidence was not set. This field is typically only - * provided if `is_final` is true and you should not rely on it being - * accurate or even set. - */ - confidence?: number; - /** - * The default of 0.0 is a sentinel value indicating `confidence` was not - * set. If `false`, the `StreamingRecognitionResult` represents an interim - * result that may change. If `true`, the recognizer will not return any - * further hypotheses about this piece of the audio. May only be populated - * for `event_type` = `RECOGNITION_EVENT_TRANSCRIPT`. - */ - isFinal?: boolean; - /** - * Type of the result message. - */ - messageType?: string; - /** - * Transcript text representing the words that the user spoke. Populated if - * and only if `event_type` = `RECOGNITION_EVENT_TRANSCRIPT`. - */ - transcript?: string; - } - /** - * Represents a suggestion for a human agent. - */ - export interface Schema$GoogleCloudDialogflowV2beta1Suggestion { - /** - * Output only. Articles ordered by score in descending order. - */ - articles?: Schema$GoogleCloudDialogflowV2beta1SuggestionArticle[]; - /** - * Output only. The time the suggestion was created. - */ - createTime?: string; - /** - * Optional. Answers extracted from FAQ documents. - */ - faqAnswers?: Schema$GoogleCloudDialogflowV2beta1SuggestionFaqAnswer[]; - /** - * Output only. The name of this suggestion. Format: `projects/<Project - * ID>/conversations/<Conversation - * ID>/participants/x/suggestions/<Suggestion ID>`. - */ - name?: string; - } - /** - * Represents suggested article. - */ - export interface Schema$GoogleCloudDialogflowV2beta1SuggestionArticle { - /** - * Output only. A map that contains metadata about the answer and the - * document from which it originates. - */ - metadata?: any; - /** - * Output only. Article snippets. - */ - snippets?: string[]; - /** - * Output only. The article title. - */ - title?: string; - /** - * Output only. The article URI. - */ - uri?: string; - } - /** - * Represents suggested answer from "frequently asked questions". - */ - export interface Schema$GoogleCloudDialogflowV2beta1SuggestionFaqAnswer { - /** - * Output only. The piece of text from the `source` knowledge base document. - */ - answer?: string; - /** - * The system's confidence score that this Knowledge answer is a good - * match for this conversational query, range from 0.0 (completely - * uncertain) to 1.0 (completely certain). - */ - confidence?: number; - /** - * Output only. A map that contains metadata about the answer and the - * document from which it originates. - */ - metadata?: any; - /** - * Output only. The corresponding FAQ question. - */ - question?: string; - /** - * Output only. Indicates which Knowledge Document this answer was extracted - * from. Format: `projects/<Project - * ID>/agent/knowledgeBases/<Knowledge Base - * ID>/documents/<Document ID>`. - */ - source?: string; - } /** * Configuration of how speech should be synthesized. */ @@ -2576,11 +1888,6 @@ export namespace dialogflow_v2beta1 { * The request message for Agents.TrainAgent. */ export interface Schema$GoogleCloudDialogflowV2beta1TrainAgentRequest {} - /** - * The request message for PhoneNumbers.UndeletePhoneNumber. - */ - export interface Schema$GoogleCloudDialogflowV2beta1UndeletePhoneNumberRequest { - } /** * Description of which voice to use for speech synthesis. */ @@ -2627,7 +1934,9 @@ export namespace dialogflow_v2beta1 { /** * The unique identifier of detectIntent request session. Can be used to * identify end-user inside webhook implementation. Format: - * `projects/<Project ID>/agent/sessions/<Session ID>`. + * `projects/<Project ID>/agent/sessions/<Session ID>`, or + * `projects/<Project ID>/agent/environments/<Environment + * ID>/users/<User ID>/sessions/<Session ID>`. */ session?: string; } @@ -3477,7 +2786,9 @@ export namespace dialogflow_v2beta1 { /** * The unique identifier of detectIntent request session. Can be used to * identify end-user inside webhook implementation. Format: - * `projects/<Project ID>/agent/sessions/<Session ID>`. + * `projects/<Project ID>/agent/sessions/<Session ID>`, or + * `projects/<Project ID>/agent/environments/<Environment + * ID>/users/<User ID>/sessions/<Session ID>`. */ session?: string; } @@ -3646,28 +2957,16 @@ export namespace dialogflow_v2beta1 { export class Resource$Projects { root: Dialogflow; agent: Resource$Projects$Agent; - conversationProfiles: Resource$Projects$Conversationprofiles; - conversations: Resource$Projects$Conversations; environments: Resource$Projects$Environments; - humanAgentAssistants: Resource$Projects$Humanagentassistants; knowledgeBases: Resource$Projects$Knowledgebases; operations: Resource$Projects$Operations; - phoneNumberOrders: Resource$Projects$Phonenumberorders; - phoneNumbers: Resource$Projects$Phonenumbers; constructor(root: Dialogflow) { this.root = root; this.getRoot.bind(this); this.agent = new Resource$Projects$Agent(root); - this.conversationProfiles = - new Resource$Projects$Conversationprofiles(root); - this.conversations = new Resource$Projects$Conversations(root); this.environments = new Resource$Projects$Environments(root); - this.humanAgentAssistants = - new Resource$Projects$Humanagentassistants(root); this.knowledgeBases = new Resource$Projects$Knowledgebases(root); this.operations = new Resource$Projects$Operations(root); - this.phoneNumberOrders = new Resource$Projects$Phonenumberorders(root); - this.phoneNumbers = new Resource$Projects$Phonenumbers(root); } getRoot() { @@ -3753,7 +3052,8 @@ export namespace dialogflow_v2beta1 { } } - export interface Params$Resource$Projects$Getagent { + export interface Params$Resource$Projects$Getagent extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4133,7 +3433,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall } } - export interface Params$Resource$Projects$Agent$Export { + export interface Params$Resource$Projects$Agent$Export extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4150,7 +3451,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ requestBody?: Schema$GoogleCloudDialogflowV2beta1ExportAgentRequest; } - export interface Params$Resource$Projects$Agent$Import { + export interface Params$Resource$Projects$Agent$Import extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4167,7 +3469,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ requestBody?: Schema$GoogleCloudDialogflowV2beta1ImportAgentRequest; } - export interface Params$Resource$Projects$Agent$Restore { + export interface Params$Resource$Projects$Agent$Restore extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4184,7 +3487,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ requestBody?: Schema$GoogleCloudDialogflowV2beta1RestoreAgentRequest; } - export interface Params$Resource$Projects$Agent$Search { + export interface Params$Resource$Projects$Agent$Search extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4206,7 +3510,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ parent?: string; } - export interface Params$Resource$Projects$Agent$Train { + export interface Params$Resource$Projects$Agent$Train extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4767,7 +4072,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall } } - export interface Params$Resource$Projects$Agent$Entitytypes$Batchdelete { + export interface Params$Resource$Projects$Agent$Entitytypes$Batchdelete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4785,7 +4091,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall requestBody?: Schema$GoogleCloudDialogflowV2beta1BatchDeleteEntityTypesRequest; } - export interface Params$Resource$Projects$Agent$Entitytypes$Batchupdate { + export interface Params$Resource$Projects$Agent$Entitytypes$Batchupdate + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4803,7 +4110,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall requestBody?: Schema$GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesRequest; } - export interface Params$Resource$Projects$Agent$Entitytypes$Create { + export interface Params$Resource$Projects$Agent$Entitytypes$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4827,7 +4135,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ requestBody?: Schema$GoogleCloudDialogflowV2beta1EntityType; } - export interface Params$Resource$Projects$Agent$Entitytypes$Delete { + export interface Params$Resource$Projects$Agent$Entitytypes$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4839,7 +4148,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ name?: string; } - export interface Params$Resource$Projects$Agent$Entitytypes$Get { + export interface Params$Resource$Projects$Agent$Entitytypes$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4858,7 +4168,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ name?: string; } - export interface Params$Resource$Projects$Agent$Entitytypes$List { + export interface Params$Resource$Projects$Agent$Entitytypes$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4887,7 +4198,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ parent?: string; } - export interface Params$Resource$Projects$Agent$Entitytypes$Patch { + export interface Params$Resource$Projects$Agent$Entitytypes$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5169,7 +4481,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall } } - export interface Params$Resource$Projects$Agent$Entitytypes$Entities$Batchcreate { + export interface Params$Resource$Projects$Agent$Entitytypes$Entities$Batchcreate + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5186,7 +4499,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ requestBody?: Schema$GoogleCloudDialogflowV2beta1BatchCreateEntitiesRequest; } - export interface Params$Resource$Projects$Agent$Entitytypes$Entities$Batchdelete { + export interface Params$Resource$Projects$Agent$Entitytypes$Entities$Batchdelete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5203,7 +4517,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ requestBody?: Schema$GoogleCloudDialogflowV2beta1BatchDeleteEntitiesRequest; } - export interface Params$Resource$Projects$Agent$Entitytypes$Entities$Batchupdate { + export interface Params$Resource$Projects$Agent$Entitytypes$Entities$Batchupdate + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5437,7 +4752,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall } } - export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Deletecontexts { + export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Deletecontexts + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5452,7 +4768,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ parent?: string; } - export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Detectintent { + export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Detectintent + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5897,7 +5214,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall } } - export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Contexts$Create { + export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Contexts$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5917,7 +5235,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ requestBody?: Schema$GoogleCloudDialogflowV2beta1Context; } - export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Contexts$Delete { + export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Contexts$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5933,7 +5252,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ name?: string; } - export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Contexts$Get { + export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Contexts$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5949,7 +5269,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ name?: string; } - export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Contexts$List { + export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Contexts$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5974,7 +5295,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ parent?: string; } - export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Contexts$Patch { + export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Contexts$Patch + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6422,7 +5744,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall } } - export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Entitytypes$Create { + export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Entitytypes$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6443,7 +5766,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ requestBody?: Schema$GoogleCloudDialogflowV2beta1SessionEntityType; } - export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Entitytypes$Delete { + export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Entitytypes$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6460,7 +5784,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ name?: string; } - export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Entitytypes$Get { + export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Entitytypes$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6476,7 +5801,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ name?: string; } - export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Entitytypes$List { + export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Entitytypes$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6502,7 +5828,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ parent?: string; } - export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Entitytypes$Patch { + export interface Params$Resource$Projects$Agent$Environments$Users$Sessions$Entitytypes$Patch + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7082,7 +6409,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall } } - export interface Params$Resource$Projects$Agent$Intents$Batchdelete { + export interface Params$Resource$Projects$Agent$Intents$Batchdelete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7099,7 +6427,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ requestBody?: Schema$GoogleCloudDialogflowV2beta1BatchDeleteIntentsRequest; } - export interface Params$Resource$Projects$Agent$Intents$Batchupdate { + export interface Params$Resource$Projects$Agent$Intents$Batchupdate extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7116,7 +6445,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ requestBody?: Schema$GoogleCloudDialogflowV2beta1BatchUpdateIntentsRequest; } - export interface Params$Resource$Projects$Agent$Intents$Create { + export interface Params$Resource$Projects$Agent$Intents$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7145,7 +6475,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ requestBody?: Schema$GoogleCloudDialogflowV2beta1Intent; } - export interface Params$Resource$Projects$Agent$Intents$Delete { + export interface Params$Resource$Projects$Agent$Intents$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7158,7 +6489,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ name?: string; } - export interface Params$Resource$Projects$Agent$Intents$Get { + export interface Params$Resource$Projects$Agent$Intents$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7182,7 +6514,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ name?: string; } - export interface Params$Resource$Projects$Agent$Intents$List { + export interface Params$Resource$Projects$Agent$Intents$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7216,7 +6549,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ parent?: string; } - export interface Params$Resource$Projects$Agent$Intents$Patch { + export interface Params$Resource$Projects$Agent$Intents$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7564,7 +6898,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall } } - export interface Params$Resource$Projects$Agent$Knowledgebases$Create { + export interface Params$Resource$Projects$Agent$Knowledgebases$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7581,7 +6916,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ requestBody?: Schema$GoogleCloudDialogflowV2beta1KnowledgeBase; } - export interface Params$Resource$Projects$Agent$Knowledgebases$Delete { + export interface Params$Resource$Projects$Agent$Knowledgebases$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7598,7 +6934,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ name?: string; } - export interface Params$Resource$Projects$Agent$Knowledgebases$Get { + export interface Params$Resource$Projects$Agent$Knowledgebases$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7610,7 +6947,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ name?: string; } - export interface Params$Resource$Projects$Agent$Knowledgebases$List { + export interface Params$Resource$Projects$Agent$Knowledgebases$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7954,7 +7292,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall } } - export interface Params$Resource$Projects$Agent$Knowledgebases$Documents$Create { + export interface Params$Resource$Projects$Agent$Knowledgebases$Documents$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7971,7 +7310,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ requestBody?: Schema$GoogleCloudDialogflowV2beta1Document; } - export interface Params$Resource$Projects$Agent$Knowledgebases$Documents$Delete { + export interface Params$Resource$Projects$Agent$Knowledgebases$Documents$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7983,7 +7323,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ name?: string; } - export interface Params$Resource$Projects$Agent$Knowledgebases$Documents$Get { + export interface Params$Resource$Projects$Agent$Knowledgebases$Documents$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7995,7 +7336,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ name?: string; } - export interface Params$Resource$Projects$Agent$Knowledgebases$Documents$List { + export interface Params$Resource$Projects$Agent$Knowledgebases$Documents$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8188,7 +7530,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall } } - export interface Params$Resource$Projects$Agent$Sessions$Deletecontexts { + export interface Params$Resource$Projects$Agent$Sessions$Deletecontexts + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8203,7 +7546,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ parent?: string; } - export interface Params$Resource$Projects$Agent$Sessions$Detectintent { + export interface Params$Resource$Projects$Agent$Sessions$Detectintent extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8623,7 +7967,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall } } - export interface Params$Resource$Projects$Agent$Sessions$Contexts$Create { + export interface Params$Resource$Projects$Agent$Sessions$Contexts$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8643,7 +7988,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ requestBody?: Schema$GoogleCloudDialogflowV2beta1Context; } - export interface Params$Resource$Projects$Agent$Sessions$Contexts$Delete { + export interface Params$Resource$Projects$Agent$Sessions$Contexts$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8659,7 +8005,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ name?: string; } - export interface Params$Resource$Projects$Agent$Sessions$Contexts$Get { + export interface Params$Resource$Projects$Agent$Sessions$Contexts$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8675,7 +8022,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ name?: string; } - export interface Params$Resource$Projects$Agent$Sessions$Contexts$List { + export interface Params$Resource$Projects$Agent$Sessions$Contexts$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8700,7 +8048,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ parent?: string; } - export interface Params$Resource$Projects$Agent$Sessions$Contexts$Patch { + export interface Params$Resource$Projects$Agent$Sessions$Contexts$Patch + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9126,7 +8475,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall } } - export interface Params$Resource$Projects$Agent$Sessions$Entitytypes$Create { + export interface Params$Resource$Projects$Agent$Sessions$Entitytypes$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9147,7 +8497,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ requestBody?: Schema$GoogleCloudDialogflowV2beta1SessionEntityType; } - export interface Params$Resource$Projects$Agent$Sessions$Entitytypes$Delete { + export interface Params$Resource$Projects$Agent$Sessions$Entitytypes$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9164,7 +8515,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ name?: string; } - export interface Params$Resource$Projects$Agent$Sessions$Entitytypes$Get { + export interface Params$Resource$Projects$Agent$Sessions$Entitytypes$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9180,7 +8532,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ name?: string; } - export interface Params$Resource$Projects$Agent$Sessions$Entitytypes$List { + export interface Params$Resource$Projects$Agent$Sessions$Entitytypes$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9206,7 +8559,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ parent?: string; } - export interface Params$Resource$Projects$Agent$Sessions$Entitytypes$Patch { + export interface Params$Resource$Projects$Agent$Sessions$Entitytypes$Patch + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9237,7 +8591,144 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall - export class Resource$Projects$Conversationprofiles { + export class Resource$Projects$Environments { + root: Dialogflow; + users: Resource$Projects$Environments$Users; + constructor(root: Dialogflow) { + this.root = root; + this.getRoot.bind(this); + this.users = new Resource$Projects$Environments$Users(root); + } + + getRoot() { + return this.root; + } + } + + + export class Resource$Projects$Environments$Users { + root: Dialogflow; + conversations: Resource$Projects$Environments$Users$Conversations; + constructor(root: Dialogflow) { + this.root = root; + this.getRoot.bind(this); + this.conversations = + new Resource$Projects$Environments$Users$Conversations(root); + } + + getRoot() { + return this.root; + } + } + + + export class Resource$Projects$Environments$Users$Conversations { + root: Dialogflow; + contexts: Resource$Projects$Environments$Users$Conversations$Contexts; + constructor(root: Dialogflow) { + this.root = root; + this.getRoot.bind(this); + this.contexts = + new Resource$Projects$Environments$Users$Conversations$Contexts(root); + } + + getRoot() { + return this.root; + } + + + /** + * dialogflow.projects.environments.users.conversations.deleteContexts + * @desc Deletes all active contexts in the specified session. + * @alias + * dialogflow.projects.environments.users.conversations.deleteContexts + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The name of the session to delete all contexts from. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' 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 + */ + deleteContexts( + params?: + Params$Resource$Projects$Environments$Users$Conversations$Deletecontexts, + options?: MethodOptions): AxiosPromise; + deleteContexts( + params: + Params$Resource$Projects$Environments$Users$Conversations$Deletecontexts, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + deleteContexts( + params: + Params$Resource$Projects$Environments$Users$Conversations$Deletecontexts, + callback: BodyResponseCallback): void; + deleteContexts(callback: BodyResponseCallback): + void; + deleteContexts( + paramsOrCallback?: + Params$Resource$Projects$Environments$Users$Conversations$Deletecontexts| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Environments$Users$Conversations$Deletecontexts; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Environments$Users$Conversations$Deletecontexts; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta1/{+parent}/contexts') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Environments$Users$Conversations$Deletecontexts + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Required. The name of the session to delete all contexts from. Format: + * `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified we assume default 'draft' + * environment. If `User ID` is not specified, we assume default '-' user. + */ + parent?: string; + } + + export class Resource$Projects$Environments$Users$Conversations$Contexts { root: Dialogflow; constructor(root: Dialogflow) { this.root = root; @@ -9250,50 +8741,60 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall /** - * dialogflow.projects.conversationProfiles.create - * @desc Creates a conversation profile in the specified project. - * @alias dialogflow.projects.conversationProfiles.create + * dialogflow.projects.environments.users.conversations.contexts.create + * @desc Creates a context. If the specified context already exists, + * overrides the context. + * @alias + * dialogflow.projects.environments.users.conversations.contexts.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The project to create a conversation profile for. Format: `projects/`. - * @param {().GoogleCloudDialogflowV2beta1ConversationProfile} params.resource Request body data + * @param {string} params.parent Required. The session to create a context for. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. + * @param {().GoogleCloudDialogflowV2beta1Context} 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$Conversationprofiles$Create, + params?: + Params$Resource$Projects$Environments$Users$Conversations$Contexts$Create, options?: MethodOptions): - AxiosPromise; + AxiosPromise; create( - params: Params$Resource$Projects$Conversationprofiles$Create, - options: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ConversationProfile>, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ConversationProfile>): void; + params: + Params$Resource$Projects$Environments$Users$Conversations$Contexts$Create, + options: MethodOptions| + BodyResponseCallback, + callback: + BodyResponseCallback): + void; create( - params: Params$Resource$Projects$Conversationprofiles$Create, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ConversationProfile>): void; - create(callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ConversationProfile>): void; + params: + Params$Resource$Projects$Environments$Users$Conversations$Contexts$Create, + callback: + BodyResponseCallback): + void; create( - paramsOrCallback?: Params$Resource$Projects$Conversationprofiles$Create| - BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ConversationProfile>, - optionsOrCallback?: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ConversationProfile>, - callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ConversationProfile>): void| - AxiosPromise { + callback: + BodyResponseCallback): + void; + create( + paramsOrCallback?: + Params$Resource$Projects$Environments$Users$Conversations$Contexts$Create| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: + BodyResponseCallback): + void|AxiosPromise { let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Conversationprofiles$Create; + Params$Resource$Projects$Environments$Users$Conversations$Contexts$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Conversationprofiles$Create; + params = {} as + Params$Resource$Projects$Environments$Users$Conversations$Contexts$Create; options = {}; } @@ -9306,7 +8807,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall const parameters = { options: Object.assign( { - url: (rootUrl + '/v2beta1/{+parent}/conversationProfiles') + url: (rootUrl + '/v2beta1/{+parent}/contexts') .replace(/([^:]\/)\/+/g, '$1'), method: 'POST' }, @@ -9317,53 +8818,58 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall context: this.getRoot() }; if (callback) { - createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1ConversationProfile>( + createAPIRequest( parameters, callback); } else { - return createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1ConversationProfile>(parameters); + return createAPIRequest( + parameters); } } /** - * dialogflow.projects.conversationProfiles.delete - * @desc Deletes the specified conversation profile. - * @alias dialogflow.projects.conversationProfiles.delete + * dialogflow.projects.environments.users.conversations.contexts.delete + * @desc Deletes the specified context. + * @alias + * dialogflow.projects.environments.users.conversations.contexts.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The name of the conversation profile to delete. Format: `projects//conversationProfiles/`. + * @param {string} params.name Required. The name of the context to delete. Format: `projects//agent/sessions//contexts/` or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' 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 */ delete( - params?: Params$Resource$Projects$Conversationprofiles$Delete, + params?: + Params$Resource$Projects$Environments$Users$Conversations$Contexts$Delete, options?: MethodOptions): AxiosPromise; delete( - params: Params$Resource$Projects$Conversationprofiles$Delete, + params: + Params$Resource$Projects$Environments$Users$Conversations$Contexts$Delete, options: MethodOptions|BodyResponseCallback, callback: BodyResponseCallback): void; delete( - params: Params$Resource$Projects$Conversationprofiles$Delete, + params: + Params$Resource$Projects$Environments$Users$Conversations$Contexts$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; delete( - paramsOrCallback?: Params$Resource$Projects$Conversationprofiles$Delete| + paramsOrCallback?: + Params$Resource$Projects$Environments$Users$Conversations$Contexts$Delete| BodyResponseCallback, optionsOrCallback?: MethodOptions| BodyResponseCallback, callback?: BodyResponseCallback): void|AxiosPromise { let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Conversationprofiles$Delete; + Params$Resource$Projects$Environments$Users$Conversations$Contexts$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Conversationprofiles$Delete; + params = {} as + Params$Resource$Projects$Environments$Users$Conversations$Contexts$Delete; options = {}; } @@ -9394,45 +8900,52 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall /** - * dialogflow.projects.conversationProfiles.get - * @desc Retrieves the specified conversation profile. - * @alias dialogflow.projects.conversationProfiles.get + * dialogflow.projects.environments.users.conversations.contexts.get + * @desc Retrieves the specified context. + * @alias dialogflow.projects.environments.users.conversations.contexts.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The resource name of the conversation profile. Format: `projects//conversationProfiles/`. + * @param {string} params.name Required. The name of the context. Format: `projects//agent/sessions//contexts/` or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' 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 */ - get(params?: Params$Resource$Projects$Conversationprofiles$Get, + get(params?: + Params$Resource$Projects$Environments$Users$Conversations$Contexts$Get, options?: MethodOptions): - AxiosPromise; - get(params: Params$Resource$Projects$Conversationprofiles$Get, - options: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ConversationProfile>, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ConversationProfile>): void; - get(params: Params$Resource$Projects$Conversationprofiles$Get, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ConversationProfile>): void; - get(callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ConversationProfile>): void; - get(paramsOrCallback?: Params$Resource$Projects$Conversationprofiles$Get| - BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ConversationProfile>, - optionsOrCallback?: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ConversationProfile>, - callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ConversationProfile>): void| - AxiosPromise { + AxiosPromise; + get(params: + Params$Resource$Projects$Environments$Users$Conversations$Contexts$Get, + options: MethodOptions| + BodyResponseCallback, + callback: + BodyResponseCallback): + void; + get(params: + Params$Resource$Projects$Environments$Users$Conversations$Contexts$Get, + callback: + BodyResponseCallback): + void; + get(callback: + BodyResponseCallback): + void; + get(paramsOrCallback?: + Params$Resource$Projects$Environments$Users$Conversations$Contexts$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: + BodyResponseCallback): + void|AxiosPromise { let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Conversationprofiles$Get; + Params$Resource$Projects$Environments$Users$Conversations$Contexts$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Conversationprofiles$Get; + params = {} as + Params$Resource$Projects$Environments$Users$Conversations$Contexts$Get; options = {}; } @@ -9455,68 +8968,66 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall context: this.getRoot() }; if (callback) { - createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1ConversationProfile>( + createAPIRequest( parameters, callback); } else { - return createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1ConversationProfile>(parameters); + return createAPIRequest( + parameters); } } /** - * dialogflow.projects.conversationProfiles.list - * @desc Returns the list of all conversation profiles in the specified - * project. - * @alias dialogflow.projects.conversationProfiles.list + * dialogflow.projects.environments.users.conversations.contexts.list + * @desc Returns the list of all contexts in the specified session. + * @alias dialogflow.projects.environments.users.conversations.contexts.list * @memberOf! () * * @param {object} params Parameters for request * @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. * @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request. - * @param {string} params.parent Required. The project to list all conversation profiles from. Format: `projects/`. + * @param {string} params.parent Required. The session to list all contexts from. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' 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 */ list( - params?: Params$Resource$Projects$Conversationprofiles$List, + params?: + Params$Resource$Projects$Environments$Users$Conversations$Contexts$List, options?: MethodOptions): - AxiosPromise< - Schema$GoogleCloudDialogflowV2beta1ListConversationProfilesResponse>; + AxiosPromise; list( - params: Params$Resource$Projects$Conversationprofiles$List, + params: + Params$Resource$Projects$Environments$Users$Conversations$Contexts$List, options: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListConversationProfilesResponse>, + Schema$GoogleCloudDialogflowV2beta1ListContextsResponse>, callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListConversationProfilesResponse>): - void; + Schema$GoogleCloudDialogflowV2beta1ListContextsResponse>): void; list( - params: Params$Resource$Projects$Conversationprofiles$List, + params: + Params$Resource$Projects$Environments$Users$Conversations$Contexts$List, callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListConversationProfilesResponse>): - void; + Schema$GoogleCloudDialogflowV2beta1ListContextsResponse>): void; list(callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListConversationProfilesResponse>): - void; + Schema$GoogleCloudDialogflowV2beta1ListContextsResponse>): void; list( - paramsOrCallback?: Params$Resource$Projects$Conversationprofiles$List| + paramsOrCallback?: + Params$Resource$Projects$Environments$Users$Conversations$Contexts$List| BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListConversationProfilesResponse>, + Schema$GoogleCloudDialogflowV2beta1ListContextsResponse>, optionsOrCallback?: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListConversationProfilesResponse>, + Schema$GoogleCloudDialogflowV2beta1ListContextsResponse>, callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListConversationProfilesResponse>): - void|AxiosPromise< - Schema$GoogleCloudDialogflowV2beta1ListConversationProfilesResponse> { + Schema$GoogleCloudDialogflowV2beta1ListContextsResponse>): void| + AxiosPromise { let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Conversationprofiles$List; + Params$Resource$Projects$Environments$Users$Conversations$Contexts$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Conversationprofiles$List; + params = {} as + Params$Resource$Projects$Environments$Users$Conversations$Contexts$List; options = {}; } @@ -9529,7 +9040,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall const parameters = { options: Object.assign( { - url: (rootUrl + '/v2beta1/{+parent}/conversationProfiles') + url: (rootUrl + '/v2beta1/{+parent}/contexts') .replace(/([^:]\/)\/+/g, '$1'), method: 'GET' }, @@ -9541,62 +9052,70 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall }; if (callback) { createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1ListConversationProfilesResponse>( + Schema$GoogleCloudDialogflowV2beta1ListContextsResponse>( parameters, callback); } else { return createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1ListConversationProfilesResponse>( + Schema$GoogleCloudDialogflowV2beta1ListContextsResponse>( parameters); } } /** - * dialogflow.projects.conversationProfiles.patch - * @desc Updates the specified conversation profile. - * @alias dialogflow.projects.conversationProfiles.patch + * dialogflow.projects.environments.users.conversations.contexts.patch + * @desc Updates the specified context. + * @alias + * dialogflow.projects.environments.users.conversations.contexts.patch * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required for all methods except `create` (`create` populates the name automatically). The unique identifier of this conversation profile. Format: `projects//conversationProfiles/`. - * @param {string=} params.updateMask Required. The mask to control which fields to update. - * @param {().GoogleCloudDialogflowV2beta1ConversationProfile} params.resource Request body data + * @param {string} params.name Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. + * @param {string=} params.updateMask Optional. The mask to control which fields get updated. + * @param {().GoogleCloudDialogflowV2beta1Context} 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 */ patch( - params?: Params$Resource$Projects$Conversationprofiles$Patch, + params?: + Params$Resource$Projects$Environments$Users$Conversations$Contexts$Patch, options?: MethodOptions): - AxiosPromise; + AxiosPromise; patch( - params: Params$Resource$Projects$Conversationprofiles$Patch, - options: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ConversationProfile>, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ConversationProfile>): void; + params: + Params$Resource$Projects$Environments$Users$Conversations$Contexts$Patch, + options: MethodOptions| + BodyResponseCallback, + callback: + BodyResponseCallback): + void; patch( - params: Params$Resource$Projects$Conversationprofiles$Patch, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ConversationProfile>): void; - patch(callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ConversationProfile>): void; + params: + Params$Resource$Projects$Environments$Users$Conversations$Contexts$Patch, + callback: + BodyResponseCallback): + void; + patch(callback: + BodyResponseCallback): + void; patch( - paramsOrCallback?: Params$Resource$Projects$Conversationprofiles$Patch| - BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ConversationProfile>, - optionsOrCallback?: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ConversationProfile>, - callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ConversationProfile>): void| - AxiosPromise { + paramsOrCallback?: + Params$Resource$Projects$Environments$Users$Conversations$Contexts$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: + BodyResponseCallback): + void|AxiosPromise { let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Conversationprofiles$Patch; + Params$Resource$Projects$Environments$Users$Conversations$Contexts$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Conversationprofiles$Patch; + params = {} as + Params$Resource$Projects$Environments$Users$Conversations$Contexts$Patch; options = {}; } @@ -9619,58 +9138,72 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall context: this.getRoot() }; if (callback) { - createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1ConversationProfile>( + createAPIRequest( parameters, callback); } else { - return createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1ConversationProfile>(parameters); + return createAPIRequest( + parameters); } } } - export interface Params$Resource$Projects$Conversationprofiles$Create { + export interface Params$Resource$Projects$Environments$Users$Conversations$Contexts$Create + extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * Required. The project to create a conversation profile for. Format: - * `projects/`. + * Required. The session to create a context for. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' + * environment. If `User ID` is not specified, we assume default '-' user. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDialogflowV2beta1ConversationProfile; + requestBody?: Schema$GoogleCloudDialogflowV2beta1Context; } - export interface Params$Resource$Projects$Conversationprofiles$Delete { + export interface Params$Resource$Projects$Environments$Users$Conversations$Contexts$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * Required. The name of the conversation profile to delete. Format: - * `projects//conversationProfiles/`. + * Required. The name of the context to delete. Format: `projects//agent/sessions//contexts/` or + * `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is + * not specified, we assume default 'draft' environment. If `User ID` is not + * specified, we assume default '-' user. */ name?: string; } - export interface Params$Resource$Projects$Conversationprofiles$Get { + export interface Params$Resource$Projects$Environments$Users$Conversations$Contexts$Get + extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * Required. The resource name of the conversation profile. Format: - * `projects//conversationProfiles/`. + * Required. The name of the context. Format: `projects//agent/sessions//contexts/` or + * `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is + * not specified, we assume default 'draft' environment. If `User ID` is not + * specified, we assume default '-' user. */ name?: string; } - export interface Params$Resource$Projects$Conversationprofiles$List { + export interface Params$Resource$Projects$Environments$Users$Conversations$Contexts$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -9687,46 +9220,51 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ pageToken?: string; /** - * Required. The project to list all conversation profiles from. Format: - * `projects/`. + * Required. The session to list all contexts from. Format: + * `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' + * environment. If `User ID` is not specified, we assume default '-' user. */ parent?: string; } - export interface Params$Resource$Projects$Conversationprofiles$Patch { + export interface Params$Resource$Projects$Environments$Users$Conversations$Contexts$Patch + extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * Required for all methods except `create` (`create` populates the name - * automatically). The unique identifier of this conversation profile. - * Format: `projects//conversationProfiles/`. + * Required. The unique identifier of the context. Format: + * `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The + * `Context ID` is always converted to lowercase. If `Environment ID` is not + * specified, we assume default 'draft' environment. If `User ID` is not + * specified, we assume default '-' user. */ name?: string; /** - * Required. The mask to control which fields to update. + * Optional. The mask to control which fields get updated. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDialogflowV2beta1ConversationProfile; + requestBody?: Schema$GoogleCloudDialogflowV2beta1Context; } - export class Resource$Projects$Conversations { + + export class Resource$Projects$Knowledgebases { root: Dialogflow; - messages: Resource$Projects$Conversations$Messages; - participants: Resource$Projects$Conversations$Participants; + documents: Resource$Projects$Knowledgebases$Documents; constructor(root: Dialogflow) { this.root = root; this.getRoot.bind(this); - this.messages = new Resource$Projects$Conversations$Messages(root); - this.participants = - new Resource$Projects$Conversations$Participants(root); + this.documents = new Resource$Projects$Knowledgebases$Documents(root); } getRoot() { @@ -9735,58 +9273,49 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall /** - * dialogflow.projects.conversations.addConversationPhoneNumber - * @desc Sets a phone number for this converstion to connect to. - * @alias dialogflow.projects.conversations.addConversationPhoneNumber + * dialogflow.projects.knowledgeBases.create + * @desc Creates a knowledge base. + * @alias dialogflow.projects.knowledgeBases.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of this conversation. Format: `projects//conversations/`. - * @param {().GoogleCloudDialogflowV2beta1AddConversationPhoneNumberRequest} params.resource Request body data + * @param {string} params.parent Required. The project to create a knowledge base for. Format: `projects/`. + * @param {().GoogleCloudDialogflowV2beta1KnowledgeBase} 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 */ - addConversationPhoneNumber( - params?: - Params$Resource$Projects$Conversations$Addconversationphonenumber, + create( + params?: Params$Resource$Projects$Knowledgebases$Create, options?: MethodOptions): - AxiosPromise< - Schema$GoogleCloudDialogflowV2beta1ConversationPhoneNumber>; - addConversationPhoneNumber( - params: - Params$Resource$Projects$Conversations$Addconversationphonenumber, - options: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ConversationPhoneNumber>, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ConversationPhoneNumber>): void; - addConversationPhoneNumber( - params: - Params$Resource$Projects$Conversations$Addconversationphonenumber, + AxiosPromise; + create( + params: Params$Resource$Projects$Knowledgebases$Create, + options: MethodOptions| + BodyResponseCallback, callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ConversationPhoneNumber>): void; - addConversationPhoneNumber( + Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void; + create( + params: Params$Resource$Projects$Knowledgebases$Create, callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ConversationPhoneNumber>): void; - addConversationPhoneNumber( - paramsOrCallback?: - Params$Resource$Projects$Conversations$Addconversationphonenumber| - BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ConversationPhoneNumber>, - optionsOrCallback?: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ConversationPhoneNumber>, + Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void; + create(callback: BodyResponseCallback< + Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void; + create( + paramsOrCallback?: Params$Resource$Projects$Knowledgebases$Create| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ConversationPhoneNumber>): - void|AxiosPromise< - Schema$GoogleCloudDialogflowV2beta1ConversationPhoneNumber> { + Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): + void|AxiosPromise { let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Conversations$Addconversationphonenumber; + Params$Resource$Projects$Knowledgebases$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Conversations$Addconversationphonenumber; + params = {} as Params$Resource$Projects$Knowledgebases$Create; options = {}; } @@ -9799,73 +9328,64 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall const parameters = { options: Object.assign( { - url: (rootUrl + '/v2beta1/{+name}:addConversationPhoneNumber') + url: (rootUrl + '/v2beta1/{+parent}/knowledgeBases') .replace(/([^:]\/)\/+/g, '$1'), method: 'POST' }, options), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.getRoot() }; if (callback) { - createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1ConversationPhoneNumber>( + createAPIRequest( parameters, callback); } else { return createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1ConversationPhoneNumber>( - parameters); + Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>(parameters); } } /** - * dialogflow.projects.conversations.complete - * @desc Completes the specified conversation. Finished conversations are - * purged from the database after 30 days. - * @alias dialogflow.projects.conversations.complete + * dialogflow.projects.knowledgeBases.delete + * @desc Deletes the specified knowledge base. + * @alias dialogflow.projects.knowledgeBases.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. Resource identifier of the conversation to close. Format: `projects//conversations/`. - * @param {().GoogleCloudDialogflowV2beta1CompleteConversationRequest} params.resource Request body data + * @param {boolean=} params.force Optional. Force deletes the knowledge base. When set to true, any documents in the knowledge base are also deleted. + * @param {string} params.name Required. The name of the knowledge base to delete. Format: `projects//knowledgeBases/`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - complete( - params?: Params$Resource$Projects$Conversations$Complete, - options?: MethodOptions): - AxiosPromise; - complete( - params: Params$Resource$Projects$Conversations$Complete, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1Conversation>): void; - complete( - params: Params$Resource$Projects$Conversations$Complete, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1Conversation>): void; - complete(callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1Conversation>): void; - complete( - paramsOrCallback?: Params$Resource$Projects$Conversations$Complete| - BodyResponseCallback, + delete( + params?: Params$Resource$Projects$Knowledgebases$Delete, + options?: MethodOptions): AxiosPromise; + delete( + params: Params$Resource$Projects$Knowledgebases$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Projects$Knowledgebases$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Projects$Knowledgebases$Delete| + BodyResponseCallback, optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1Conversation>): - void|AxiosPromise { + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Conversations$Complete; + Params$Resource$Projects$Knowledgebases$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Conversations$Complete; + params = {} as Params$Resource$Projects$Knowledgebases$Delete; options = {}; } @@ -9878,9 +9398,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall const parameters = { options: Object.assign( { - url: (rootUrl + '/v2beta1/{+name}:complete') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' + url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' }, options), params, @@ -9889,60 +9408,52 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall context: this.getRoot() }; if (callback) { - createAPIRequest( - parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1Conversation>(parameters); + return createAPIRequest(parameters); } } /** - * dialogflow.projects.conversations.create - * @desc Creates a new conversation. Conversation are auto-completed after - * 24 hours. - * @alias dialogflow.projects.conversations.create + * dialogflow.projects.knowledgeBases.get + * @desc Retrieves the specified knowledge base. + * @alias dialogflow.projects.knowledgeBases.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. Resource identifier of the project creating the conversation. Format: `projects/`. - * @param {().GoogleCloudDialogflowV2beta1Conversation} params.resource Request body data + * @param {string} params.name Required. The name of the knowledge base to retrieve. Format `projects//knowledgeBases/`. * @param {object} [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$Conversations$Create, + get(params?: Params$Resource$Projects$Knowledgebases$Get, options?: MethodOptions): - AxiosPromise; - create( - params: Params$Resource$Projects$Conversations$Create, + AxiosPromise; + get(params: Params$Resource$Projects$Knowledgebases$Get, options: MethodOptions| - BodyResponseCallback, + BodyResponseCallback, callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1Conversation>): void; - create( - params: Params$Resource$Projects$Conversations$Create, + Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void; + get(params: Params$Resource$Projects$Knowledgebases$Get, callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1Conversation>): void; - create(callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1Conversation>): void; - create( - paramsOrCallback?: Params$Resource$Projects$Conversations$Create| - BodyResponseCallback, + Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void; + get(callback: BodyResponseCallback< + Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void; + get(paramsOrCallback?: Params$Resource$Projects$Knowledgebases$Get| + BodyResponseCallback, optionsOrCallback?: MethodOptions| - BodyResponseCallback, + BodyResponseCallback, callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1Conversation>): - void|AxiosPromise { + Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): + void|AxiosPromise { let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Conversations$Create; + Params$Resource$Projects$Knowledgebases$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Conversations$Create; + params = {} as Params$Resource$Projects$Knowledgebases$Get; options = {}; } @@ -9955,147 +9466,75 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall const parameters = { options: Object.assign( { - url: (rootUrl + '/v2beta1/{+parent}/conversations') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' + url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' }, options), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.getRoot() }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback); } else { return createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1Conversation>(parameters); + Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>(parameters); } } /** - * dialogflow.projects.conversations.get - * @desc Retrieves the specific conversation. - * @alias dialogflow.projects.conversations.get + * dialogflow.projects.knowledgeBases.list + * @desc Returns the list of all knowledge bases of the specified agent. + * @alias dialogflow.projects.knowledgeBases.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The name of the conversation. Format: `projects//conversations/`. + * @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. By default 10 and at most 100. + * @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request. + * @param {string} params.parent Required. The project to list of knowledge bases for. Format: `projects/`. * @param {object} [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$Conversations$Get, + list( + params?: Params$Resource$Projects$Knowledgebases$List, options?: MethodOptions): - AxiosPromise; - get(params: Params$Resource$Projects$Conversations$Get, - options: MethodOptions| - BodyResponseCallback, + AxiosPromise< + Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse>; + list( + params: Params$Resource$Projects$Knowledgebases$List, + options: MethodOptions|BodyResponseCallback< + Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse>, callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1Conversation>): void; - get(params: Params$Resource$Projects$Conversations$Get, + Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse>): + void; + list( + params: Params$Resource$Projects$Knowledgebases$List, callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1Conversation>): void; - get(callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1Conversation>): void; - get(paramsOrCallback?: Params$Resource$Projects$Conversations$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1Conversation>): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Conversations$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Conversations$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1Conversation>(parameters); - } - } - - - /** - * dialogflow.projects.conversations.list - * @desc Returns the list of all conversations in the specified project. - * @alias dialogflow.projects.conversations.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.filter A filter expression that filters conversations listed in the response. In general, the expression must specify the field name, a comparison operator, and the value to use for filtering:
  • The value must be a string, a number, or a boolean.
  • The comparison operator must be either `=`,`!=`, `>`, or `<`.
  • To filter on multiple expressions, separate the expressions with `AND` or `OR` (omitting both implies `AND`).
  • For clarity, expressions can be enclosed in parentheses.
Only `lifecycle_state` can be filtered on in this way. For example, the following expression only returns `FINISHED` conversations: `lifecycle_state = "FINISHED"` - * @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. - * @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request. - * @param {string} params.parent Required. The project from which to list all conversation. Format: `projects/`. - * @param {object} [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$Conversations$List, - options?: MethodOptions): - AxiosPromise< - Schema$GoogleCloudDialogflowV2beta1ListConversationsResponse>; - list( - params: Params$Resource$Projects$Conversations$List, - options: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListConversationsResponse>, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListConversationsResponse>): - void; - list( - params: Params$Resource$Projects$Conversations$List, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListConversationsResponse>): + Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse>): void; list(callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListConversationsResponse>): void; + Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse>): void; list( - paramsOrCallback?: Params$Resource$Projects$Conversations$List| + paramsOrCallback?: Params$Resource$Projects$Knowledgebases$List| BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListConversationsResponse>, + Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse>, optionsOrCallback?: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListConversationsResponse>, + Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse>, callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListConversationsResponse>): + Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse>): void|AxiosPromise< - Schema$GoogleCloudDialogflowV2beta1ListConversationsResponse> { + Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse> { let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Conversations$List; + Params$Resource$Projects$Knowledgebases$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Conversations$List; + params = {} as Params$Resource$Projects$Knowledgebases$List; options = {}; } @@ -10108,7 +9547,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall const parameters = { options: Object.assign( { - url: (rootUrl + '/v2beta1/{+parent}/conversations') + url: (rootUrl + '/v2beta1/{+parent}/knowledgeBases') .replace(/([^:]\/)\/+/g, '$1'), method: 'GET' }, @@ -10120,103 +9559,75 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall }; if (callback) { createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1ListConversationsResponse>( + Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse>( parameters, callback); } else { return createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1ListConversationsResponse>( + Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse>( parameters); } } } - export interface Params$Resource$Projects$Conversations$Addconversationphonenumber { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The name of this conversation. Format: `projects//conversations/`. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: - Schema$GoogleCloudDialogflowV2beta1AddConversationPhoneNumberRequest; - } - export interface Params$Resource$Projects$Conversations$Complete { + export interface Params$Resource$Projects$Knowledgebases$Create extends + StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * Required. Resource identifier of the conversation to close. Format: - * `projects//conversations/`. + * Required. The project to create a knowledge base for. Format: + * `projects/`. */ - name?: string; + parent?: string; /** * Request body metadata */ - requestBody?: - Schema$GoogleCloudDialogflowV2beta1CompleteConversationRequest; + requestBody?: Schema$GoogleCloudDialogflowV2beta1KnowledgeBase; } - export interface Params$Resource$Projects$Conversations$Create { + export interface Params$Resource$Projects$Knowledgebases$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * Required. Resource identifier of the project creating the conversation. - * Format: `projects/`. + * Optional. Force deletes the knowledge base. When set to true, any + * documents in the knowledge base are also deleted. */ - parent?: string; - + force?: boolean; /** - * Request body metadata + * Required. The name of the knowledge base to delete. Format: + * `projects//knowledgeBases/`. */ - requestBody?: Schema$GoogleCloudDialogflowV2beta1Conversation; + name?: string; } - export interface Params$Resource$Projects$Conversations$Get { + export interface Params$Resource$Projects$Knowledgebases$Get extends + StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * Required. The name of the conversation. Format: `projects//conversations/`. + * Required. The name of the knowledge base to retrieve. Format + * `projects//knowledgeBases/`. */ name?: string; } - export interface Params$Resource$Projects$Conversations$List { + export interface Params$Resource$Projects$Knowledgebases$List extends + StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - /** - * A filter expression that filters conversations listed in the response. In - * general, the expression must specify the field name, a comparison - * operator, and the value to use for filtering:
  • The value must - * be a string, a number, or a boolean.
  • The comparison operator - * must be either `=`,`!=`, `>`, or `<`.
  • To filter on multiple - * expressions, separate the expressions with `AND` or `OR` (omitting - * both implies `AND`).
  • For clarity, expressions can be enclosed - * in parentheses.
Only `lifecycle_state` can be filtered on in - * this way. For example, the following expression only returns `FINISHED` - * conversations: `lifecycle_state = "FINISHED"` - */ - filter?: string; /** * Optional. The maximum number of items to return in a single page. By - * default 100 and at most 1000. + * default 10 and at most 100. */ pageSize?: number; /** @@ -10225,13 +9636,13 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ pageToken?: string; /** - * Required. The project from which to list all conversation. Format: + * Required. The project to list of knowledge bases for. Format: * `projects/`. */ parent?: string; } - export class Resource$Projects$Conversations$Messages { + export class Resource$Projects$Knowledgebases$Documents { root: Dialogflow; constructor(root: Dialogflow) { this.root = root; @@ -10244,51 +9655,50 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall /** - * dialogflow.projects.conversations.messages.list - * @desc Lists messages that belong to a given conversation. - * @alias dialogflow.projects.conversations.messages.list + * dialogflow.projects.knowledgeBases.documents.create + * @desc Creates a new document. Operation + * @alias dialogflow.projects.knowledgeBases.documents.create * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. - * @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request. - * @param {string} params.parent Required. The name of the conversation to list messages for. Format: `projects//conversations/` + * @param {string} params.parent Required. The knoweldge base to create a document for. Format: `projects//knowledgeBases/`. + * @param {().GoogleCloudDialogflowV2beta1Document} 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 */ - list( - params?: Params$Resource$Projects$Conversations$Messages$List, + create( + params?: Params$Resource$Projects$Knowledgebases$Documents$Create, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Projects$Conversations$Messages$List, - options: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListMessagesResponse>, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListMessagesResponse>): void; - list( - params: Params$Resource$Projects$Conversations$Messages$List, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListMessagesResponse>): void; - list(callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListMessagesResponse>): void; - list( - paramsOrCallback?: Params$Resource$Projects$Conversations$Messages$List| - BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListMessagesResponse>, - optionsOrCallback?: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListMessagesResponse>, - callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListMessagesResponse>): void| - AxiosPromise { + AxiosPromise; + create( + params: Params$Resource$Projects$Knowledgebases$Documents$Create, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + create( + params: Params$Resource$Projects$Knowledgebases$Documents$Create, + callback: BodyResponseCallback): + void; + create(callback: BodyResponseCallback): + void; + create( + paramsOrCallback?: + Params$Resource$Projects$Knowledgebases$Documents$Create| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Conversations$Messages$List; + Params$Resource$Projects$Knowledgebases$Documents$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Conversations$Messages$List; + params = {} as Params$Resource$Projects$Knowledgebases$Documents$Create; options = {}; } @@ -10301,9 +9711,9 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall const parameters = { options: Object.assign( { - url: (rootUrl + '/v2beta1/{+parent}/messages') + url: (rootUrl + '/v2beta1/{+parent}/documents') .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' + method: 'POST' }, options), params, @@ -10312,109 +9722,58 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall context: this.getRoot() }; if (callback) { - createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1ListMessagesResponse>( + createAPIRequest( parameters, callback); } else { - return createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1ListMessagesResponse>( - parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Conversations$Messages$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Optional. The maximum number of items to return in a single page. By - * default 100 and at most 1000. - */ - pageSize?: number; - /** - * Optional. The next_page_token value returned from a previous list - * request. - */ - pageToken?: string; - /** - * Required. The name of the conversation to list messages for. Format: - * `projects//conversations/` - */ - parent?: string; - } - - - export class Resource$Projects$Conversations$Participants { - root: Dialogflow; - suggestions: Resource$Projects$Conversations$Participants$Suggestions; - constructor(root: Dialogflow) { - this.root = root; - this.getRoot.bind(this); - this.suggestions = - new Resource$Projects$Conversations$Participants$Suggestions(root); - } - - getRoot() { - return this.root; - } /** - * dialogflow.projects.conversations.participants.analyzeContent - * @desc Adds a text (chat, for example), or audio (phone recording, for - * example) message from a participan into the conversation. - * @alias dialogflow.projects.conversations.participants.analyzeContent + * dialogflow.projects.knowledgeBases.documents.delete + * @desc Deletes the specified document. Operation + * @alias dialogflow.projects.knowledgeBases.documents.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.participant Required. The name of the participant this text comes from. Format: `projects//conversations//participants/`. - * @param {().GoogleCloudDialogflowV2beta1AnalyzeContentRequest} params.resource Request body data + * @param {string} params.name The name of the document to delete. Format: `projects//knowledgeBases//documents/`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - analyzeContent( - params?: - Params$Resource$Projects$Conversations$Participants$Analyzecontent, + delete( + params?: Params$Resource$Projects$Knowledgebases$Documents$Delete, options?: MethodOptions): - AxiosPromise; - analyzeContent( - params: - Params$Resource$Projects$Conversations$Participants$Analyzecontent, - options: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1AnalyzeContentResponse>, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1AnalyzeContentResponse>): void; - analyzeContent( - params: - Params$Resource$Projects$Conversations$Participants$Analyzecontent, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1AnalyzeContentResponse>): void; - analyzeContent(callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1AnalyzeContentResponse>): + AxiosPromise; + delete( + params: Params$Resource$Projects$Knowledgebases$Documents$Delete, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; - analyzeContent( + delete( + params: Params$Resource$Projects$Knowledgebases$Documents$Delete, + callback: BodyResponseCallback): + void; + delete(callback: BodyResponseCallback): + void; + delete( paramsOrCallback?: - Params$Resource$Projects$Conversations$Participants$Analyzecontent| - BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1AnalyzeContentResponse>, - optionsOrCallback?: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1AnalyzeContentResponse>, - callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1AnalyzeContentResponse>): - void|AxiosPromise< - Schema$GoogleCloudDialogflowV2beta1AnalyzeContentResponse> { + Params$Resource$Projects$Knowledgebases$Documents$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Conversations$Participants$Analyzecontent; + Params$Resource$Projects$Knowledgebases$Documents$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Conversations$Participants$Analyzecontent; + params = {} as Params$Resource$Projects$Knowledgebases$Documents$Delete; options = {}; } @@ -10427,146 +9786,67 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall const parameters = { options: Object.assign( { - url: (rootUrl + '/v2beta1/{+participant}:analyzeContent') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' + url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' }, options), params, - requiredParams: ['participant'], - pathParams: ['participant'], + requiredParams: ['name'], + pathParams: ['name'], context: this.getRoot() }; if (callback) { - createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1AnalyzeContentResponse>( + createAPIRequest( parameters, callback); } else { - return createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1AnalyzeContentResponse>( - parameters); + return createAPIRequest(parameters); } } /** - * dialogflow.projects.conversations.participants.create - * @desc Creates a new participant in a conversation. - * @alias dialogflow.projects.conversations.participants.create + * dialogflow.projects.knowledgeBases.documents.get + * @desc Retrieves the specified document. + * @alias dialogflow.projects.knowledgeBases.documents.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. Resource identifier of the conversation adding the participant. Format: `projects//conversations/`. - * @param {().GoogleCloudDialogflowV2beta1Participant} params.resource Request body data + * @param {string} params.name Required. The name of the document to retrieve. Format `projects//knowledgeBases//documents/`. * @param {object} [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$Conversations$Participants$Create, + get(params?: Params$Resource$Projects$Knowledgebases$Documents$Get, options?: MethodOptions): - AxiosPromise; - create( - params: Params$Resource$Projects$Conversations$Participants$Create, + AxiosPromise; + get(params: Params$Resource$Projects$Knowledgebases$Documents$Get, options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1Participant>): void; - create( - params: Params$Resource$Projects$Conversations$Participants$Create, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1Participant>): void; - create(callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1Participant>): void; - create( - paramsOrCallback?: - Params$Resource$Projects$Conversations$Participants$Create| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1Participant>): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Conversations$Participants$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Conversations$Participants$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+parent}/participants') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * dialogflow.projects.conversations.participants.get - * @desc Retrieves a conversation participant. - * @alias dialogflow.projects.conversations.participants.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Required. The name of the participant. Format: `projects//conversations//participants/`. - * @param {object} [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$Conversations$Participants$Get, - options?: MethodOptions): - AxiosPromise; - get(params: Params$Resource$Projects$Conversations$Participants$Get, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1Participant>): void; - get(params: Params$Resource$Projects$Conversations$Participants$Get, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1Participant>): void; - get(callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1Participant>): void; + BodyResponseCallback, + callback: + BodyResponseCallback): + void; + get(params: Params$Resource$Projects$Knowledgebases$Documents$Get, + callback: + BodyResponseCallback): + void; + get(callback: + BodyResponseCallback): + void; get(paramsOrCallback?: - Params$Resource$Projects$Conversations$Participants$Get| - BodyResponseCallback, + Params$Resource$Projects$Knowledgebases$Documents$Get| + BodyResponseCallback, optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1Participant>): - void|AxiosPromise { + BodyResponseCallback, + callback?: + BodyResponseCallback): + void|AxiosPromise { let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Conversations$Participants$Get; + Params$Resource$Projects$Knowledgebases$Documents$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Conversations$Participants$Get; + params = {} as Params$Resource$Projects$Knowledgebases$Documents$Get; options = {}; } @@ -10589,64 +9869,62 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall context: this.getRoot() }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback); } else { - return createAPIRequest( + return createAPIRequest( parameters); } } /** - * dialogflow.projects.conversations.participants.list - * @desc Returns the list of all participants in the specified conversation. - * @alias dialogflow.projects.conversations.participants.list + * dialogflow.projects.knowledgeBases.documents.list + * @desc Returns the list of all documents of the knowledge base. + * @alias dialogflow.projects.knowledgeBases.documents.list * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. + * @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. By default 10 and at most 100. * @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request. - * @param {string} params.parent Required. The conversation to list all contexts from. Format: `projects//conversations/`. + * @param {string} params.parent Required. The knowledge base to list all documents for. Format: `projects//knowledgeBases/`. * @param {object} [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$Conversations$Participants$List, + params?: Params$Resource$Projects$Knowledgebases$Documents$List, options?: MethodOptions): - AxiosPromise< - Schema$GoogleCloudDialogflowV2beta1ListParticipantsResponse>; + AxiosPromise; list( - params: Params$Resource$Projects$Conversations$Participants$List, + params: Params$Resource$Projects$Knowledgebases$Documents$List, options: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListParticipantsResponse>, + Schema$GoogleCloudDialogflowV2beta1ListDocumentsResponse>, callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListParticipantsResponse>): void; + Schema$GoogleCloudDialogflowV2beta1ListDocumentsResponse>): void; list( - params: Params$Resource$Projects$Conversations$Participants$List, + params: Params$Resource$Projects$Knowledgebases$Documents$List, callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListParticipantsResponse>): void; + Schema$GoogleCloudDialogflowV2beta1ListDocumentsResponse>): void; list(callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListParticipantsResponse>): void; + Schema$GoogleCloudDialogflowV2beta1ListDocumentsResponse>): void; list( paramsOrCallback?: - Params$Resource$Projects$Conversations$Participants$List| + Params$Resource$Projects$Knowledgebases$Documents$List| BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListParticipantsResponse>, + Schema$GoogleCloudDialogflowV2beta1ListDocumentsResponse>, optionsOrCallback?: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListParticipantsResponse>, + Schema$GoogleCloudDialogflowV2beta1ListDocumentsResponse>, callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListParticipantsResponse>): - void|AxiosPromise< - Schema$GoogleCloudDialogflowV2beta1ListParticipantsResponse> { + Schema$GoogleCloudDialogflowV2beta1ListDocumentsResponse>): void| + AxiosPromise { let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Conversations$Participants$List; + Params$Resource$Projects$Knowledgebases$Documents$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Conversations$Participants$List; + params = {} as Params$Resource$Projects$Knowledgebases$Documents$List; options = {}; } @@ -10659,7 +9937,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall const parameters = { options: Object.assign( { - url: (rootUrl + '/v2beta1/{+parent}/participants') + url: (rootUrl + '/v2beta1/{+parent}/documents') .replace(/([^:]\/)\/+/g, '$1'), method: 'GET' }, @@ -10671,164 +9949,62 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall }; if (callback) { createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1ListParticipantsResponse>( - parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1ListParticipantsResponse>( - parameters); - } - } - - - /** - * dialogflow.projects.conversations.participants.streamingAnalyzeContent - * @desc Adds a text (chat, for example), or audio (phone recording, for - * example) message from a participan into the conversation. Note: This - * method is only available through the gRPC API (not REST). The top-level - * message sent to the client by the server is - * `StreamingAnalyzeContentResponse`. Multiple response messages can be - * returned in order. The first one or more messages contain the - * `recognition_result` field. Each result represents a more complete - * transcript of what the user said. The next message contains the - * `reply_text` field and potentially the `reply_audio` field. The message - * can also contain the `automated_agent_reply` field. - * @alias - * dialogflow.projects.conversations.participants.streamingAnalyzeContent - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.participant Required. The name of the participant this text comes from. Format: `projects//conversations//participants/`. - * @param {().GoogleCloudDialogflowV2beta1StreamingAnalyzeContentRequest} 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 - */ - streamingAnalyzeContent( - params?: - Params$Resource$Projects$Conversations$Participants$Streaminganalyzecontent, - options?: MethodOptions): - AxiosPromise< - Schema$GoogleCloudDialogflowV2beta1StreamingAnalyzeContentResponse>; - streamingAnalyzeContent( - params: - Params$Resource$Projects$Conversations$Participants$Streaminganalyzecontent, - options: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1StreamingAnalyzeContentResponse>, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1StreamingAnalyzeContentResponse>): - void; - streamingAnalyzeContent( - params: - Params$Resource$Projects$Conversations$Participants$Streaminganalyzecontent, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1StreamingAnalyzeContentResponse>): - void; - streamingAnalyzeContent( - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1StreamingAnalyzeContentResponse>): - void; - streamingAnalyzeContent( - paramsOrCallback?: - Params$Resource$Projects$Conversations$Participants$Streaminganalyzecontent| - BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1StreamingAnalyzeContentResponse>, - optionsOrCallback?: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1StreamingAnalyzeContentResponse>, - callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1StreamingAnalyzeContentResponse>): - void|AxiosPromise< - Schema$GoogleCloudDialogflowV2beta1StreamingAnalyzeContentResponse> { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Conversations$Participants$Streaminganalyzecontent; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Conversations$Participants$Streaminganalyzecontent; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+participant}:streamingAnalyzeContent') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['participant'], - pathParams: ['participant'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1StreamingAnalyzeContentResponse>( + Schema$GoogleCloudDialogflowV2beta1ListDocumentsResponse>( parameters, callback); } else { return createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1StreamingAnalyzeContentResponse>( + Schema$GoogleCloudDialogflowV2beta1ListDocumentsResponse>( parameters); } } } - export interface Params$Resource$Projects$Conversations$Participants$Analyzecontent { + export interface Params$Resource$Projects$Knowledgebases$Documents$Create + extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * Required. The name of the participant this text comes from. Format: - * `projects//conversations//participants/`. + * Required. The knoweldge base to create a document for. Format: + * `projects//knowledgeBases/`. */ - participant?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDialogflowV2beta1AnalyzeContentRequest; + requestBody?: Schema$GoogleCloudDialogflowV2beta1Document; } - export interface Params$Resource$Projects$Conversations$Participants$Create { + export interface Params$Resource$Projects$Knowledgebases$Documents$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * Required. Resource identifier of the conversation adding the participant. - * Format: `projects//conversations/`. - */ - parent?: string; - - /** - * Request body metadata + * The name of the document to delete. Format: `projects//knowledgeBases//documents/`. */ - requestBody?: Schema$GoogleCloudDialogflowV2beta1Participant; + name?: string; } - export interface Params$Resource$Projects$Conversations$Participants$Get { + export interface Params$Resource$Projects$Knowledgebases$Documents$Get extends + StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * Required. The name of the participant. Format: `projects//conversations//participants/`. + * Required. The name of the document to retrieve. Format `projects//knowledgeBases//documents/`. */ name?: string; } - export interface Params$Resource$Projects$Conversations$Participants$List { + export interface Params$Resource$Projects$Knowledgebases$Documents$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -10836,7 +10012,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall /** * Optional. The maximum number of items to return in a single page. By - * default 100 and at most 1000. + * default 10 and at most 100. */ pageSize?: number; /** @@ -10845,32 +10021,15 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ pageToken?: string; /** - * Required. The conversation to list all contexts from. Format: - * `projects//conversations/`. + * Required. The knowledge base to list all documents for. Format: + * `projects//knowledgeBases/`. */ parent?: string; } - export interface Params$Resource$Projects$Conversations$Participants$Streaminganalyzecontent { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - /** - * Required. The name of the participant this text comes from. Format: - * `projects//conversations//participants/`. - */ - participant?: string; - /** - * Request body metadata - */ - requestBody?: - Schema$GoogleCloudDialogflowV2beta1StreamingAnalyzeContentRequest; - } - export class Resource$Projects$Conversations$Participants$Suggestions { + export class Resource$Projects$Operations { root: Dialogflow; constructor(root: Dialogflow) { this.root = root; @@ -10883,64 +10042,45 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall /** - * dialogflow.projects.conversations.participants.suggestions.list - * @desc Retrieves suggestions for live agents. This method should be used - * by human agent client software to fetch suggestions in real-time, while - * the conversation with an end user is in progress. The functionality is - * implemented in terms of the [list - * pagination](/apis/design/design_patterns#list_pagination) design pattern. - * The client app should use the `next_page_token` field to fetch the next - * batch of suggestions. - * @alias dialogflow.projects.conversations.participants.suggestions.list + * dialogflow.projects.operations.get + * @desc Gets the latest state of a long-running operation. Clients can use + * this method to poll the operation result at intervals as recommended by + * the API service. + * @alias dialogflow.projects.operations.get * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. The default value is 100; the maximum value is 1000. - * @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request. - * @param {string} params.parent Required. The name of the conversation participant for whom to fetch suggestions. Format: `projects//conversations//participants/`. + * @param {string} params.name The name of the operation resource. * @param {object} [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$Conversations$Participants$Suggestions$List, + get(params?: Params$Resource$Projects$Operations$Get, options?: MethodOptions): - AxiosPromise< - Schema$GoogleCloudDialogflowV2beta1ListSuggestionsResponse>; - list( - params: - Params$Resource$Projects$Conversations$Participants$Suggestions$List, - options: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListSuggestionsResponse>, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListSuggestionsResponse>): void; - list( - params: - Params$Resource$Projects$Conversations$Participants$Suggestions$List, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListSuggestionsResponse>): void; - list(callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListSuggestionsResponse>): void; - list( - paramsOrCallback?: - Params$Resource$Projects$Conversations$Participants$Suggestions$List| - BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListSuggestionsResponse>, - optionsOrCallback?: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListSuggestionsResponse>, - callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListSuggestionsResponse>): - void|AxiosPromise< - Schema$GoogleCloudDialogflowV2beta1ListSuggestionsResponse> { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Conversations$Participants$Suggestions$List; + AxiosPromise; + get(params: Params$Resource$Projects$Operations$Get, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + get(params: Params$Resource$Projects$Operations$Get, + callback: BodyResponseCallback): + void; + get(callback: BodyResponseCallback): + void; + get(paramsOrCallback?: Params$Resource$Projects$Operations$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Projects$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Conversations$Participants$Suggestions$List; + params = {} as Params$Resource$Projects$Operations$Get; options = {}; } @@ -10953,3045 +10093,34 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall const parameters = { options: Object.assign( { - url: (rootUrl + '/v2beta1/{+parent}/suggestions') - .replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET' }, options), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.getRoot() }; if (callback) { - createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1ListSuggestionsResponse>( + createAPIRequest( parameters, callback); } else { - return createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1ListSuggestionsResponse>( - parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Conversations$Participants$Suggestions$List { + export interface Params$Resource$Projects$Operations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * Optional. The maximum number of items to return in a single page. The - * default value is 100; the maximum value is 1000. - */ - pageSize?: number; - /** - * Optional. The next_page_token value returned from a previous list - * request. - */ - pageToken?: string; - /** - * Required. The name of the conversation participant for whom to fetch - * suggestions. Format: `projects//conversations//participants/`. - */ - parent?: string; - } - - - - export class Resource$Projects$Environments { - root: Dialogflow; - users: Resource$Projects$Environments$Users; - constructor(root: Dialogflow) { - this.root = root; - this.getRoot.bind(this); - this.users = new Resource$Projects$Environments$Users(root); - } - - getRoot() { - return this.root; - } - } - - - export class Resource$Projects$Environments$Users { - root: Dialogflow; - conversations: Resource$Projects$Environments$Users$Conversations; - constructor(root: Dialogflow) { - this.root = root; - this.getRoot.bind(this); - this.conversations = - new Resource$Projects$Environments$Users$Conversations(root); - } - - getRoot() { - return this.root; - } - } - - - export class Resource$Projects$Environments$Users$Conversations { - root: Dialogflow; - contexts: Resource$Projects$Environments$Users$Conversations$Contexts; - constructor(root: Dialogflow) { - this.root = root; - this.getRoot.bind(this); - this.contexts = - new Resource$Projects$Environments$Users$Conversations$Contexts(root); - } - - getRoot() { - return this.root; - } - - - /** - * dialogflow.projects.environments.users.conversations.deleteContexts - * @desc Deletes all active contexts in the specified session. - * @alias - * dialogflow.projects.environments.users.conversations.deleteContexts - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent Required. The name of the session to delete all contexts from. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' 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 - */ - deleteContexts( - params?: - Params$Resource$Projects$Environments$Users$Conversations$Deletecontexts, - options?: MethodOptions): AxiosPromise; - deleteContexts( - params: - Params$Resource$Projects$Environments$Users$Conversations$Deletecontexts, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - deleteContexts( - params: - Params$Resource$Projects$Environments$Users$Conversations$Deletecontexts, - callback: BodyResponseCallback): void; - deleteContexts(callback: BodyResponseCallback): - void; - deleteContexts( - paramsOrCallback?: - Params$Resource$Projects$Environments$Users$Conversations$Deletecontexts| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Environments$Users$Conversations$Deletecontexts; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Environments$Users$Conversations$Deletecontexts; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+parent}/contexts') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Environments$Users$Conversations$Deletecontexts { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Required. The name of the session to delete all contexts from. Format: - * `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified we assume default 'draft' - * environment. If `User ID` is not specified, we assume default '-' user. - */ - parent?: string; - } - - export class Resource$Projects$Environments$Users$Conversations$Contexts { - root: Dialogflow; - constructor(root: Dialogflow) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dialogflow.projects.environments.users.conversations.contexts.create - * @desc Creates a context. If the specified context already exists, - * overrides the context. - * @alias - * dialogflow.projects.environments.users.conversations.contexts.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent Required. The session to create a context for. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. - * @param {().GoogleCloudDialogflowV2beta1Context} 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$Environments$Users$Conversations$Contexts$Create, - options?: MethodOptions): - AxiosPromise; - create( - params: - Params$Resource$Projects$Environments$Users$Conversations$Contexts$Create, - options: MethodOptions| - BodyResponseCallback, - callback: - BodyResponseCallback): - void; - create( - params: - Params$Resource$Projects$Environments$Users$Conversations$Contexts$Create, - callback: - BodyResponseCallback): - void; - create( - callback: - BodyResponseCallback): - void; - create( - paramsOrCallback?: - Params$Resource$Projects$Environments$Users$Conversations$Contexts$Create| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: - BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Environments$Users$Conversations$Contexts$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Environments$Users$Conversations$Contexts$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+parent}/contexts') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * dialogflow.projects.environments.users.conversations.contexts.delete - * @desc Deletes the specified context. - * @alias - * dialogflow.projects.environments.users.conversations.contexts.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Required. The name of the context to delete. Format: `projects//agent/sessions//contexts/` or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' 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 - */ - delete( - params?: - Params$Resource$Projects$Environments$Users$Conversations$Contexts$Delete, - options?: MethodOptions): AxiosPromise; - delete( - params: - Params$Resource$Projects$Environments$Users$Conversations$Contexts$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( - params: - Params$Resource$Projects$Environments$Users$Conversations$Contexts$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - Params$Resource$Projects$Environments$Users$Conversations$Contexts$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Environments$Users$Conversations$Contexts$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Environments$Users$Conversations$Contexts$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dialogflow.projects.environments.users.conversations.contexts.get - * @desc Retrieves the specified context. - * @alias dialogflow.projects.environments.users.conversations.contexts.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Required. The name of the context. Format: `projects//agent/sessions//contexts/` or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' 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 - */ - get(params?: - Params$Resource$Projects$Environments$Users$Conversations$Contexts$Get, - options?: MethodOptions): - AxiosPromise; - get(params: - Params$Resource$Projects$Environments$Users$Conversations$Contexts$Get, - options: MethodOptions| - BodyResponseCallback, - callback: - BodyResponseCallback): - void; - get(params: - Params$Resource$Projects$Environments$Users$Conversations$Contexts$Get, - callback: - BodyResponseCallback): - void; - get(callback: - BodyResponseCallback): - void; - get(paramsOrCallback?: - Params$Resource$Projects$Environments$Users$Conversations$Contexts$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: - BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Environments$Users$Conversations$Contexts$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Environments$Users$Conversations$Contexts$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * dialogflow.projects.environments.users.conversations.contexts.list - * @desc Returns the list of all contexts in the specified session. - * @alias dialogflow.projects.environments.users.conversations.contexts.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. - * @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request. - * @param {string} params.parent Required. The session to list all contexts from. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' 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 - */ - list( - params?: - Params$Resource$Projects$Environments$Users$Conversations$Contexts$List, - options?: MethodOptions): - AxiosPromise; - list( - params: - Params$Resource$Projects$Environments$Users$Conversations$Contexts$List, - options: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListContextsResponse>, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListContextsResponse>): void; - list( - params: - Params$Resource$Projects$Environments$Users$Conversations$Contexts$List, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListContextsResponse>): void; - list(callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListContextsResponse>): void; - list( - paramsOrCallback?: - Params$Resource$Projects$Environments$Users$Conversations$Contexts$List| - BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListContextsResponse>, - optionsOrCallback?: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListContextsResponse>, - callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListContextsResponse>): void| - AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Environments$Users$Conversations$Contexts$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Environments$Users$Conversations$Contexts$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+parent}/contexts') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1ListContextsResponse>( - parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1ListContextsResponse>( - parameters); - } - } - - - /** - * dialogflow.projects.environments.users.conversations.contexts.patch - * @desc Updates the specified context. - * @alias - * dialogflow.projects.environments.users.conversations.contexts.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. - * @param {string=} params.updateMask Optional. The mask to control which fields get updated. - * @param {().GoogleCloudDialogflowV2beta1Context} 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 - */ - patch( - params?: - Params$Resource$Projects$Environments$Users$Conversations$Contexts$Patch, - options?: MethodOptions): - AxiosPromise; - patch( - params: - Params$Resource$Projects$Environments$Users$Conversations$Contexts$Patch, - options: MethodOptions| - BodyResponseCallback, - callback: - BodyResponseCallback): - void; - patch( - params: - Params$Resource$Projects$Environments$Users$Conversations$Contexts$Patch, - callback: - BodyResponseCallback): - void; - patch(callback: - BodyResponseCallback): - void; - patch( - paramsOrCallback?: - Params$Resource$Projects$Environments$Users$Conversations$Contexts$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: - BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Environments$Users$Conversations$Contexts$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Environments$Users$Conversations$Contexts$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - } - - export interface Params$Resource$Projects$Environments$Users$Conversations$Contexts$Create { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Required. The session to create a context for. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' - * environment. If `User ID` is not specified, we assume default '-' user. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDialogflowV2beta1Context; - } - export interface Params$Resource$Projects$Environments$Users$Conversations$Contexts$Delete { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Required. The name of the context to delete. Format: `projects//agent/sessions//contexts/` or - * `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is - * not specified, we assume default 'draft' environment. If `User ID` is not - * specified, we assume default '-' user. - */ - name?: string; - } - export interface Params$Resource$Projects$Environments$Users$Conversations$Contexts$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Required. The name of the context. Format: `projects//agent/sessions//contexts/` or - * `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is - * not specified, we assume default 'draft' environment. If `User ID` is not - * specified, we assume default '-' user. - */ - name?: string; - } - export interface Params$Resource$Projects$Environments$Users$Conversations$Contexts$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Optional. The maximum number of items to return in a single page. By - * default 100 and at most 1000. - */ - pageSize?: number; - /** - * Optional. The next_page_token value returned from a previous list - * request. - */ - pageToken?: string; - /** - * Required. The session to list all contexts from. Format: - * `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' - * environment. If `User ID` is not specified, we assume default '-' user. - */ - parent?: string; - } - export interface Params$Resource$Projects$Environments$Users$Conversations$Contexts$Patch { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Required. The unique identifier of the context. Format: - * `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The - * `Context ID` is always converted to lowercase. If `Environment ID` is not - * specified, we assume default 'draft' environment. If `User ID` is not - * specified, we assume default '-' user. - */ - name?: string; - /** - * Optional. The mask to control which fields get updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDialogflowV2beta1Context; - } - - - - export class Resource$Projects$Humanagentassistants { - root: Dialogflow; - constructor(root: Dialogflow) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dialogflow.projects.humanAgentAssistants.compileSuggestions - * @desc Uses the specified human agent assistant to come up with - * suggestions (relevant articles and FAQs) on how to respond to a given - * conversation. - * @alias dialogflow.projects.humanAgentAssistants.compileSuggestions - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Required. The resource name of the agent assistant. Format: `projects//humanAgentAssistants/`. - * @param {().GoogleCloudDialogflowV2beta1CompileSuggestionsRequest} 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 - */ - compileSuggestions( - params?: - Params$Resource$Projects$Humanagentassistants$Compilesuggestions, - options?: MethodOptions): - AxiosPromise< - Schema$GoogleCloudDialogflowV2beta1CompileSuggestionsResponse>; - compileSuggestions( - params: - Params$Resource$Projects$Humanagentassistants$Compilesuggestions, - options: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1CompileSuggestionsResponse>, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1CompileSuggestionsResponse>): - void; - compileSuggestions( - params: - Params$Resource$Projects$Humanagentassistants$Compilesuggestions, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1CompileSuggestionsResponse>): - void; - compileSuggestions( - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1CompileSuggestionsResponse>): - void; - compileSuggestions( - paramsOrCallback?: - Params$Resource$Projects$Humanagentassistants$Compilesuggestions| - BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1CompileSuggestionsResponse>, - optionsOrCallback?: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1CompileSuggestionsResponse>, - callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1CompileSuggestionsResponse>): - void|AxiosPromise< - Schema$GoogleCloudDialogflowV2beta1CompileSuggestionsResponse> { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Humanagentassistants$Compilesuggestions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Humanagentassistants$Compilesuggestions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+name}:compileSuggestions') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1CompileSuggestionsResponse>( - parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1CompileSuggestionsResponse>( - parameters); - } - } - - - /** - * dialogflow.projects.humanAgentAssistants.create - * @desc Creates a human agent assistant. - * @alias dialogflow.projects.humanAgentAssistants.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent Required. The project to create a agent assistant for. Format: `projects/`. - * @param {().GoogleCloudDialogflowV2beta1HumanAgentAssistant} 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$Humanagentassistants$Create, - options?: MethodOptions): - AxiosPromise; - create( - params: Params$Resource$Projects$Humanagentassistants$Create, - options: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistant>, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistant>): void; - create( - params: Params$Resource$Projects$Humanagentassistants$Create, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistant>): void; - create(callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistant>): void; - create( - paramsOrCallback?: Params$Resource$Projects$Humanagentassistants$Create| - BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistant>, - optionsOrCallback?: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistant>, - callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistant>): void| - AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Humanagentassistants$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Humanagentassistants$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+parent}/humanAgentAssistants') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistant>( - parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistant>(parameters); - } - } - - - /** - * dialogflow.projects.humanAgentAssistants.delete - * @desc Deletes the specified human agent assistant. - * @alias dialogflow.projects.humanAgentAssistants.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Required. The resource name of the agent assistant. Format: `projects//humanAgentAssistants/`. - * @param {object} [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$Humanagentassistants$Delete, - options?: MethodOptions): AxiosPromise; - delete( - params: Params$Resource$Projects$Humanagentassistants$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( - params: Params$Resource$Projects$Humanagentassistants$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: Params$Resource$Projects$Humanagentassistants$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Humanagentassistants$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Humanagentassistants$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dialogflow.projects.humanAgentAssistants.get - * @desc Retrieves a human agent assistant. - * @alias dialogflow.projects.humanAgentAssistants.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Required. The resource name of the agent assistant. Format: `projects//humanAgentAssistants/`. - * @param {object} [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$Humanagentassistants$Get, - options?: MethodOptions): - AxiosPromise; - get(params: Params$Resource$Projects$Humanagentassistants$Get, - options: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistant>, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistant>): void; - get(params: Params$Resource$Projects$Humanagentassistants$Get, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistant>): void; - get(callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistant>): void; - get(paramsOrCallback?: Params$Resource$Projects$Humanagentassistants$Get| - BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistant>, - optionsOrCallback?: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistant>, - callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistant>): void| - AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Humanagentassistants$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Humanagentassistants$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistant>( - parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistant>(parameters); - } - } - - - /** - * dialogflow.projects.humanAgentAssistants.list - * @desc Returns the list of all human agent assistants. - * @alias dialogflow.projects.humanAgentAssistants.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. The default value is 100; the maximum value is 1000. - * @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request. - * @param {string} params.parent Required. The project to list all agent assistants from. Format: `projects/`. - * @param {object} [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$Humanagentassistants$List, - options?: MethodOptions): - AxiosPromise< - Schema$GoogleCloudDialogflowV2beta1ListHumanAgentAssistantsResponse>; - list( - params: Params$Resource$Projects$Humanagentassistants$List, - options: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListHumanAgentAssistantsResponse>, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListHumanAgentAssistantsResponse>): - void; - list( - params: Params$Resource$Projects$Humanagentassistants$List, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListHumanAgentAssistantsResponse>): - void; - list(callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListHumanAgentAssistantsResponse>): - void; - list( - paramsOrCallback?: Params$Resource$Projects$Humanagentassistants$List| - BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListHumanAgentAssistantsResponse>, - optionsOrCallback?: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListHumanAgentAssistantsResponse>, - callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListHumanAgentAssistantsResponse>): - void|AxiosPromise< - Schema$GoogleCloudDialogflowV2beta1ListHumanAgentAssistantsResponse> { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Humanagentassistants$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Humanagentassistants$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+parent}/humanAgentAssistants') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1ListHumanAgentAssistantsResponse>( - parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1ListHumanAgentAssistantsResponse>( - parameters); - } - } - - - /** - * dialogflow.projects.humanAgentAssistants.patch - * @desc Updates the specified human agent assistant. - * @alias dialogflow.projects.humanAgentAssistants.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Required for all methods except `create` (`create` populates the name automatically). The unique identifier of human agent assistant. Format: `projects//humanAgentAssistants/`. - * @param {string=} params.updateMask Optional. The mask to specify which fields to update. - * @param {().GoogleCloudDialogflowV2beta1HumanAgentAssistant} 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 - */ - patch( - params?: Params$Resource$Projects$Humanagentassistants$Patch, - options?: MethodOptions): - AxiosPromise; - patch( - params: Params$Resource$Projects$Humanagentassistants$Patch, - options: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistant>, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistant>): void; - patch( - params: Params$Resource$Projects$Humanagentassistants$Patch, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistant>): void; - patch(callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistant>): void; - patch( - paramsOrCallback?: Params$Resource$Projects$Humanagentassistants$Patch| - BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistant>, - optionsOrCallback?: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistant>, - callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistant>): void| - AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Humanagentassistants$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Humanagentassistants$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistant>( - parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistant>(parameters); - } - } - } - - export interface Params$Resource$Projects$Humanagentassistants$Compilesuggestions { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Required. The resource name of the agent assistant. Format: - * `projects//humanAgentAssistants/`. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDialogflowV2beta1CompileSuggestionsRequest; - } - export interface Params$Resource$Projects$Humanagentassistants$Create { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Required. The project to create a agent assistant for. Format: - * `projects/`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistant; - } - export interface Params$Resource$Projects$Humanagentassistants$Delete { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Required. The resource name of the agent assistant. Format: - * `projects//humanAgentAssistants/`. - */ - name?: string; - } - export interface Params$Resource$Projects$Humanagentassistants$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Required. The resource name of the agent assistant. Format: - * `projects//humanAgentAssistants/`. - */ - name?: string; - } - export interface Params$Resource$Projects$Humanagentassistants$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Optional. The maximum number of items to return in a single page. The - * default value is 100; the maximum value is 1000. - */ - pageSize?: number; - /** - * Optional. The next_page_token value returned from a previous list - * request. - */ - pageToken?: string; - /** - * Required. The project to list all agent assistants from. Format: - * `projects/`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Humanagentassistants$Patch { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Required for all methods except `create` (`create` populates the name - * automatically). The unique identifier of human agent assistant. Format: - * `projects//humanAgentAssistants/`. - */ - name?: string; - /** - * Optional. The mask to specify which fields to update. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDialogflowV2beta1HumanAgentAssistant; - } - - - export class Resource$Projects$Knowledgebases { - root: Dialogflow; - documents: Resource$Projects$Knowledgebases$Documents; - constructor(root: Dialogflow) { - this.root = root; - this.getRoot.bind(this); - this.documents = new Resource$Projects$Knowledgebases$Documents(root); - } - - getRoot() { - return this.root; - } - - - /** - * dialogflow.projects.knowledgeBases.create - * @desc Creates a knowledge base. - * @alias dialogflow.projects.knowledgeBases.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent Required. The project to create a knowledge base for. Format: `projects/`. - * @param {().GoogleCloudDialogflowV2beta1KnowledgeBase} 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$Knowledgebases$Create, - options?: MethodOptions): - AxiosPromise; - create( - params: Params$Resource$Projects$Knowledgebases$Create, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void; - create( - params: Params$Resource$Projects$Knowledgebases$Create, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void; - create(callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void; - create( - paramsOrCallback?: Params$Resource$Projects$Knowledgebases$Create| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Knowledgebases$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Knowledgebases$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+parent}/knowledgeBases') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>(parameters); - } - } - - - /** - * dialogflow.projects.knowledgeBases.delete - * @desc Deletes the specified knowledge base. - * @alias dialogflow.projects.knowledgeBases.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.force Optional. Force deletes the knowledge base. When set to true, any documents in the knowledge base are also deleted. - * @param {string} params.name Required. The name of the knowledge base to delete. Format: `projects//knowledgeBases/`. - * @param {object} [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$Knowledgebases$Delete, - options?: MethodOptions): AxiosPromise; - delete( - params: Params$Resource$Projects$Knowledgebases$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( - params: Params$Resource$Projects$Knowledgebases$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: Params$Resource$Projects$Knowledgebases$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Knowledgebases$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Knowledgebases$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dialogflow.projects.knowledgeBases.get - * @desc Retrieves the specified knowledge base. - * @alias dialogflow.projects.knowledgeBases.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Required. The name of the knowledge base to retrieve. Format `projects//knowledgeBases/`. - * @param {object} [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$Knowledgebases$Get, - options?: MethodOptions): - AxiosPromise; - get(params: Params$Resource$Projects$Knowledgebases$Get, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void; - get(params: Params$Resource$Projects$Knowledgebases$Get, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void; - get(callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void; - get(paramsOrCallback?: Params$Resource$Projects$Knowledgebases$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Knowledgebases$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Knowledgebases$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>(parameters); - } - } - - - /** - * dialogflow.projects.knowledgeBases.list - * @desc Returns the list of all knowledge bases of the specified agent. - * @alias dialogflow.projects.knowledgeBases.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. By default 10 and at most 100. - * @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request. - * @param {string} params.parent Required. The project to list of knowledge bases for. Format: `projects/`. - * @param {object} [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$Knowledgebases$List, - options?: MethodOptions): - AxiosPromise< - Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse>; - list( - params: Params$Resource$Projects$Knowledgebases$List, - options: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse>, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse>): - void; - list( - params: Params$Resource$Projects$Knowledgebases$List, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse>): - void; - list(callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse>): void; - list( - paramsOrCallback?: Params$Resource$Projects$Knowledgebases$List| - BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse>, - optionsOrCallback?: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse>, - callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse>): - void|AxiosPromise< - Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse> { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Knowledgebases$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Knowledgebases$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+parent}/knowledgeBases') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse>( - parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse>( - parameters); - } - } - } - - export interface Params$Resource$Projects$Knowledgebases$Create { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Required. The project to create a knowledge base for. Format: - * `projects/`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDialogflowV2beta1KnowledgeBase; - } - export interface Params$Resource$Projects$Knowledgebases$Delete { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Optional. Force deletes the knowledge base. When set to true, any - * documents in the knowledge base are also deleted. - */ - force?: boolean; - /** - * Required. The name of the knowledge base to delete. Format: - * `projects//knowledgeBases/`. - */ - name?: string; - } - export interface Params$Resource$Projects$Knowledgebases$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Required. The name of the knowledge base to retrieve. Format - * `projects//knowledgeBases/`. - */ - name?: string; - } - export interface Params$Resource$Projects$Knowledgebases$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Optional. The maximum number of items to return in a single page. By - * default 10 and at most 100. - */ - pageSize?: number; - /** - * Optional. The next_page_token value returned from a previous list - * request. - */ - pageToken?: string; - /** - * Required. The project to list of knowledge bases for. Format: - * `projects/`. - */ - parent?: string; - } - - export class Resource$Projects$Knowledgebases$Documents { - root: Dialogflow; - constructor(root: Dialogflow) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dialogflow.projects.knowledgeBases.documents.create - * @desc Creates a new document. Operation - * @alias dialogflow.projects.knowledgeBases.documents.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent Required. The knoweldge base to create a document for. Format: `projects//knowledgeBases/`. - * @param {().GoogleCloudDialogflowV2beta1Document} 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$Knowledgebases$Documents$Create, - options?: MethodOptions): - AxiosPromise; - create( - params: Params$Resource$Projects$Knowledgebases$Documents$Create, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - create( - params: Params$Resource$Projects$Knowledgebases$Documents$Create, - callback: BodyResponseCallback): - void; - create(callback: BodyResponseCallback): - void; - create( - paramsOrCallback?: - Params$Resource$Projects$Knowledgebases$Documents$Create| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Knowledgebases$Documents$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Knowledgebases$Documents$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+parent}/documents') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dialogflow.projects.knowledgeBases.documents.delete - * @desc Deletes the specified document. Operation - * @alias dialogflow.projects.knowledgeBases.documents.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the document to delete. Format: `projects//knowledgeBases//documents/`. - * @param {object} [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$Knowledgebases$Documents$Delete, - options?: MethodOptions): - AxiosPromise; - delete( - params: Params$Resource$Projects$Knowledgebases$Documents$Delete, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - delete( - params: Params$Resource$Projects$Knowledgebases$Documents$Delete, - callback: BodyResponseCallback): - void; - delete(callback: BodyResponseCallback): - void; - delete( - paramsOrCallback?: - Params$Resource$Projects$Knowledgebases$Documents$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Knowledgebases$Documents$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Knowledgebases$Documents$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dialogflow.projects.knowledgeBases.documents.get - * @desc Retrieves the specified document. - * @alias dialogflow.projects.knowledgeBases.documents.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Required. The name of the document to retrieve. Format `projects//knowledgeBases//documents/`. - * @param {object} [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$Knowledgebases$Documents$Get, - options?: MethodOptions): - AxiosPromise; - get(params: Params$Resource$Projects$Knowledgebases$Documents$Get, - options: MethodOptions| - BodyResponseCallback, - callback: - BodyResponseCallback): - void; - get(params: Params$Resource$Projects$Knowledgebases$Documents$Get, - callback: - BodyResponseCallback): - void; - get(callback: - BodyResponseCallback): - void; - get(paramsOrCallback?: - Params$Resource$Projects$Knowledgebases$Documents$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: - BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Knowledgebases$Documents$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Knowledgebases$Documents$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * dialogflow.projects.knowledgeBases.documents.list - * @desc Returns the list of all documents of the knowledge base. - * @alias dialogflow.projects.knowledgeBases.documents.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. By default 10 and at most 100. - * @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request. - * @param {string} params.parent Required. The knowledge base to list all documents for. Format: `projects//knowledgeBases/`. - * @param {object} [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$Knowledgebases$Documents$List, - options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Projects$Knowledgebases$Documents$List, - options: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListDocumentsResponse>, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListDocumentsResponse>): void; - list( - params: Params$Resource$Projects$Knowledgebases$Documents$List, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListDocumentsResponse>): void; - list(callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListDocumentsResponse>): void; - list( - paramsOrCallback?: - Params$Resource$Projects$Knowledgebases$Documents$List| - BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListDocumentsResponse>, - optionsOrCallback?: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListDocumentsResponse>, - callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListDocumentsResponse>): void| - AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Knowledgebases$Documents$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Knowledgebases$Documents$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+parent}/documents') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1ListDocumentsResponse>( - parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1ListDocumentsResponse>( - parameters); - } - } - } - - export interface Params$Resource$Projects$Knowledgebases$Documents$Create { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Required. The knoweldge base to create a document for. Format: - * `projects//knowledgeBases/`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDialogflowV2beta1Document; - } - export interface Params$Resource$Projects$Knowledgebases$Documents$Delete { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The name of the document to delete. Format: `projects//knowledgeBases//documents/`. - */ - name?: string; - } - export interface Params$Resource$Projects$Knowledgebases$Documents$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Required. The name of the document to retrieve. Format `projects//knowledgeBases//documents/`. - */ - name?: string; - } - export interface Params$Resource$Projects$Knowledgebases$Documents$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Optional. The maximum number of items to return in a single page. By - * default 10 and at most 100. - */ - pageSize?: number; - /** - * Optional. The next_page_token value returned from a previous list - * request. - */ - pageToken?: string; - /** - * Required. The knowledge base to list all documents for. Format: - * `projects//knowledgeBases/`. - */ - parent?: string; - } - - - - export class Resource$Projects$Operations { - root: Dialogflow; - constructor(root: Dialogflow) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dialogflow.projects.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use - * this method to poll the operation result at intervals as recommended by - * the API service. - * @alias dialogflow.projects.operations.get - * @memberOf! () - * - * @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 {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get(params?: Params$Resource$Projects$Operations$Get, - options?: MethodOptions): - AxiosPromise; - get(params: Params$Resource$Projects$Operations$Get, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - get(params: Params$Resource$Projects$Operations$Get, - callback: BodyResponseCallback): - void; - get(callback: BodyResponseCallback): - void; - get(paramsOrCallback?: Params$Resource$Projects$Operations$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Projects$Operations$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Operations$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Operations$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The name of the operation resource. - */ - name?: string; - } - - - export class Resource$Projects$Phonenumberorders { - root: Dialogflow; - constructor(root: Dialogflow) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dialogflow.projects.phoneNumberOrders.cancel - * @desc Cancels an `PhoneNumberOrder`. Returns an error if the order is in - * state IN_PROGRESS or COMPLETED. - * @alias dialogflow.projects.phoneNumberOrders.cancel - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Required. The unique identifier of the order to delete. Format: `projects//phoneNumberOrders/`. - * @param {().GoogleCloudDialogflowV2beta1CancelPhoneNumberOrderRequest} 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 - */ - cancel( - params?: Params$Resource$Projects$Phonenumberorders$Cancel, - options?: MethodOptions): AxiosPromise; - cancel( - params: Params$Resource$Projects$Phonenumberorders$Cancel, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - cancel( - params: Params$Resource$Projects$Phonenumberorders$Cancel, - callback: BodyResponseCallback): void; - cancel(callback: BodyResponseCallback): void; - cancel( - paramsOrCallback?: Params$Resource$Projects$Phonenumberorders$Cancel| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Phonenumberorders$Cancel; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Phonenumberorders$Cancel; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+name}:cancel') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dialogflow.projects.phoneNumberOrders.create - * @desc Creates an order to request phone numbers be added to a project. - * The initial `LifecycleState` of a newly created order is PENDING. - * @alias dialogflow.projects.phoneNumberOrders.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent Required. Resource identifier of the project requesting the orders. Format: `projects/`. - * @param {().GoogleCloudDialogflowV2beta1PhoneNumberOrder} 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$Phonenumberorders$Create, - options?: MethodOptions): - AxiosPromise; - create( - params: Params$Resource$Projects$Phonenumberorders$Create, - options: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumberOrder>, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumberOrder>): void; - create( - params: Params$Resource$Projects$Phonenumberorders$Create, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumberOrder>): void; - create(callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumberOrder>): void; - create( - paramsOrCallback?: Params$Resource$Projects$Phonenumberorders$Create| - BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumberOrder>, - optionsOrCallback?: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumberOrder>, - callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumberOrder>): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Phonenumberorders$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Phonenumberorders$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+parent}/phoneNumberOrders') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1PhoneNumberOrder>(parameters); - } - } - - - /** - * dialogflow.projects.phoneNumberOrders.get - * @desc Returns a specific `PhoneNumberOrder`. - * @alias dialogflow.projects.phoneNumberOrders.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Required. The unique identifier of the order to retrieve. Format: `projects//phoneNumberOrders/`. - * @param {object} [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$Phonenumberorders$Get, - options?: MethodOptions): - AxiosPromise; - get(params: Params$Resource$Projects$Phonenumberorders$Get, - options: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumberOrder>, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumberOrder>): void; - get(params: Params$Resource$Projects$Phonenumberorders$Get, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumberOrder>): void; - get(callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumberOrder>): void; - get(paramsOrCallback?: Params$Resource$Projects$Phonenumberorders$Get| - BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumberOrder>, - optionsOrCallback?: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumberOrder>, - callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumberOrder>): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Phonenumberorders$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Phonenumberorders$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1PhoneNumberOrder>(parameters); - } - } - - - /** - * dialogflow.projects.phoneNumberOrders.list - * @desc Lists of all `PhoneNumberOrder` resources in the specified project. - * @alias dialogflow.projects.phoneNumberOrders.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. The default value is 100. The maximum value is 1000. - * @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request. - * @param {string} params.parent Required. The project to list all orders from. Format: `projects/`. - * @param {object} [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$Phonenumberorders$List, - options?: MethodOptions): - AxiosPromise< - Schema$GoogleCloudDialogflowV2beta1ListPhoneNumberOrdersResponse>; - list( - params: Params$Resource$Projects$Phonenumberorders$List, - options: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListPhoneNumberOrdersResponse>, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListPhoneNumberOrdersResponse>): - void; - list( - params: Params$Resource$Projects$Phonenumberorders$List, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListPhoneNumberOrdersResponse>): - void; - list(callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListPhoneNumberOrdersResponse>): - void; - list( - paramsOrCallback?: Params$Resource$Projects$Phonenumberorders$List| - BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListPhoneNumberOrdersResponse>, - optionsOrCallback?: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListPhoneNumberOrdersResponse>, - callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListPhoneNumberOrdersResponse>): - void|AxiosPromise< - Schema$GoogleCloudDialogflowV2beta1ListPhoneNumberOrdersResponse> { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Phonenumberorders$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Phonenumberorders$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+parent}/phoneNumberOrders') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1ListPhoneNumberOrdersResponse>( - parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1ListPhoneNumberOrdersResponse>( - parameters); - } - } - - - /** - * dialogflow.projects.phoneNumberOrders.patch - * @desc Updates the specified `PhoneNumberOrder` resource. Returns an error - * if the order is in state IN_PROGRESS or COMPLETED. - * @alias dialogflow.projects.phoneNumberOrders.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Required. The unique identifier of this order. Format: `projects//phoneNumberOrders/`. - * @param {string=} params.updateMask Optional. The mask to control which fields get updated. - * @param {().GoogleCloudDialogflowV2beta1PhoneNumberOrder} 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 - */ - patch( - params?: Params$Resource$Projects$Phonenumberorders$Patch, - options?: MethodOptions): - AxiosPromise; - patch( - params: Params$Resource$Projects$Phonenumberorders$Patch, - options: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumberOrder>, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumberOrder>): void; - patch( - params: Params$Resource$Projects$Phonenumberorders$Patch, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumberOrder>): void; - patch(callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumberOrder>): void; - patch( - paramsOrCallback?: Params$Resource$Projects$Phonenumberorders$Patch| - BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumberOrder>, - optionsOrCallback?: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumberOrder>, - callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumberOrder>): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Phonenumberorders$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Phonenumberorders$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1PhoneNumberOrder>(parameters); - } - } - } - - export interface Params$Resource$Projects$Phonenumberorders$Cancel { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Required. The unique identifier of the order to delete. Format: - * `projects//phoneNumberOrders/`. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: - Schema$GoogleCloudDialogflowV2beta1CancelPhoneNumberOrderRequest; - } - export interface Params$Resource$Projects$Phonenumberorders$Create { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Required. Resource identifier of the project requesting the orders. - * Format: `projects/`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDialogflowV2beta1PhoneNumberOrder; - } - export interface Params$Resource$Projects$Phonenumberorders$Get { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Required. The unique identifier of the order to retrieve. Format: - * `projects//phoneNumberOrders/`. - */ - name?: string; - } - export interface Params$Resource$Projects$Phonenumberorders$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Optional. The maximum number of items to return in a single page. The - * default value is 100. The maximum value is 1000. - */ - pageSize?: number; - /** - * Optional. The next_page_token value returned from a previous list - * request. - */ - pageToken?: string; - /** - * Required. The project to list all orders from. Format: `projects/`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Phonenumberorders$Patch { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Required. The unique identifier of this order. Format: `projects//phoneNumberOrders/`. - */ - name?: string; - /** - * Optional. The mask to control which fields get updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDialogflowV2beta1PhoneNumberOrder; - } - - - export class Resource$Projects$Phonenumbers { - root: Dialogflow; - constructor(root: Dialogflow) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dialogflow.projects.phoneNumbers.delete - * @desc Requests deletion of a `PhoneNumber`. The `PhoneNumber` is moved - * into the DELETE_REQUESTED state immediately, and is deleted approximately - * 30 days later. This method may only be called on a `PhoneNumber` in the - * ACTIVE state. - * @alias dialogflow.projects.phoneNumbers.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Required. The unique identifier of the `PhoneNumber` to delete. Format: `projects//phoneNumbers/`. - * @param {object} [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$Phonenumbers$Delete, - options?: MethodOptions): - AxiosPromise; - delete( - params: Params$Resource$Projects$Phonenumbers$Delete, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumber>): void; - delete( - params: Params$Resource$Projects$Phonenumbers$Delete, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumber>): void; - delete(callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumber>): void; - delete( - paramsOrCallback?: Params$Resource$Projects$Phonenumbers$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumber>): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Phonenumbers$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Phonenumbers$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * dialogflow.projects.phoneNumbers.list - * @desc Returns the list of all phone numbers in the specified project. - * @alias dialogflow.projects.phoneNumbers.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. The default value is 100. The maximum value is 1000. - * @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request. - * @param {string} params.parent Required. The project to list all `PhoneNumber` resources from. Format: `projects/`. - * @param {boolean=} params.showDeleted Optional. Controls whether `PhoneNumber` resources in the DELETE_REQUESTED state should be returned. Defaults to 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 - */ - list( - params?: Params$Resource$Projects$Phonenumbers$List, - options?: MethodOptions): - AxiosPromise< - Schema$GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse>; - list( - params: Params$Resource$Projects$Phonenumbers$List, - options: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse>, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse>): void; - list( - params: Params$Resource$Projects$Phonenumbers$List, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse>): void; - list(callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse>): void; - list( - paramsOrCallback?: Params$Resource$Projects$Phonenumbers$List| - BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse>, - optionsOrCallback?: MethodOptions|BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse>, - callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse>): - void|AxiosPromise< - Schema$GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse> { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Phonenumbers$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Phonenumbers$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+parent}/phoneNumbers') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse>( - parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudDialogflowV2beta1ListPhoneNumbersResponse>( - parameters); - } - } - - - /** - * dialogflow.projects.phoneNumbers.patch - * @desc Updates the specified `PhoneNumber`. - * @alias dialogflow.projects.phoneNumbers.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Required. The unique identifier of this phone number. Format: `projects//phoneNumbers/`. - * @param {string=} params.updateMask Optional. The mask to control which fields get updated. - * @param {().GoogleCloudDialogflowV2beta1PhoneNumber} 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 - */ - patch( - params?: Params$Resource$Projects$Phonenumbers$Patch, - options?: MethodOptions): - AxiosPromise; - patch( - params: Params$Resource$Projects$Phonenumbers$Patch, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumber>): void; - patch( - params: Params$Resource$Projects$Phonenumbers$Patch, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumber>): void; - patch(callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumber>): void; - patch( - paramsOrCallback?: Params$Resource$Projects$Phonenumbers$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumber>): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Phonenumbers$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Phonenumbers$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * dialogflow.projects.phoneNumbers.undelete - * @desc Cancels the deletion request for a `PhoneNumber`. This method may - * only be called on a `PhoneNumber` in the DELETE_REQUESTED state. - * @alias dialogflow.projects.phoneNumbers.undelete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Required. The unique identifier of the `PhoneNumber` to delete. Format: `projects//phoneNumbers/`. - * @param {().GoogleCloudDialogflowV2beta1UndeletePhoneNumberRequest} 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 - */ - undelete( - params?: Params$Resource$Projects$Phonenumbers$Undelete, - options?: MethodOptions): - AxiosPromise; - undelete( - params: Params$Resource$Projects$Phonenumbers$Undelete, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumber>): void; - undelete( - params: Params$Resource$Projects$Phonenumbers$Undelete, - callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumber>): void; - undelete(callback: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumber>): void; - undelete( - paramsOrCallback?: Params$Resource$Projects$Phonenumbers$Undelete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$GoogleCloudDialogflowV2beta1PhoneNumber>): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Phonenumbers$Undelete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Phonenumbers$Undelete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+name}:undelete') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - } - - export interface Params$Resource$Projects$Phonenumbers$Delete { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Required. The unique identifier of the `PhoneNumber` to delete. Format: - * `projects//phoneNumbers/`. - */ - name?: string; - } - export interface Params$Resource$Projects$Phonenumbers$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Optional. The maximum number of items to return in a single page. The - * default value is 100. The maximum value is 1000. - */ - pageSize?: number; - /** - * Optional. The next_page_token value returned from a previous list - * request. - */ - pageToken?: string; - /** - * Required. The project to list all `PhoneNumber` resources from. Format: - * `projects/`. - */ - parent?: string; - /** - * Optional. Controls whether `PhoneNumber` resources in the - * DELETE_REQUESTED state should be returned. Defaults to false. - */ - showDeleted?: boolean; - } - export interface Params$Resource$Projects$Phonenumbers$Patch { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Required. The unique identifier of this phone number. Format: - * `projects//phoneNumbers/`. - */ - name?: string; - /** - * Optional. The mask to control which fields get updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDialogflowV2beta1PhoneNumber; - } - export interface Params$Resource$Projects$Phonenumbers$Undelete { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Required. The unique identifier of the `PhoneNumber` to delete. Format: - * `projects//phoneNumbers/`. + * The name of the operation resource. */ name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDialogflowV2beta1UndeletePhoneNumberRequest; } } diff --git a/src/apis/digitalassetlinks/v1.ts b/src/apis/digitalassetlinks/v1.ts index b7ef3076ca..7a12de5722 100644 --- a/src/apis/digitalassetlinks/v1.ts +++ b/src/apis/digitalassetlinks/v1.ts @@ -29,11 +29,62 @@ export namespace digitalassetlinks_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Digital Asset Links API * - * API for discovering relationships between online assets such as web sites - * or mobile apps. + * Discovers relationships between online assets such as websites or mobile + * apps. * * @example * const {google} = require('googleapis'); @@ -348,7 +399,7 @@ export namespace digitalassetlinks_v1 { } } - export interface Params$Resource$Assetlinks$Check { + export interface Params$Resource$Assetlinks$Check extends StandardParameters { /** * Auth client or API Key for the request */ @@ -551,7 +602,7 @@ export namespace digitalassetlinks_v1 { } } - export interface Params$Resource$Statements$List { + export interface Params$Resource$Statements$List extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/discovery/v1.ts b/src/apis/discovery/v1.ts index 69d102219b..ab5663238e 100644 --- a/src/apis/discovery/v1.ts +++ b/src/apis/discovery/v1.ts @@ -29,6 +29,40 @@ export namespace discovery_v1 { version: 'v1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * APIs Discovery Service * @@ -522,7 +556,7 @@ export namespace discovery_v1 { } } - export interface Params$Resource$Apis$Getrest { + export interface Params$Resource$Apis$Getrest extends StandardParameters { /** * Auth client or API Key for the request */ @@ -537,7 +571,7 @@ export namespace discovery_v1 { */ version?: string; } - export interface Params$Resource$Apis$List { + export interface Params$Resource$Apis$List extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/dlp/v2.ts b/src/apis/dlp/v2.ts index 0dad54e873..f4696e7347 100644 --- a/src/apis/dlp/v2.ts +++ b/src/apis/dlp/v2.ts @@ -29,6 +29,57 @@ export namespace dlp_v2 { version: 'v2'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Data Loss Prevention (DLP) API * @@ -163,6 +214,11 @@ export namespace dlp_v2 { * Options defining BigQuery table and row identifiers. */ export interface Schema$GooglePrivacyDlpV2BigQueryOptions { + /** + * References to fields excluded from scanning. This allows you to skip + * inspection of entire columns which you know have no findings. + */ + excludedFields?: Schema$GooglePrivacyDlpV2FieldId[]; /** * References to fields uniquely identifying rows within the table. Nested * fields in the format, like `person.birthdate.year`, are allowed. @@ -415,7 +471,8 @@ export namespace dlp_v2 { filesLimitPercent?: number; /** * List of file type groups to include in the scan. If empty, all files are - * scanned and available data format processors are applied. + * scanned and available data format processors are applied. In addition, + * the binary content of the selected files is always scanned as well. */ fileTypes?: string[]; sampleMethod?: string; @@ -861,7 +918,7 @@ export namespace dlp_v2 { upperBoundDays?: number; } /** - * Message for a date time object. + * Message for a date time object. e.g. 2018-01-01, 5th August. */ export interface Schema$GooglePrivacyDlpV2DateTime { /** @@ -1444,7 +1501,8 @@ export namespace dlp_v2 { * Name of the information type. Either a name of your choosing when * creating a CustomInfoType, or one of the names listed at * https://cloud.google.com/dlp/docs/infotypes-reference when specifying a - * built-in type. + * built-in type. InfoType names should conform to the pattern + * [a-zA-Z0-9_]{1,64}. */ name?: string; } @@ -1739,7 +1797,7 @@ export namespace dlp_v2 { displayName?: string; /** * A stream of errors encountered when the trigger was activated. Repeated - * errors may result in the JobTrigger automaticaly being paused. Will + * errors may result in the JobTrigger automatically being paused. Will * return the last 100 errors. Whenever the JobTrigger is modified this list * will be cleared. Output only field. */ @@ -1777,7 +1835,7 @@ export namespace dlp_v2 { /** * Optional message indicating that multiple rows might be associated to a * single individual. If the same entity_id is associated to multiple - * quasi-identifier tuples over distict rows, we consider the entire + * quasi-identifier tuples over distinct rows, we consider the entire * collection of tuples as the composite quasi-identifier. This collection * is a multiset: the order in which the different tuples appear in the * dataset is ignored, but their frequency is taken into account. Important @@ -2236,8 +2294,9 @@ export namespace dlp_v2 { * derived from the `Finding` object. If appending to an existing table, any * columns from the predefined schema that are missing will be added. No * columns in the existing table will be deleted. If unspecified, then all - * available columns will be used for a new table, and no changes will be - * made to an existing table. + * available columns will be used for a new table or an (existing) table + * with no schema, and no changes will be made to an existing table that has + * a schema. */ outputSchema?: string; /** @@ -2410,6 +2469,9 @@ export namespace dlp_v2 { * Message for infoType-dependent details parsed from quote. */ export interface Schema$GooglePrivacyDlpV2QuoteInfo { + /** + * The date time indicated by the quote. + */ dateTime?: Schema$GooglePrivacyDlpV2DateTime; } /** @@ -3296,7 +3358,7 @@ export namespace dlp_v2 { } } - export interface Params$Resource$Infotypes$List { + export interface Params$Resource$Infotypes$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3738,7 +3800,8 @@ export namespace dlp_v2 { } } - export interface Params$Resource$Organizations$Deidentifytemplates$Create { + export interface Params$Resource$Organizations$Deidentifytemplates$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3755,7 +3818,8 @@ export namespace dlp_v2 { */ requestBody?: Schema$GooglePrivacyDlpV2CreateDeidentifyTemplateRequest; } - export interface Params$Resource$Organizations$Deidentifytemplates$Delete { + export interface Params$Resource$Organizations$Deidentifytemplates$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3768,7 +3832,8 @@ export namespace dlp_v2 { */ name?: string; } - export interface Params$Resource$Organizations$Deidentifytemplates$Get { + export interface Params$Resource$Organizations$Deidentifytemplates$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3781,7 +3846,8 @@ export namespace dlp_v2 { */ name?: string; } - export interface Params$Resource$Organizations$Deidentifytemplates$List { + export interface Params$Resource$Organizations$Deidentifytemplates$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3814,7 +3880,8 @@ export namespace dlp_v2 { */ parent?: string; } - export interface Params$Resource$Organizations$Deidentifytemplates$Patch { + export interface Params$Resource$Organizations$Deidentifytemplates$Patch + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4229,7 +4296,8 @@ export namespace dlp_v2 { } } - export interface Params$Resource$Organizations$Inspecttemplates$Create { + export interface Params$Resource$Organizations$Inspecttemplates$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4246,7 +4314,8 @@ export namespace dlp_v2 { */ requestBody?: Schema$GooglePrivacyDlpV2CreateInspectTemplateRequest; } - export interface Params$Resource$Organizations$Inspecttemplates$Delete { + export interface Params$Resource$Organizations$Inspecttemplates$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4259,7 +4328,8 @@ export namespace dlp_v2 { */ name?: string; } - export interface Params$Resource$Organizations$Inspecttemplates$Get { + export interface Params$Resource$Organizations$Inspecttemplates$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4272,7 +4342,8 @@ export namespace dlp_v2 { */ name?: string; } - export interface Params$Resource$Organizations$Inspecttemplates$List { + export interface Params$Resource$Organizations$Inspecttemplates$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4305,7 +4376,8 @@ export namespace dlp_v2 { */ parent?: string; } - export interface Params$Resource$Organizations$Inspecttemplates$Patch { + export interface Params$Resource$Organizations$Inspecttemplates$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4723,7 +4795,8 @@ export namespace dlp_v2 { } } - export interface Params$Resource$Organizations$Storedinfotypes$Create { + export interface Params$Resource$Organizations$Storedinfotypes$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4740,7 +4813,8 @@ export namespace dlp_v2 { */ requestBody?: Schema$GooglePrivacyDlpV2CreateStoredInfoTypeRequest; } - export interface Params$Resource$Organizations$Storedinfotypes$Delete { + export interface Params$Resource$Organizations$Storedinfotypes$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4753,7 +4827,8 @@ export namespace dlp_v2 { */ name?: string; } - export interface Params$Resource$Organizations$Storedinfotypes$Get { + export interface Params$Resource$Organizations$Storedinfotypes$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4766,7 +4841,8 @@ export namespace dlp_v2 { */ name?: string; } - export interface Params$Resource$Organizations$Storedinfotypes$List { + export interface Params$Resource$Organizations$Storedinfotypes$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4799,7 +4875,8 @@ export namespace dlp_v2 { */ parent?: string; } - export interface Params$Resource$Organizations$Storedinfotypes$Patch { + export interface Params$Resource$Organizations$Storedinfotypes$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5104,7 +5181,8 @@ export namespace dlp_v2 { } } - export interface Params$Resource$Projects$Content$Deidentify { + export interface Params$Resource$Projects$Content$Deidentify extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5120,7 +5198,8 @@ export namespace dlp_v2 { */ requestBody?: Schema$GooglePrivacyDlpV2DeidentifyContentRequest; } - export interface Params$Resource$Projects$Content$Inspect { + export interface Params$Resource$Projects$Content$Inspect extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5136,7 +5215,8 @@ export namespace dlp_v2 { */ requestBody?: Schema$GooglePrivacyDlpV2InspectContentRequest; } - export interface Params$Resource$Projects$Content$Reidentify { + export interface Params$Resource$Projects$Content$Reidentify extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5551,7 +5631,8 @@ export namespace dlp_v2 { } } - export interface Params$Resource$Projects$Deidentifytemplates$Create { + export interface Params$Resource$Projects$Deidentifytemplates$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5568,7 +5649,8 @@ export namespace dlp_v2 { */ requestBody?: Schema$GooglePrivacyDlpV2CreateDeidentifyTemplateRequest; } - export interface Params$Resource$Projects$Deidentifytemplates$Delete { + export interface Params$Resource$Projects$Deidentifytemplates$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5581,7 +5663,8 @@ export namespace dlp_v2 { */ name?: string; } - export interface Params$Resource$Projects$Deidentifytemplates$Get { + export interface Params$Resource$Projects$Deidentifytemplates$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5594,7 +5677,8 @@ export namespace dlp_v2 { */ name?: string; } - export interface Params$Resource$Projects$Deidentifytemplates$List { + export interface Params$Resource$Projects$Deidentifytemplates$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5627,7 +5711,8 @@ export namespace dlp_v2 { */ parent?: string; } - export interface Params$Resource$Projects$Deidentifytemplates$Patch { + export interface Params$Resource$Projects$Deidentifytemplates$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6026,7 +6111,8 @@ export namespace dlp_v2 { } } - export interface Params$Resource$Projects$Dlpjobs$Cancel { + export interface Params$Resource$Projects$Dlpjobs$Cancel extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6042,7 +6128,8 @@ export namespace dlp_v2 { */ requestBody?: Schema$GooglePrivacyDlpV2CancelDlpJobRequest; } - export interface Params$Resource$Projects$Dlpjobs$Create { + export interface Params$Resource$Projects$Dlpjobs$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6058,7 +6145,8 @@ export namespace dlp_v2 { */ requestBody?: Schema$GooglePrivacyDlpV2CreateDlpJobRequest; } - export interface Params$Resource$Projects$Dlpjobs$Delete { + export interface Params$Resource$Projects$Dlpjobs$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6069,7 +6157,8 @@ export namespace dlp_v2 { */ name?: string; } - export interface Params$Resource$Projects$Dlpjobs$Get { + export interface Params$Resource$Projects$Dlpjobs$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6080,7 +6169,8 @@ export namespace dlp_v2 { */ name?: string; } - export interface Params$Resource$Projects$Dlpjobs$List { + export interface Params$Resource$Projects$Dlpjobs$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6230,7 +6320,8 @@ export namespace dlp_v2 { } } - export interface Params$Resource$Projects$Image$Redact { + export interface Params$Resource$Projects$Image$Redact extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6641,7 +6732,8 @@ export namespace dlp_v2 { } } - export interface Params$Resource$Projects$Inspecttemplates$Create { + export interface Params$Resource$Projects$Inspecttemplates$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6658,7 +6750,8 @@ export namespace dlp_v2 { */ requestBody?: Schema$GooglePrivacyDlpV2CreateInspectTemplateRequest; } - export interface Params$Resource$Projects$Inspecttemplates$Delete { + export interface Params$Resource$Projects$Inspecttemplates$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6671,7 +6764,8 @@ export namespace dlp_v2 { */ name?: string; } - export interface Params$Resource$Projects$Inspecttemplates$Get { + export interface Params$Resource$Projects$Inspecttemplates$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6684,7 +6778,8 @@ export namespace dlp_v2 { */ name?: string; } - export interface Params$Resource$Projects$Inspecttemplates$List { + export interface Params$Resource$Projects$Inspecttemplates$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6717,7 +6812,8 @@ export namespace dlp_v2 { */ parent?: string; } - export interface Params$Resource$Projects$Inspecttemplates$Patch { + export interface Params$Resource$Projects$Inspecttemplates$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7117,7 +7213,8 @@ export namespace dlp_v2 { } } - export interface Params$Resource$Projects$Jobtriggers$Create { + export interface Params$Resource$Projects$Jobtriggers$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7133,7 +7230,8 @@ export namespace dlp_v2 { */ requestBody?: Schema$GooglePrivacyDlpV2CreateJobTriggerRequest; } - export interface Params$Resource$Projects$Jobtriggers$Delete { + export interface Params$Resource$Projects$Jobtriggers$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7145,7 +7243,8 @@ export namespace dlp_v2 { */ name?: string; } - export interface Params$Resource$Projects$Jobtriggers$Get { + export interface Params$Resource$Projects$Jobtriggers$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7157,7 +7256,8 @@ export namespace dlp_v2 { */ name?: string; } - export interface Params$Resource$Projects$Jobtriggers$List { + export interface Params$Resource$Projects$Jobtriggers$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7189,7 +7289,8 @@ export namespace dlp_v2 { */ parent?: string; } - export interface Params$Resource$Projects$Jobtriggers$Patch { + export interface Params$Resource$Projects$Jobtriggers$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7606,7 +7707,8 @@ export namespace dlp_v2 { } } - export interface Params$Resource$Projects$Storedinfotypes$Create { + export interface Params$Resource$Projects$Storedinfotypes$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7623,7 +7725,8 @@ export namespace dlp_v2 { */ requestBody?: Schema$GooglePrivacyDlpV2CreateStoredInfoTypeRequest; } - export interface Params$Resource$Projects$Storedinfotypes$Delete { + export interface Params$Resource$Projects$Storedinfotypes$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7636,7 +7739,8 @@ export namespace dlp_v2 { */ name?: string; } - export interface Params$Resource$Projects$Storedinfotypes$Get { + export interface Params$Resource$Projects$Storedinfotypes$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7649,7 +7753,8 @@ export namespace dlp_v2 { */ name?: string; } - export interface Params$Resource$Projects$Storedinfotypes$List { + export interface Params$Resource$Projects$Storedinfotypes$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7682,7 +7787,8 @@ export namespace dlp_v2 { */ parent?: string; } - export interface Params$Resource$Projects$Storedinfotypes$Patch { + export interface Params$Resource$Projects$Storedinfotypes$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/dns/v1.ts b/src/apis/dns/v1.ts index 2a7cb8b7b1..a9f5ec4039 100644 --- a/src/apis/dns/v1.ts +++ b/src/apis/dns/v1.ts @@ -29,6 +29,40 @@ export namespace dns_v1 { version: 'v1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Google Cloud DNS API * @@ -1008,7 +1042,7 @@ export namespace dns_v1 { } } - export interface Params$Resource$Changes$Create { + export interface Params$Resource$Changes$Create extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1035,7 +1069,7 @@ export namespace dns_v1 { */ requestBody?: Schema$Change; } - export interface Params$Resource$Changes$Get { + export interface Params$Resource$Changes$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1062,7 +1096,7 @@ export namespace dns_v1 { */ project?: string; } - export interface Params$Resource$Changes$List { + export interface Params$Resource$Changes$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1248,7 +1282,7 @@ export namespace dns_v1 { } } - export interface Params$Resource$Dnskeys$Get { + export interface Params$Resource$Dnskeys$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1280,7 +1314,7 @@ export namespace dns_v1 { */ project?: string; } - export interface Params$Resource$Dnskeys$List { + export interface Params$Resource$Dnskeys$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1478,7 +1512,8 @@ export namespace dns_v1 { } } - export interface Params$Resource$Managedzoneoperations$Get { + export interface Params$Resource$Managedzoneoperations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1503,7 +1538,8 @@ export namespace dns_v1 { */ project?: string; } - export interface Params$Resource$Managedzoneoperations$List { + export interface Params$Resource$Managedzoneoperations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2194,7 +2230,8 @@ export namespace dns_v1 { } } - export interface Params$Resource$Managedzones$Create { + export interface Params$Resource$Managedzones$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2216,7 +2253,8 @@ export namespace dns_v1 { */ requestBody?: Schema$ManagedZone; } - export interface Params$Resource$Managedzones$Delete { + export interface Params$Resource$Managedzones$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2238,7 +2276,7 @@ export namespace dns_v1 { */ project?: string; } - export interface Params$Resource$Managedzones$Get { + export interface Params$Resource$Managedzones$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2260,7 +2298,8 @@ export namespace dns_v1 { */ project?: string; } - export interface Params$Resource$Managedzones$List { + export interface Params$Resource$Managedzones$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2285,7 +2324,8 @@ export namespace dns_v1 { */ project?: string; } - export interface Params$Resource$Managedzones$Patch { + export interface Params$Resource$Managedzones$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2312,7 +2352,8 @@ export namespace dns_v1 { */ requestBody?: Schema$ManagedZone; } - export interface Params$Resource$Managedzones$Update { + export interface Params$Resource$Managedzones$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2468,7 +2509,7 @@ export namespace dns_v1 { } } - export interface Params$Resource$Projects$Get { + export interface Params$Resource$Projects$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2651,7 +2692,8 @@ export namespace dns_v1 { } } - export interface Params$Resource$Resourcerecordsets$List { + export interface Params$Resource$Resourcerecordsets$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/dns/v1beta2.ts b/src/apis/dns/v1beta2.ts index 585a7559fa..4de61fe2db 100644 --- a/src/apis/dns/v1beta2.ts +++ b/src/apis/dns/v1beta2.ts @@ -29,6 +29,40 @@ export namespace dns_v1beta2 { version: 'v1beta2'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Google Cloud DNS API * @@ -323,6 +357,16 @@ export namespace dns_v1beta2 { * ManagedZones. Most users will leave this field unset. */ nameServerSet?: string; + /** + * For privately visible zones, the set of GCP resources that the zone is + * visible from. + */ + privateVisibilityConfig?: Schema$ManagedZonePrivateVisibilityConfig; + /** + * The zone's visibility: public zones are exposed to the Internet, + * while private zones are visible only to GCP resources. + */ + visibility?: string; } export interface Schema$ManagedZoneDnsSecConfig { /** @@ -368,6 +412,30 @@ export namespace dns_v1beta2 { */ operations?: Schema$Operation[]; } + export interface Schema$ManagedZonePrivateVisibilityConfig { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dns#managedZonePrivateVisibilityConfig". + */ + kind?: string; + /** + * The list of GCE private network IDs that can see this zone. + */ + networks?: Schema$ManagedZonePrivateVisibilityConfigNetwork[]; + } + export interface Schema$ManagedZonePrivateVisibilityConfigNetwork { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dns#managedZonePrivateVisibilityConfigNetwork". + */ + kind?: string; + /** + * The fully qualified URL of the GCE private network to bind to. This + * should be formatted like + * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + */ + networkUrl?: string; + } export interface Schema$ManagedZonesListResponse { header?: Schema$ResponseHeader; /** @@ -502,6 +570,16 @@ export namespace dns_v1beta2 { * Maximum allowed number of managed zones in the project. */ managedZones?: number; + /** + * Maximum allowed number of managed zones which can be attached to a + * network. + */ + managedZonesPerNetwork?: number; + /** + * Maximum allowed number of networks to which a privately scoped zone can + * be attached. + */ + networksPerManagedZone?: number; /** * Maximum allowed number of ResourceRecords per ResourceRecordSet. */ @@ -816,7 +894,7 @@ export namespace dns_v1beta2 { } } - export interface Params$Resource$Changes$Create { + export interface Params$Resource$Changes$Create extends StandardParameters { /** * Auth client or API Key for the request */ @@ -843,7 +921,7 @@ export namespace dns_v1beta2 { */ requestBody?: Schema$Change; } - export interface Params$Resource$Changes$Get { + export interface Params$Resource$Changes$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -870,7 +948,7 @@ export namespace dns_v1beta2 { */ project?: string; } - export interface Params$Resource$Changes$List { + export interface Params$Resource$Changes$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1056,7 +1134,7 @@ export namespace dns_v1beta2 { } } - export interface Params$Resource$Dnskeys$Get { + export interface Params$Resource$Dnskeys$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1088,7 +1166,7 @@ export namespace dns_v1beta2 { */ project?: string; } - export interface Params$Resource$Dnskeys$List { + export interface Params$Resource$Dnskeys$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1286,7 +1364,8 @@ export namespace dns_v1beta2 { } } - export interface Params$Resource$Managedzoneoperations$Get { + export interface Params$Resource$Managedzoneoperations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1311,7 +1390,8 @@ export namespace dns_v1beta2 { */ project?: string; } - export interface Params$Resource$Managedzoneoperations$List { + export interface Params$Resource$Managedzoneoperations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1771,7 +1851,8 @@ export namespace dns_v1beta2 { } } - export interface Params$Resource$Managedzones$Create { + export interface Params$Resource$Managedzones$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1793,7 +1874,8 @@ export namespace dns_v1beta2 { */ requestBody?: Schema$ManagedZone; } - export interface Params$Resource$Managedzones$Delete { + export interface Params$Resource$Managedzones$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1815,7 +1897,7 @@ export namespace dns_v1beta2 { */ project?: string; } - export interface Params$Resource$Managedzones$Get { + export interface Params$Resource$Managedzones$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1837,7 +1919,8 @@ export namespace dns_v1beta2 { */ project?: string; } - export interface Params$Resource$Managedzones$List { + export interface Params$Resource$Managedzones$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1862,7 +1945,8 @@ export namespace dns_v1beta2 { */ project?: string; } - export interface Params$Resource$Managedzones$Patch { + export interface Params$Resource$Managedzones$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1889,7 +1973,8 @@ export namespace dns_v1beta2 { */ requestBody?: Schema$ManagedZone; } - export interface Params$Resource$Managedzones$Update { + export interface Params$Resource$Managedzones$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1992,7 +2077,7 @@ export namespace dns_v1beta2 { } } - export interface Params$Resource$Projects$Get { + export interface Params$Resource$Projects$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2105,7 +2190,8 @@ export namespace dns_v1beta2 { } } - export interface Params$Resource$Resourcerecordsets$List { + export interface Params$Resource$Resourcerecordsets$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/dns/v2beta1.ts b/src/apis/dns/v2beta1.ts index 7358496978..522ad4795a 100644 --- a/src/apis/dns/v2beta1.ts +++ b/src/apis/dns/v2beta1.ts @@ -29,6 +29,40 @@ export namespace dns_v2beta1 { version: 'v2beta1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Google Cloud DNS API * @@ -1008,7 +1042,7 @@ export namespace dns_v2beta1 { } } - export interface Params$Resource$Changes$Create { + export interface Params$Resource$Changes$Create extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1035,7 +1069,7 @@ export namespace dns_v2beta1 { */ requestBody?: Schema$Change; } - export interface Params$Resource$Changes$Get { + export interface Params$Resource$Changes$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1062,7 +1096,7 @@ export namespace dns_v2beta1 { */ project?: string; } - export interface Params$Resource$Changes$List { + export interface Params$Resource$Changes$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1378,7 +1412,7 @@ export namespace dns_v2beta1 { } } - export interface Params$Resource$Dnskeys$Get { + export interface Params$Resource$Dnskeys$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1410,7 +1444,7 @@ export namespace dns_v2beta1 { */ project?: string; } - export interface Params$Resource$Dnskeys$List { + export interface Params$Resource$Dnskeys$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1737,7 +1771,8 @@ export namespace dns_v2beta1 { } } - export interface Params$Resource$Managedzoneoperations$Get { + export interface Params$Resource$Managedzoneoperations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1762,7 +1797,8 @@ export namespace dns_v2beta1 { */ project?: string; } - export interface Params$Resource$Managedzoneoperations$List { + export interface Params$Resource$Managedzoneoperations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2586,7 +2622,8 @@ export namespace dns_v2beta1 { } } - export interface Params$Resource$Managedzones$Create { + export interface Params$Resource$Managedzones$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2608,7 +2645,8 @@ export namespace dns_v2beta1 { */ requestBody?: Schema$ManagedZone; } - export interface Params$Resource$Managedzones$Delete { + export interface Params$Resource$Managedzones$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2630,7 +2668,7 @@ export namespace dns_v2beta1 { */ project?: string; } - export interface Params$Resource$Managedzones$Get { + export interface Params$Resource$Managedzones$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2652,7 +2690,8 @@ export namespace dns_v2beta1 { */ project?: string; } - export interface Params$Resource$Managedzones$List { + export interface Params$Resource$Managedzones$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2677,7 +2716,8 @@ export namespace dns_v2beta1 { */ project?: string; } - export interface Params$Resource$Managedzones$Patch { + export interface Params$Resource$Managedzones$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2704,7 +2744,8 @@ export namespace dns_v2beta1 { */ requestBody?: Schema$ManagedZone; } - export interface Params$Resource$Managedzones$Update { + export interface Params$Resource$Managedzones$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2860,7 +2901,7 @@ export namespace dns_v2beta1 { } } - export interface Params$Resource$Projects$Get { + export interface Params$Resource$Projects$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3043,7 +3084,8 @@ export namespace dns_v2beta1 { } } - export interface Params$Resource$Resourcerecordsets$List { + export interface Params$Resource$Resourcerecordsets$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/doubleclickbidmanager/v1.ts b/src/apis/doubleclickbidmanager/v1.ts index 562b27c951..3f0a008842 100644 --- a/src/apis/doubleclickbidmanager/v1.ts +++ b/src/apis/doubleclickbidmanager/v1.ts @@ -29,6 +29,40 @@ export namespace doubleclickbidmanager_v1 { version: 'v1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * DoubleClick Bid Manager API * @@ -679,7 +713,8 @@ export namespace doubleclickbidmanager_v1 { } } - export interface Params$Resource$Lineitems$Downloadlineitems { + export interface Params$Resource$Lineitems$Downloadlineitems extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -691,7 +726,8 @@ export namespace doubleclickbidmanager_v1 { */ requestBody?: Schema$DownloadLineItemsRequest; } - export interface Params$Resource$Lineitems$Uploadlineitems { + export interface Params$Resource$Lineitems$Uploadlineitems extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1045,7 +1081,8 @@ export namespace doubleclickbidmanager_v1 { } } - export interface Params$Resource$Queries$Createquery { + export interface Params$Resource$Queries$Createquery extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1057,7 +1094,8 @@ export namespace doubleclickbidmanager_v1 { */ requestBody?: Schema$Query; } - export interface Params$Resource$Queries$Deletequery { + export interface Params$Resource$Queries$Deletequery extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1068,7 +1106,7 @@ export namespace doubleclickbidmanager_v1 { */ queryId?: string; } - export interface Params$Resource$Queries$Getquery { + export interface Params$Resource$Queries$Getquery extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1079,13 +1117,14 @@ export namespace doubleclickbidmanager_v1 { */ queryId?: string; } - export interface Params$Resource$Queries$Listqueries { + export interface Params$Resource$Queries$Listqueries extends + StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; } - export interface Params$Resource$Queries$Runquery { + export interface Params$Resource$Queries$Runquery extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1184,7 +1223,8 @@ export namespace doubleclickbidmanager_v1 { } } - export interface Params$Resource$Reports$Listreports { + export interface Params$Resource$Reports$Listreports extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1274,7 +1314,7 @@ export namespace doubleclickbidmanager_v1 { } } - export interface Params$Resource$Sdf$Download { + export interface Params$Resource$Sdf$Download extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/doubleclicksearch/v2.ts b/src/apis/doubleclicksearch/v2.ts index 02cca71674..428c26118b 100644 --- a/src/apis/doubleclicksearch/v2.ts +++ b/src/apis/doubleclicksearch/v2.ts @@ -29,6 +29,40 @@ export namespace doubleclicksearch_v2 { version: 'v2'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * DoubleClick Search API * @@ -482,7 +516,7 @@ export namespace doubleclicksearch_v2 { */ reportType?: string; /** - * Synchronous report only. The maxinum number of rows to return; additional + * Synchronous report only. The maximum number of rows to return; additional * rows are dropped. Acceptable values are 0 to 10000, inclusive. Defaults * to 10000. */ @@ -944,7 +978,7 @@ export namespace doubleclicksearch_v2 { } } - export interface Params$Resource$Conversion$Get { + export interface Params$Resource$Conversion$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -997,7 +1031,8 @@ export namespace doubleclicksearch_v2 { */ startRow?: number; } - export interface Params$Resource$Conversion$Insert { + export interface Params$Resource$Conversion$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1009,7 +1044,7 @@ export namespace doubleclicksearch_v2 { */ requestBody?: Schema$ConversionList; } - export interface Params$Resource$Conversion$Patch { + export interface Params$Resource$Conversion$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1051,7 +1086,8 @@ export namespace doubleclicksearch_v2 { */ requestBody?: Schema$ConversionList; } - export interface Params$Resource$Conversion$Update { + export interface Params$Resource$Conversion$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1063,7 +1099,8 @@ export namespace doubleclicksearch_v2 { */ requestBody?: Schema$ConversionList; } - export interface Params$Resource$Conversion$Updateavailability { + export interface Params$Resource$Conversion$Updateavailability extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1345,7 +1382,7 @@ export namespace doubleclicksearch_v2 { } } - export interface Params$Resource$Reports$Generate { + export interface Params$Resource$Reports$Generate extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1357,7 +1394,7 @@ export namespace doubleclicksearch_v2 { */ requestBody?: Schema$ReportRequest; } - export interface Params$Resource$Reports$Get { + export interface Params$Resource$Reports$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1368,7 +1405,7 @@ export namespace doubleclicksearch_v2 { */ reportId?: string; } - export interface Params$Resource$Reports$Getfile { + export interface Params$Resource$Reports$Getfile extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1383,7 +1420,7 @@ export namespace doubleclicksearch_v2 { */ reportId?: string; } - export interface Params$Resource$Reports$Request { + export interface Params$Resource$Reports$Request extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1478,7 +1515,8 @@ export namespace doubleclicksearch_v2 { } } - export interface Params$Resource$Savedcolumns$List { + export interface Params$Resource$Savedcolumns$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/drive/v2.ts b/src/apis/drive/v2.ts index be0f1273b9..4c8d8ff712 100644 --- a/src/apis/drive/v2.ts +++ b/src/apis/drive/v2.ts @@ -29,6 +29,40 @@ export namespace drive_v2 { version: 'v2'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Drive API * @@ -766,6 +800,11 @@ export namespace drive_v2 { * A short description of the file. */ description?: string; + /** + * Short lived download URL for the file. This field is only populated for + * files with content stored in Drive; it is not populated for Google Docs + * or shortcut files. + */ downloadUrl?: string; /** * Deprecated: use capabilities/canEdit. @@ -1655,7 +1694,7 @@ export namespace drive_v2 { } } - export interface Params$Resource$About$Get { + export interface Params$Resource$About$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1818,7 +1857,7 @@ export namespace drive_v2 { } } - export interface Params$Resource$Apps$Get { + export interface Params$Resource$Apps$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1829,7 +1868,7 @@ export namespace drive_v2 { */ appId?: string; } - export interface Params$Resource$Apps$List { + export interface Params$Resource$Apps$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2151,7 +2190,7 @@ export namespace drive_v2 { } } - export interface Params$Resource$Changes$Get { + export interface Params$Resource$Changes$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2170,7 +2209,8 @@ export namespace drive_v2 { */ teamDriveId?: string; } - export interface Params$Resource$Changes$Getstartpagetoken { + export interface Params$Resource$Changes$Getstartpagetoken extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2186,7 +2226,7 @@ export namespace drive_v2 { */ teamDriveId?: string; } - export interface Params$Resource$Changes$List { + export interface Params$Resource$Changes$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2245,7 +2285,7 @@ export namespace drive_v2 { */ teamDriveId?: string; } - export interface Params$Resource$Changes$Watch { + export interface Params$Resource$Changes$Watch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2386,7 +2426,7 @@ export namespace drive_v2 { } } - export interface Params$Resource$Channels$Stop { + export interface Params$Resource$Channels$Stop extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2675,7 +2715,7 @@ export namespace drive_v2 { } } - export interface Params$Resource$Children$Delete { + export interface Params$Resource$Children$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2690,7 +2730,7 @@ export namespace drive_v2 { */ folderId?: string; } - export interface Params$Resource$Children$Get { + export interface Params$Resource$Children$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2705,7 +2745,7 @@ export namespace drive_v2 { */ folderId?: string; } - export interface Params$Resource$Children$Insert { + export interface Params$Resource$Children$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2725,7 +2765,7 @@ export namespace drive_v2 { */ requestBody?: Schema$ChildReference; } - export interface Params$Resource$Children$List { + export interface Params$Resource$Children$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3165,7 +3205,7 @@ export namespace drive_v2 { } } - export interface Params$Resource$Comments$Delete { + export interface Params$Resource$Comments$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3180,7 +3220,7 @@ export namespace drive_v2 { */ fileId?: string; } - export interface Params$Resource$Comments$Get { + export interface Params$Resource$Comments$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3200,7 +3240,7 @@ export namespace drive_v2 { */ includeDeleted?: boolean; } - export interface Params$Resource$Comments$Insert { + export interface Params$Resource$Comments$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3216,7 +3256,7 @@ export namespace drive_v2 { */ requestBody?: Schema$Comment; } - export interface Params$Resource$Comments$List { + export interface Params$Resource$Comments$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3248,7 +3288,7 @@ export namespace drive_v2 { */ updatedMin?: string; } - export interface Params$Resource$Comments$Patch { + export interface Params$Resource$Comments$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3268,7 +3308,7 @@ export namespace drive_v2 { */ requestBody?: Schema$Comment; } - export interface Params$Resource$Comments$Update { + export interface Params$Resource$Comments$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4286,7 +4326,7 @@ export namespace drive_v2 { } } - export interface Params$Resource$Files$Copy { + export interface Params$Resource$Files$Copy extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4337,7 +4377,7 @@ export namespace drive_v2 { */ requestBody?: Schema$File; } - export interface Params$Resource$Files$Delete { + export interface Params$Resource$Files$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4352,13 +4392,13 @@ export namespace drive_v2 { */ supportsTeamDrives?: boolean; } - export interface Params$Resource$Files$Emptytrash { + export interface Params$Resource$Files$Emptytrash extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; } - export interface Params$Resource$Files$Export { + export interface Params$Resource$Files$Export extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4373,7 +4413,8 @@ export namespace drive_v2 { */ mimeType?: string; } - export interface Params$Resource$Files$Generateids { + export interface Params$Resource$Files$Generateids extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4389,7 +4430,7 @@ export namespace drive_v2 { */ space?: string; } - export interface Params$Resource$Files$Get { + export interface Params$Resource$Files$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4423,7 +4464,7 @@ export namespace drive_v2 { */ updateViewedDate?: boolean; } - export interface Params$Resource$Files$Insert { + export interface Params$Resource$Files$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4489,7 +4530,7 @@ export namespace drive_v2 { body?: any; }; } - export interface Params$Resource$Files$List { + export interface Params$Resource$Files$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4555,7 +4596,7 @@ export namespace drive_v2 { */ teamDriveId?: string; } - export interface Params$Resource$Files$Patch { + export interface Params$Resource$Files$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4640,7 +4681,7 @@ export namespace drive_v2 { */ requestBody?: Schema$File; } - export interface Params$Resource$Files$Touch { + export interface Params$Resource$Files$Touch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4655,7 +4696,7 @@ export namespace drive_v2 { */ supportsTeamDrives?: boolean; } - export interface Params$Resource$Files$Trash { + export interface Params$Resource$Files$Trash extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4670,7 +4711,7 @@ export namespace drive_v2 { */ supportsTeamDrives?: boolean; } - export interface Params$Resource$Files$Untrash { + export interface Params$Resource$Files$Untrash extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4685,7 +4726,7 @@ export namespace drive_v2 { */ supportsTeamDrives?: boolean; } - export interface Params$Resource$Files$Update { + export interface Params$Resource$Files$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4785,7 +4826,7 @@ export namespace drive_v2 { body?: any; }; } - export interface Params$Resource$Files$Watch { + export interface Params$Resource$Files$Watch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5097,7 +5138,7 @@ export namespace drive_v2 { } } - export interface Params$Resource$Parents$Delete { + export interface Params$Resource$Parents$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5112,7 +5153,7 @@ export namespace drive_v2 { */ parentId?: string; } - export interface Params$Resource$Parents$Get { + export interface Params$Resource$Parents$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5127,7 +5168,7 @@ export namespace drive_v2 { */ parentId?: string; } - export interface Params$Resource$Parents$Insert { + export interface Params$Resource$Parents$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5147,7 +5188,7 @@ export namespace drive_v2 { */ requestBody?: Schema$ParentReference; } - export interface Params$Resource$Parents$List { + export interface Params$Resource$Parents$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5662,7 +5703,8 @@ export namespace drive_v2 { } } - export interface Params$Resource$Permissions$Delete { + export interface Params$Resource$Permissions$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5687,7 +5729,7 @@ export namespace drive_v2 { */ useDomainAdminAccess?: boolean; } - export interface Params$Resource$Permissions$Get { + export interface Params$Resource$Permissions$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5712,7 +5754,8 @@ export namespace drive_v2 { */ useDomainAdminAccess?: boolean; } - export interface Params$Resource$Permissions$Getidforemail { + export interface Params$Resource$Permissions$Getidforemail extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5723,7 +5766,8 @@ export namespace drive_v2 { */ email?: string; } - export interface Params$Resource$Permissions$Insert { + export interface Params$Resource$Permissions$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5758,7 +5802,7 @@ export namespace drive_v2 { */ requestBody?: Schema$Permission; } - export interface Params$Resource$Permissions$List { + export interface Params$Resource$Permissions$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5790,7 +5834,8 @@ export namespace drive_v2 { */ useDomainAdminAccess?: boolean; } - export interface Params$Resource$Permissions$Patch { + export interface Params$Resource$Permissions$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5829,7 +5874,8 @@ export namespace drive_v2 { */ requestBody?: Schema$Permission; } - export interface Params$Resource$Permissions$Update { + export interface Params$Resource$Permissions$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6281,7 +6327,8 @@ export namespace drive_v2 { } } - export interface Params$Resource$Properties$Delete { + export interface Params$Resource$Properties$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6300,7 +6347,7 @@ export namespace drive_v2 { */ visibility?: string; } - export interface Params$Resource$Properties$Get { + export interface Params$Resource$Properties$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6319,7 +6366,8 @@ export namespace drive_v2 { */ visibility?: string; } - export interface Params$Resource$Properties$Insert { + export interface Params$Resource$Properties$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6335,7 +6383,7 @@ export namespace drive_v2 { */ requestBody?: Schema$Property; } - export interface Params$Resource$Properties$List { + export interface Params$Resource$Properties$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6346,7 +6394,7 @@ export namespace drive_v2 { */ fileId?: string; } - export interface Params$Resource$Properties$Patch { + export interface Params$Resource$Properties$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6371,7 +6419,8 @@ export namespace drive_v2 { */ requestBody?: Schema$Property; } - export interface Params$Resource$Properties$Update { + export interface Params$Resource$Properties$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6542,7 +6591,7 @@ export namespace drive_v2 { } } - export interface Params$Resource$Realtime$Get { + export interface Params$Resource$Realtime$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6559,7 +6608,7 @@ export namespace drive_v2 { */ revision?: number; } - export interface Params$Resource$Realtime$Update { + export interface Params$Resource$Realtime$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7020,7 +7069,7 @@ export namespace drive_v2 { } } - export interface Params$Resource$Replies$Delete { + export interface Params$Resource$Replies$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7039,7 +7088,7 @@ export namespace drive_v2 { */ replyId?: string; } - export interface Params$Resource$Replies$Get { + export interface Params$Resource$Replies$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7062,7 +7111,7 @@ export namespace drive_v2 { */ replyId?: string; } - export interface Params$Resource$Replies$Insert { + export interface Params$Resource$Replies$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7082,7 +7131,7 @@ export namespace drive_v2 { */ requestBody?: Schema$CommentReply; } - export interface Params$Resource$Replies$List { + export interface Params$Resource$Replies$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7113,7 +7162,7 @@ export namespace drive_v2 { */ pageToken?: string; } - export interface Params$Resource$Replies$Patch { + export interface Params$Resource$Replies$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7137,7 +7186,7 @@ export namespace drive_v2 { */ requestBody?: Schema$CommentReply; } - export interface Params$Resource$Replies$Update { + export interface Params$Resource$Replies$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7500,7 +7549,7 @@ export namespace drive_v2 { } } - export interface Params$Resource$Revisions$Delete { + export interface Params$Resource$Revisions$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7515,7 +7564,7 @@ export namespace drive_v2 { */ revisionId?: string; } - export interface Params$Resource$Revisions$Get { + export interface Params$Resource$Revisions$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7530,7 +7579,7 @@ export namespace drive_v2 { */ revisionId?: string; } - export interface Params$Resource$Revisions$List { + export interface Params$Resource$Revisions$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7550,7 +7599,7 @@ export namespace drive_v2 { */ pageToken?: string; } - export interface Params$Resource$Revisions$Patch { + export interface Params$Resource$Revisions$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7570,7 +7619,7 @@ export namespace drive_v2 { */ requestBody?: Schema$Revision; } - export interface Params$Resource$Revisions$Update { + export interface Params$Resource$Revisions$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7935,7 +7984,8 @@ export namespace drive_v2 { } } - export interface Params$Resource$Teamdrives$Delete { + export interface Params$Resource$Teamdrives$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7946,7 +7996,7 @@ export namespace drive_v2 { */ teamDriveId?: string; } - export interface Params$Resource$Teamdrives$Get { + export interface Params$Resource$Teamdrives$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7963,7 +8013,8 @@ export namespace drive_v2 { */ useDomainAdminAccess?: boolean; } - export interface Params$Resource$Teamdrives$Insert { + export interface Params$Resource$Teamdrives$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7983,7 +8034,7 @@ export namespace drive_v2 { */ requestBody?: Schema$TeamDrive; } - export interface Params$Resource$Teamdrives$List { + export interface Params$Resource$Teamdrives$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8008,7 +8059,8 @@ export namespace drive_v2 { */ useDomainAdminAccess?: boolean; } - export interface Params$Resource$Teamdrives$Update { + export interface Params$Resource$Teamdrives$Update extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/drive/v3.ts b/src/apis/drive/v3.ts index 253d8e3aa8..6957e4ee71 100644 --- a/src/apis/drive/v3.ts +++ b/src/apis/drive/v3.ts @@ -29,6 +29,40 @@ export namespace drive_v3 { version: 'v3'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Drive API * @@ -1091,7 +1125,7 @@ export namespace drive_v3 { } } - export interface Params$Resource$About$Get { + export interface Params$Resource$About$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1326,7 +1360,8 @@ export namespace drive_v3 { } } - export interface Params$Resource$Changes$Getstartpagetoken { + export interface Params$Resource$Changes$Getstartpagetoken extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1342,7 +1377,7 @@ export namespace drive_v3 { */ teamDriveId?: string; } - export interface Params$Resource$Changes$List { + export interface Params$Resource$Changes$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1396,7 +1431,7 @@ export namespace drive_v3 { */ teamDriveId?: string; } - export interface Params$Resource$Changes$Watch { + export interface Params$Resource$Changes$Watch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1532,7 +1567,7 @@ export namespace drive_v3 { } } - export interface Params$Resource$Channels$Stop { + export interface Params$Resource$Channels$Stop extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1885,7 +1920,7 @@ export namespace drive_v3 { } } - export interface Params$Resource$Comments$Create { + export interface Params$Resource$Comments$Create extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1901,7 +1936,7 @@ export namespace drive_v3 { */ requestBody?: Schema$Comment; } - export interface Params$Resource$Comments$Delete { + export interface Params$Resource$Comments$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1916,7 +1951,7 @@ export namespace drive_v3 { */ fileId?: string; } - export interface Params$Resource$Comments$Get { + export interface Params$Resource$Comments$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1936,7 +1971,7 @@ export namespace drive_v3 { */ includeDeleted?: boolean; } - export interface Params$Resource$Comments$List { + export interface Params$Resource$Comments$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1966,7 +2001,7 @@ export namespace drive_v3 { */ startModifiedTime?: string; } - export interface Params$Resource$Comments$Update { + export interface Params$Resource$Comments$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2686,7 +2721,7 @@ export namespace drive_v3 { } } - export interface Params$Resource$Files$Copy { + export interface Params$Resource$Files$Copy extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2722,7 +2757,7 @@ export namespace drive_v3 { */ requestBody?: Schema$File; } - export interface Params$Resource$Files$Create { + export interface Params$Resource$Files$Create extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2773,7 +2808,7 @@ export namespace drive_v3 { body?: any; }; } - export interface Params$Resource$Files$Delete { + export interface Params$Resource$Files$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2788,13 +2823,13 @@ export namespace drive_v3 { */ supportsTeamDrives?: boolean; } - export interface Params$Resource$Files$Emptytrash { + export interface Params$Resource$Files$Emptytrash extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; } - export interface Params$Resource$Files$Export { + export interface Params$Resource$Files$Export extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2809,7 +2844,8 @@ export namespace drive_v3 { */ mimeType?: string; } - export interface Params$Resource$Files$Generateids { + export interface Params$Resource$Files$Generateids extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2825,7 +2861,7 @@ export namespace drive_v3 { */ space?: string; } - export interface Params$Resource$Files$Get { + export interface Params$Resource$Files$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2845,7 +2881,7 @@ export namespace drive_v3 { */ supportsTeamDrives?: boolean; } - export interface Params$Resource$Files$List { + export interface Params$Resource$Files$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2908,7 +2944,7 @@ export namespace drive_v3 { */ teamDriveId?: string; } - export interface Params$Resource$Files$Update { + export interface Params$Resource$Files$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2964,7 +3000,7 @@ export namespace drive_v3 { body?: any; }; } - export interface Params$Resource$Files$Watch { + export interface Params$Resource$Files$Watch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3354,7 +3390,8 @@ export namespace drive_v3 { } } - export interface Params$Resource$Permissions$Create { + export interface Params$Resource$Permissions$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3396,7 +3433,8 @@ export namespace drive_v3 { */ requestBody?: Schema$Permission; } - export interface Params$Resource$Permissions$Delete { + export interface Params$Resource$Permissions$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3421,7 +3459,7 @@ export namespace drive_v3 { */ useDomainAdminAccess?: boolean; } - export interface Params$Resource$Permissions$Get { + export interface Params$Resource$Permissions$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3446,7 +3484,7 @@ export namespace drive_v3 { */ useDomainAdminAccess?: boolean; } - export interface Params$Resource$Permissions$List { + export interface Params$Resource$Permissions$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3478,7 +3516,8 @@ export namespace drive_v3 { */ useDomainAdminAccess?: boolean; } - export interface Params$Resource$Permissions$Update { + export interface Params$Resource$Permissions$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3871,7 +3910,7 @@ export namespace drive_v3 { } } - export interface Params$Resource$Replies$Create { + export interface Params$Resource$Replies$Create extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3891,7 +3930,7 @@ export namespace drive_v3 { */ requestBody?: Schema$Reply; } - export interface Params$Resource$Replies$Delete { + export interface Params$Resource$Replies$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3910,7 +3949,7 @@ export namespace drive_v3 { */ replyId?: string; } - export interface Params$Resource$Replies$Get { + export interface Params$Resource$Replies$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3934,7 +3973,7 @@ export namespace drive_v3 { */ replyId?: string; } - export interface Params$Resource$Replies$List { + export interface Params$Resource$Replies$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3963,7 +4002,7 @@ export namespace drive_v3 { */ pageToken?: string; } - export interface Params$Resource$Replies$Update { + export interface Params$Resource$Replies$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4262,7 +4301,7 @@ export namespace drive_v3 { } } - export interface Params$Resource$Revisions$Delete { + export interface Params$Resource$Revisions$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4277,7 +4316,7 @@ export namespace drive_v3 { */ revisionId?: string; } - export interface Params$Resource$Revisions$Get { + export interface Params$Resource$Revisions$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4297,7 +4336,7 @@ export namespace drive_v3 { */ revisionId?: string; } - export interface Params$Resource$Revisions$List { + export interface Params$Resource$Revisions$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4317,7 +4356,7 @@ export namespace drive_v3 { */ pageToken?: string; } - export interface Params$Resource$Revisions$Update { + export interface Params$Resource$Revisions$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4682,7 +4721,8 @@ export namespace drive_v3 { } } - export interface Params$Resource$Teamdrives$Create { + export interface Params$Resource$Teamdrives$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4702,7 +4742,8 @@ export namespace drive_v3 { */ requestBody?: Schema$TeamDrive; } - export interface Params$Resource$Teamdrives$Delete { + export interface Params$Resource$Teamdrives$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4713,7 +4754,7 @@ export namespace drive_v3 { */ teamDriveId?: string; } - export interface Params$Resource$Teamdrives$Get { + export interface Params$Resource$Teamdrives$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4730,7 +4771,7 @@ export namespace drive_v3 { */ useDomainAdminAccess?: boolean; } - export interface Params$Resource$Teamdrives$List { + export interface Params$Resource$Teamdrives$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4755,7 +4796,8 @@ export namespace drive_v3 { */ useDomainAdminAccess?: boolean; } - export interface Params$Resource$Teamdrives$Update { + export interface Params$Resource$Teamdrives$Update extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/file/v1beta1.ts b/src/apis/file/v1beta1.ts index 7c7e877b97..068bcba0f2 100644 --- a/src/apis/file/v1beta1.ts +++ b/src/apis/file/v1beta1.ts @@ -29,6 +29,57 @@ export namespace file_v1beta1 { version: 'v1beta1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Filestore API * @@ -544,7 +595,8 @@ export namespace file_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Get { + export interface Params$Resource$Projects$Locations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -555,7 +607,8 @@ export namespace file_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$List { + export interface Params$Resource$Projects$Locations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -928,7 +981,8 @@ export namespace file_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Instances$Create { + export interface Params$Resource$Projects$Locations$Instances$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -951,7 +1005,8 @@ export namespace file_v1beta1 { */ requestBody?: Schema$Instance; } - export interface Params$Resource$Projects$Locations$Instances$Delete { + export interface Params$Resource$Projects$Locations$Instances$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -963,7 +1018,8 @@ export namespace file_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Instances$Get { + export interface Params$Resource$Projects$Locations$Instances$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -975,7 +1031,8 @@ export namespace file_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Instances$List { + export interface Params$Resource$Projects$Locations$Instances$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1007,7 +1064,8 @@ export namespace file_v1beta1 { */ parent?: string; } - export interface Params$Resource$Projects$Locations$Instances$Patch { + export interface Params$Resource$Projects$Locations$Instances$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1330,7 +1388,8 @@ export namespace file_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Operations$Cancel { + export interface Params$Resource$Projects$Locations$Operations$Cancel extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1346,7 +1405,8 @@ export namespace file_v1beta1 { */ requestBody?: Schema$CancelOperationRequest; } - export interface Params$Resource$Projects$Locations$Operations$Delete { + export interface Params$Resource$Projects$Locations$Operations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1357,7 +1417,8 @@ export namespace file_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$Get { + export interface Params$Resource$Projects$Locations$Operations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1368,7 +1429,8 @@ export namespace file_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$List { + export interface Params$Resource$Projects$Locations$Operations$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/firebasedynamiclinks/v1.ts b/src/apis/firebasedynamiclinks/v1.ts index 1401cb5a7f..bd50044157 100644 --- a/src/apis/firebasedynamiclinks/v1.ts +++ b/src/apis/firebasedynamiclinks/v1.ts @@ -29,6 +29,57 @@ export namespace firebasedynamiclinks_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Firebase Dynamic Links API * @@ -782,7 +833,8 @@ export namespace firebasedynamiclinks_v1 { } } - export interface Params$Resource$Managedshortlinks$Create { + export interface Params$Resource$Managedshortlinks$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -886,7 +938,8 @@ export namespace firebasedynamiclinks_v1 { } } - export interface Params$Resource$Shortlinks$Create { + export interface Params$Resource$Shortlinks$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1139,7 +1192,7 @@ export namespace firebasedynamiclinks_v1 { } } - export interface Params$Resource$V1$Getlinkstats { + export interface Params$Resource$V1$Getlinkstats extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1158,7 +1211,8 @@ export namespace firebasedynamiclinks_v1 { */ sdkVersion?: string; } - export interface Params$Resource$V1$Installattribution { + export interface Params$Resource$V1$Installattribution extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1170,7 +1224,8 @@ export namespace firebasedynamiclinks_v1 { */ requestBody?: Schema$GetIosPostInstallAttributionRequest; } - export interface Params$Resource$V1$Reopenattribution { + export interface Params$Resource$V1$Reopenattribution extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/firebasehosting/v1beta1.ts b/src/apis/firebasehosting/v1beta1.ts index 8d14617961..dc781f35e0 100644 --- a/src/apis/firebasehosting/v1beta1.ts +++ b/src/apis/firebasehosting/v1beta1.ts @@ -29,6 +29,57 @@ export namespace firebasehosting_v1beta1 { version: 'v1beta1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Firebase Hosting API * @@ -849,7 +900,8 @@ export namespace firebasehosting_v1beta1 { } } - export interface Params$Resource$Sites$Domains$Create { + export interface Params$Resource$Sites$Domains$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -866,7 +918,8 @@ export namespace firebasehosting_v1beta1 { */ requestBody?: Schema$Domain; } - export interface Params$Resource$Sites$Domains$Delete { + export interface Params$Resource$Sites$Domains$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -877,7 +930,8 @@ export namespace firebasehosting_v1beta1 { */ name?: string; } - export interface Params$Resource$Sites$Domains$Get { + export interface Params$Resource$Sites$Domains$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -888,7 +942,8 @@ export namespace firebasehosting_v1beta1 { */ name?: string; } - export interface Params$Resource$Sites$Domains$List { + export interface Params$Resource$Sites$Domains$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -908,7 +963,8 @@ export namespace firebasehosting_v1beta1 { */ parent?: string; } - export interface Params$Resource$Sites$Domains$Update { + export interface Params$Resource$Sites$Domains$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1079,7 +1135,8 @@ export namespace firebasehosting_v1beta1 { } } - export interface Params$Resource$Sites$Releases$Create { + export interface Params$Resource$Sites$Releases$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1105,7 +1162,8 @@ export namespace firebasehosting_v1beta1 { */ requestBody?: Schema$Release; } - export interface Params$Resource$Sites$Releases$List { + export interface Params$Resource$Sites$Releases$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1427,7 +1485,8 @@ export namespace firebasehosting_v1beta1 { } } - export interface Params$Resource$Sites$Versions$Create { + export interface Params$Resource$Sites$Versions$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1454,7 +1513,8 @@ export namespace firebasehosting_v1beta1 { */ requestBody?: Schema$Version; } - export interface Params$Resource$Sites$Versions$Delete { + export interface Params$Resource$Sites$Versions$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1466,7 +1526,8 @@ export namespace firebasehosting_v1beta1 { */ name?: string; } - export interface Params$Resource$Sites$Versions$Patch { + export interface Params$Resource$Sites$Versions$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1492,7 +1553,8 @@ export namespace firebasehosting_v1beta1 { */ requestBody?: Schema$Version; } - export interface Params$Resource$Sites$Versions$Populatefiles { + export interface Params$Resource$Sites$Versions$Populatefiles extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1594,7 +1656,8 @@ export namespace firebasehosting_v1beta1 { } } - export interface Params$Resource$Sites$Versions$Files$List { + export interface Params$Resource$Sites$Versions$Files$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/firebaserules/v1.ts b/src/apis/firebaserules/v1.ts index 39eff68734..6753481820 100644 --- a/src/apis/firebaserules/v1.ts +++ b/src/apis/firebaserules/v1.ts @@ -29,6 +29,57 @@ export namespace firebaserules_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Firebase Rules API * @@ -559,7 +610,7 @@ export namespace firebaserules_v1 { } } - export interface Params$Resource$Projects$Test { + export interface Params$Resource$Projects$Test extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1022,7 +1073,8 @@ export namespace firebaserules_v1 { } } - export interface Params$Resource$Projects$Releases$Create { + export interface Params$Resource$Projects$Releases$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1039,7 +1091,8 @@ export namespace firebaserules_v1 { */ requestBody?: Schema$Release; } - export interface Params$Resource$Projects$Releases$Delete { + export interface Params$Resource$Projects$Releases$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1051,7 +1104,8 @@ export namespace firebaserules_v1 { */ name?: string; } - export interface Params$Resource$Projects$Releases$Get { + export interface Params$Resource$Projects$Releases$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1063,7 +1117,8 @@ export namespace firebaserules_v1 { */ name?: string; } - export interface Params$Resource$Projects$Releases$Getexecutable { + export interface Params$Resource$Projects$Releases$Getexecutable extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1080,7 +1135,8 @@ export namespace firebaserules_v1 { */ name?: string; } - export interface Params$Resource$Projects$Releases$List { + export interface Params$Resource$Projects$Releases$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1124,7 +1180,8 @@ export namespace firebaserules_v1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Releases$Patch { + export interface Params$Resource$Projects$Releases$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1430,7 +1487,8 @@ export namespace firebaserules_v1 { } } - export interface Params$Resource$Projects$Rulesets$Create { + export interface Params$Resource$Projects$Rulesets$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1447,7 +1505,8 @@ export namespace firebaserules_v1 { */ requestBody?: Schema$Ruleset; } - export interface Params$Resource$Projects$Rulesets$Delete { + export interface Params$Resource$Projects$Rulesets$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1459,7 +1518,8 @@ export namespace firebaserules_v1 { */ name?: string; } - export interface Params$Resource$Projects$Rulesets$Get { + export interface Params$Resource$Projects$Rulesets$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1471,7 +1531,8 @@ export namespace firebaserules_v1 { */ name?: string; } - export interface Params$Resource$Projects$Rulesets$List { + export interface Params$Resource$Projects$Rulesets$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/firestore/v1.ts b/src/apis/firestore/v1.ts index 2b596b2316..1e4002f37d 100644 --- a/src/apis/firestore/v1.ts +++ b/src/apis/firestore/v1.ts @@ -29,6 +29,57 @@ export namespace firestore_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Firestore API * @@ -73,6 +124,375 @@ export namespace firestore_v1 { * representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} + /** + * Metadata for google.longrunning.Operation results from + * FirestoreAdmin.ExportDocuments. + */ + export interface Schema$GoogleFirestoreAdminV1ExportDocumentsMetadata { + /** + * Which collection ids are being exported. + */ + collectionIds?: string[]; + /** + * The time this operation completed. Will be unset if operation still in + * progress. + */ + endTime?: string; + /** + * The state of the export operation. + */ + operationState?: string; + /** + * Where the entities are being exported to. + */ + outputUriPrefix?: string; + /** + * The progress, in bytes, of this operation. + */ + progressBytes?: Schema$GoogleFirestoreAdminV1Progress; + /** + * The progress, in documents, of this operation. + */ + progressDocuments?: Schema$GoogleFirestoreAdminV1Progress; + /** + * The time this operation started. + */ + startTime?: string; + } + /** + * The request for FirestoreAdmin.ExportDocuments. + */ + export interface Schema$GoogleFirestoreAdminV1ExportDocumentsRequest { + /** + * Which collection ids to export. Unspecified means all collections. + */ + collectionIds?: string[]; + /** + * The output URI. Currently only supports Google Cloud Storage URIs of the + * form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the + * name of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an + * optional Google Cloud Storage namespace path. When choosing a name, be + * sure to consider Google Cloud Storage naming guidelines: + * https://cloud.google.com/storage/docs/naming. If the URI is a bucket + * (without a namespace path), a prefix will be generated based on the start + * time. + */ + outputUriPrefix?: string; + } + /** + * Returned in the google.longrunning.Operation response field. + */ + export interface Schema$GoogleFirestoreAdminV1ExportDocumentsResponse { + /** + * Location of the output files. This can be used to begin an import into + * Cloud Firestore (this project or another project) after the operation + * completes successfully. + */ + outputUriPrefix?: string; + } + /** + * Represents a single field in the database. Fields are grouped by their + * "Collection Group", which represent all collections in the + * database with the same id. + */ + export interface Schema$GoogleFirestoreAdminV1Field { + /** + * The index configuration for this field. If unset, field indexing will + * revert to the configuration defined by the `ancestor_field`. To + * explicitly remove all indexes for this field, specify an index config + * with an empty list of indexes. + */ + indexConfig?: Schema$GoogleFirestoreAdminV1IndexConfig; + /** + * A field name of the form + * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` + * A field path may be a simple field name, e.g. `address` or a path to + * fields within map_value , e.g. `address.city`, or a special field path. + * The only valid special field is `*`, which represents any field. Field + * paths may be quoted using ` (backtick). The only character that needs to + * be escaped within a quoted field path is the backtick character itself, + * escaped using a backslash. Special characters in field paths that must be + * quoted include: `*`, `.`, ``` (backtick), `[`, `]`, as well as any ascii + * symbolic characters. Examples: (Note: Comments here are written in + * markdown syntax, so there is an additional layer of backticks to + * represent a code block) `\`address.city\`` represents a field named + * `address.city`, not the map key `city` in the field `address`. `\`*\`` + * represents a field named `*`, not any field. A special `Field` contains + * the default indexing settings for all fields. This field's resource + * name is: + * `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/x + * Indexes defined on this `Field` will be applied to all fields which do + * not have their own `Field` index configuration. + */ + name?: string; + } + /** + * Metadata for google.longrunning.Operation results from + * FirestoreAdmin.UpdateField. + */ + export interface Schema$GoogleFirestoreAdminV1FieldOperationMetadata { + /** + * The time this operation completed. Will be unset if operation still in + * progress. + */ + endTime?: string; + /** + * The field resource that this operation is acting on. For example: + * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` + */ + field?: string; + /** + * A list of IndexConfigDelta, which describe the intent of this operation. + */ + indexConfigDeltas?: Schema$GoogleFirestoreAdminV1IndexConfigDelta[]; + /** + * The progress, in bytes, of this operation. + */ + progressBytes?: Schema$GoogleFirestoreAdminV1Progress; + /** + * The progress, in documents, of this operation. + */ + progressDocuments?: Schema$GoogleFirestoreAdminV1Progress; + /** + * The time this operation started. + */ + startTime?: string; + /** + * The state of the operation. + */ + state?: string; + } + /** + * Metadata for google.longrunning.Operation results from + * FirestoreAdmin.ImportDocuments. + */ + export interface Schema$GoogleFirestoreAdminV1ImportDocumentsMetadata { + /** + * Which collection ids are being imported. + */ + collectionIds?: string[]; + /** + * The time this operation completed. Will be unset if operation still in + * progress. + */ + endTime?: string; + /** + * The location of the documents being imported. + */ + inputUriPrefix?: string; + /** + * The state of the import operation. + */ + operationState?: string; + /** + * The progress, in bytes, of this operation. + */ + progressBytes?: Schema$GoogleFirestoreAdminV1Progress; + /** + * The progress, in documents, of this operation. + */ + progressDocuments?: Schema$GoogleFirestoreAdminV1Progress; + /** + * The time this operation started. + */ + startTime?: string; + } + /** + * The request for FirestoreAdmin.ImportDocuments. + */ + export interface Schema$GoogleFirestoreAdminV1ImportDocumentsRequest { + /** + * Which collection ids to import. Unspecified means all collections + * included in the import. + */ + collectionIds?: string[]; + /** + * Location of the exported files. This must match the output_uri_prefix of + * an ExportDocumentsResponse from an export that has completed + * successfully. See: + * google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix. + */ + inputUriPrefix?: string; + } + /** + * Cloud Firestore indexes enable simple and complex queries against documents + * in a database. + */ + export interface Schema$GoogleFirestoreAdminV1Index { + /** + * The fields supported by this index. For composite indexes, this is + * always 2 or more fields. The last field entry is always for the field + * path `__name__`. If, on creation, `__name__` was not specified as the + * last field, it will be added automatically with the same direction as + * that of the last field defined. If the final field in a composite index + * is not directional, the `__name__` will be ordered ASCENDING (unless + * explicitly specified). For single field indexes, this will always be + * exactly one entry with a field path equal to the field path of the + * associated field. + */ + fields?: Schema$GoogleFirestoreAdminV1IndexField[]; + /** + * Output only. A server defined name for this index. The form of this name + * for composite indexes will be: + * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` + * For single field indexes, this field will be empty. + */ + name?: string; + /** + * Indexes with a collection query scope specified allow queries against a + * collection that is the child of a specific document, specified at query + * time, and that has the same collection id. Indexes with a collection + * group query scope specified allow queries against all collections + * descended from a specific document, specified at query time, and that + * have the same collection id as this index. + */ + queryScope?: string; + /** + * Output only. The serving state of the index. + */ + state?: string; + } + /** + * The index configuration for this field. + */ + export interface Schema$GoogleFirestoreAdminV1IndexConfig { + /** + * Output only. Specifies the resource name of the `Field` from which this + * field's index configuration is set (when `uses_ancestor_config` is + * true), or from which it *would* be set if this field had no index + * configuration (when `uses_ancestor_config` is false). + */ + ancestorField?: string; + /** + * The indexes supported for this field. + */ + indexes?: Schema$GoogleFirestoreAdminV1Index[]; + /** + * Output only When true, the `Field`'s index configuration is in the + * process of being reverted. Once complete, the index config will + * transition to the same state as the field specified by `ancestor_field`, + * at which point `uses_ancestor_config` will be `true` and `reverting` will + * be `false`. + */ + reverting?: boolean; + /** + * Output only. When true, the `Field`'s index configuration is set from + * the configuration specified by the `ancestor_field`. When false, the + * `Field`'s index configuration is defined explicitly. + */ + usesAncestorConfig?: boolean; + } + /** + * Information about an index configuration change. + */ + export interface Schema$GoogleFirestoreAdminV1IndexConfigDelta { + /** + * Specifies how the index is changing. + */ + changeType?: string; + /** + * The index being changed. + */ + index?: Schema$GoogleFirestoreAdminV1Index; + } + /** + * A field in an index. The field_path describes which field is indexed, the + * value_mode describes how the field value is indexed. + */ + export interface Schema$GoogleFirestoreAdminV1IndexField { + /** + * Indicates that this field supports operations on `array_value`s. + */ + arrayConfig?: string; + /** + * Can be __name__. For single field indexes, this must match the name of + * the field or may be omitted. + */ + fieldPath?: string; + /** + * Indicates that this field supports ordering by the specified order or + * comparing using =, <, <=, >, >=. + */ + order?: string; + } + /** + * Metadata for google.longrunning.Operation results from + * FirestoreAdmin.CreateIndex. + */ + export interface Schema$GoogleFirestoreAdminV1IndexOperationMetadata { + /** + * The time this operation completed. Will be unset if operation still in + * progress. + */ + endTime?: string; + /** + * The index resource that this operation is acting on. For example: + * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` + */ + index?: string; + /** + * The progress, in bytes, of this operation. + */ + progressBytes?: Schema$GoogleFirestoreAdminV1Progress; + /** + * The progress, in documents, of this operation. + */ + progressDocuments?: Schema$GoogleFirestoreAdminV1Progress; + /** + * The time this operation started. + */ + startTime?: string; + /** + * The state of the operation. + */ + state?: string; + } + /** + * The response for FirestoreAdmin.ListFields. + */ + export interface Schema$GoogleFirestoreAdminV1ListFieldsResponse { + /** + * The requested fields. + */ + fields?: Schema$GoogleFirestoreAdminV1Field[]; + /** + * A page token that may be used to request another page of results. If + * blank, this is the last page. + */ + nextPageToken?: string; + } + /** + * The response for FirestoreAdmin.ListIndexes. + */ + export interface Schema$GoogleFirestoreAdminV1ListIndexesResponse { + /** + * The requested indexes. + */ + indexes?: Schema$GoogleFirestoreAdminV1Index[]; + /** + * A page token that may be used to request another page of results. If + * blank, this is the last page. + */ + nextPageToken?: string; + } + /** + * The metadata message for google.cloud.location.Location.metadata. + */ + export interface Schema$GoogleFirestoreAdminV1LocationMetadata {} + /** + * Describes the progress of the operation. Unit of work is generic and must + * be interpreted based on where Progress is used. + */ + export interface Schema$GoogleFirestoreAdminV1Progress { + /** + * The amount of work completed. + */ + completedWork?: string; + /** + * The amount of work estimated. + */ + estimatedWork?: string; + } /** * The request message for Operations.CancelOperation. */ @@ -245,17 +665,968 @@ export namespace firestore_v1 { export class Resource$Projects$Databases { root: Firestore; + collectionGroups: Resource$Projects$Databases$Collectiongroups; operations: Resource$Projects$Databases$Operations; constructor(root: Firestore) { this.root = root; this.getRoot.bind(this); + this.collectionGroups = + new Resource$Projects$Databases$Collectiongroups(root); this.operations = new Resource$Projects$Databases$Operations(root); } getRoot() { return this.root; } - } + + + /** + * firestore.projects.databases.exportDocuments + * @desc Exports a copy of all or a subset of documents from Google Cloud + * Firestore to another storage system, such as Google Cloud Storage. Recent + * updates to documents may not be reflected in the export. The export + * occurs in the background and its progress can be monitored and managed + * via the Operation resource that is created. The output of an export may + * only be used once the associated operation is done. If an export + * operation is cancelled before completion it may leave partial data behind + * in Google Cloud Storage. + * @alias firestore.projects.databases.exportDocuments + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Database to export. Should be of the form: `projects/{project_id}/databases/{database_id}`. + * @param {().GoogleFirestoreAdminV1ExportDocumentsRequest} 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 + */ + exportDocuments( + params?: Params$Resource$Projects$Databases$Exportdocuments, + options?: MethodOptions): + AxiosPromise; + exportDocuments( + params: Params$Resource$Projects$Databases$Exportdocuments, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + exportDocuments( + params: Params$Resource$Projects$Databases$Exportdocuments, + callback: BodyResponseCallback): + void; + exportDocuments( + callback: BodyResponseCallback): + void; + exportDocuments( + paramsOrCallback?: Params$Resource$Projects$Databases$Exportdocuments| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Databases$Exportdocuments; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Databases$Exportdocuments; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firestore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:exportDocuments') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * firestore.projects.databases.importDocuments + * @desc Imports documents into Google Cloud Firestore. Existing documents + * with the same name are overwritten. The import occurs in the background + * and its progress can be monitored and managed via the Operation resource + * that is created. If an ImportDocuments operation is cancelled, it is + * possible that a subset of the data has already been imported to Cloud + * Firestore. + * @alias firestore.projects.databases.importDocuments + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Database to import into. Should be of the form: `projects/{project_id}/databases/{database_id}`. + * @param {().GoogleFirestoreAdminV1ImportDocumentsRequest} 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 + */ + importDocuments( + params?: Params$Resource$Projects$Databases$Importdocuments, + options?: MethodOptions): + AxiosPromise; + importDocuments( + params: Params$Resource$Projects$Databases$Importdocuments, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + importDocuments( + params: Params$Resource$Projects$Databases$Importdocuments, + callback: BodyResponseCallback): + void; + importDocuments( + callback: BodyResponseCallback): + void; + importDocuments( + paramsOrCallback?: Params$Resource$Projects$Databases$Importdocuments| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Databases$Importdocuments; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Databases$Importdocuments; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firestore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:importDocuments') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Databases$Exportdocuments extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Database to export. Should be of the form: + * `projects/{project_id}/databases/{database_id}`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleFirestoreAdminV1ExportDocumentsRequest; + } + export interface Params$Resource$Projects$Databases$Importdocuments extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Database to import into. Should be of the form: + * `projects/{project_id}/databases/{database_id}`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleFirestoreAdminV1ImportDocumentsRequest; + } + + export class Resource$Projects$Databases$Collectiongroups { + root: Firestore; + fields: Resource$Projects$Databases$Collectiongroups$Fields; + indexes: Resource$Projects$Databases$Collectiongroups$Indexes; + constructor(root: Firestore) { + this.root = root; + this.getRoot.bind(this); + this.fields = + new Resource$Projects$Databases$Collectiongroups$Fields(root); + this.indexes = + new Resource$Projects$Databases$Collectiongroups$Indexes(root); + } + + getRoot() { + return this.root; + } + } + + + export class Resource$Projects$Databases$Collectiongroups$Fields { + root: Firestore; + constructor(root: Firestore) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * firestore.projects.databases.collectionGroups.fields.get + * @desc Gets the metadata and configuration for a Field. + * @alias firestore.projects.databases.collectionGroups.fields.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_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 + */ + get(params?: Params$Resource$Projects$Databases$Collectiongroups$Fields$Get, + options?: MethodOptions): + AxiosPromise; + get(params: Params$Resource$Projects$Databases$Collectiongroups$Fields$Get, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + get(params: Params$Resource$Projects$Databases$Collectiongroups$Fields$Get, + callback: BodyResponseCallback): + void; + get(callback: BodyResponseCallback): + void; + get(paramsOrCallback?: + Params$Resource$Projects$Databases$Collectiongroups$Fields$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Databases$Collectiongroups$Fields$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Databases$Collectiongroups$Fields$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firestore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * firestore.projects.databases.collectionGroups.fields.list + * @desc Lists the field configuration and metadata for this database. + * Currently, FirestoreAdmin.ListFields only supports listing fields that + * have been explicitly overridden. To issue this query, call + * FirestoreAdmin.ListFields with the filter set to + * `indexConfig.usesAncestorConfig:false`. + * @alias firestore.projects.databases.collectionGroups.fields.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter The filter to apply to list results. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to `indexConfig.usesAncestorConfig:false`. + * @param {integer=} params.pageSize The number of results to return. + * @param {string=} params.pageToken A page token, returned from a previous call to FirestoreAdmin.ListFields, that may be used to get the next page of results. + * @param {string} params.parent A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_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 + */ + list( + params?: + Params$Resource$Projects$Databases$Collectiongroups$Fields$List, + options?: MethodOptions): + AxiosPromise; + list( + params: Params$Resource$Projects$Databases$Collectiongroups$Fields$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback< + Schema$GoogleFirestoreAdminV1ListFieldsResponse>): void; + list( + params: Params$Resource$Projects$Databases$Collectiongroups$Fields$List, + callback: BodyResponseCallback< + Schema$GoogleFirestoreAdminV1ListFieldsResponse>): void; + list(callback: BodyResponseCallback< + Schema$GoogleFirestoreAdminV1ListFieldsResponse>): void; + list( + paramsOrCallback?: + Params$Resource$Projects$Databases$Collectiongroups$Fields$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$GoogleFirestoreAdminV1ListFieldsResponse>): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Databases$Collectiongroups$Fields$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Databases$Collectiongroups$Fields$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firestore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/fields') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest< + Schema$GoogleFirestoreAdminV1ListFieldsResponse>(parameters); + } + } + + + /** + * firestore.projects.databases.collectionGroups.fields.patch + * @desc Updates a field configuration. Currently, field updates apply only + * to single field index configuration. However, calls to + * FirestoreAdmin.UpdateField should provide a field mask to avoid changing + * any configuration that the caller isn't aware of. The field mask should + * be specified as: `{ paths: "index_config" }`. This call returns a + * google.longrunning.Operation which may be used to track the status of the + * field update. The metadata for the operation will be the type + * FieldOperationMetadata. To configure the default field settings for the + * database, use the special `Field` with resource name: + * `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/x`. + * @alias firestore.projects.databases.collectionGroups.fields.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name A field name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path may be a simple field name, e.g. `address` or a path to fields within map_value , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths may be quoted using ` (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, ``` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block) `\`address.city\`` represents a field named `address.city`, not the map key `city` in the field `address`. `\`*\`` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/x` Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration. + * @param {string=} params.updateMask A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field. + * @param {().GoogleFirestoreAdminV1Field} 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 + */ + patch( + params?: + Params$Resource$Projects$Databases$Collectiongroups$Fields$Patch, + options?: MethodOptions): + AxiosPromise; + patch( + params: + Params$Resource$Projects$Databases$Collectiongroups$Fields$Patch, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + patch( + params: + Params$Resource$Projects$Databases$Collectiongroups$Fields$Patch, + callback: BodyResponseCallback): + void; + patch(callback: BodyResponseCallback): + void; + patch( + paramsOrCallback?: + Params$Resource$Projects$Databases$Collectiongroups$Fields$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Databases$Collectiongroups$Fields$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Databases$Collectiongroups$Fields$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firestore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Databases$Collectiongroups$Fields$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A name of the form + * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}` + */ + name?: string; + } + export interface Params$Resource$Projects$Databases$Collectiongroups$Fields$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The filter to apply to list results. Currently, FirestoreAdmin.ListFields + * only supports listing fields that have been explicitly overridden. To + * issue this query, call FirestoreAdmin.ListFields with the filter set to + * `indexConfig.usesAncestorConfig:false`. + */ + filter?: string; + /** + * The number of results to return. + */ + pageSize?: number; + /** + * A page token, returned from a previous call to FirestoreAdmin.ListFields, + * that may be used to get the next page of results. + */ + pageToken?: string; + /** + * A parent name of the form + * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Databases$Collectiongroups$Fields$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A field name of the form + * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` + * A field path may be a simple field name, e.g. `address` or a path to + * fields within map_value , e.g. `address.city`, or a special field path. + * The only valid special field is `*`, which represents any field. Field + * paths may be quoted using ` (backtick). The only character that needs to + * be escaped within a quoted field path is the backtick character itself, + * escaped using a backslash. Special characters in field paths that must be + * quoted include: `*`, `.`, ``` (backtick), `[`, `]`, as well as any ascii + * symbolic characters. Examples: (Note: Comments here are written in + * markdown syntax, so there is an additional layer of backticks to + * represent a code block) `\`address.city\`` represents a field named + * `address.city`, not the map key `city` in the field `address`. `\`*\`` + * represents a field named `*`, not any field. A special `Field` contains + * the default indexing settings for all fields. This field's resource name + * is: + * `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/x` + * Indexes defined on this `Field` will be applied to all fields which do + * not have their own `Field` index configuration. + */ + name?: string; + /** + * A mask, relative to the field. If specified, only configuration specified + * by this field_mask will be updated in the field. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleFirestoreAdminV1Field; + } + + + export class Resource$Projects$Databases$Collectiongroups$Indexes { + root: Firestore; + constructor(root: Firestore) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * firestore.projects.databases.collectionGroups.indexes.create + * @desc Creates a composite index. This returns a + * google.longrunning.Operation which may be used to track the status of the + * creation. The metadata for the operation will be the type + * IndexOperationMetadata. + * @alias firestore.projects.databases.collectionGroups.indexes.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` + * @param {().GoogleFirestoreAdminV1Index} 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$Databases$Collectiongroups$Indexes$Create, + options?: MethodOptions): + AxiosPromise; + create( + params: + Params$Resource$Projects$Databases$Collectiongroups$Indexes$Create, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + create( + params: + Params$Resource$Projects$Databases$Collectiongroups$Indexes$Create, + callback: BodyResponseCallback): + void; + create(callback: BodyResponseCallback): + void; + create( + paramsOrCallback?: + Params$Resource$Projects$Databases$Collectiongroups$Indexes$Create| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Databases$Collectiongroups$Indexes$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Databases$Collectiongroups$Indexes$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firestore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/indexes') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * firestore.projects.databases.collectionGroups.indexes.delete + * @desc Deletes a composite index. + * @alias firestore.projects.databases.collectionGroups.indexes.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_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 + */ + delete( + params?: + Params$Resource$Projects$Databases$Collectiongroups$Indexes$Delete, + options?: MethodOptions): AxiosPromise; + delete( + params: + Params$Resource$Projects$Databases$Collectiongroups$Indexes$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: + Params$Resource$Projects$Databases$Collectiongroups$Indexes$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + Params$Resource$Projects$Databases$Collectiongroups$Indexes$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Databases$Collectiongroups$Indexes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Databases$Collectiongroups$Indexes$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firestore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * firestore.projects.databases.collectionGroups.indexes.get + * @desc Gets a composite index. + * @alias firestore.projects.databases.collectionGroups.indexes.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_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 + */ + get(params?: + Params$Resource$Projects$Databases$Collectiongroups$Indexes$Get, + options?: MethodOptions): + AxiosPromise; + get(params: Params$Resource$Projects$Databases$Collectiongroups$Indexes$Get, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + get(params: Params$Resource$Projects$Databases$Collectiongroups$Indexes$Get, + callback: BodyResponseCallback): + void; + get(callback: BodyResponseCallback): + void; + get(paramsOrCallback?: + Params$Resource$Projects$Databases$Collectiongroups$Indexes$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Databases$Collectiongroups$Indexes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Databases$Collectiongroups$Indexes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firestore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * firestore.projects.databases.collectionGroups.indexes.list + * @desc Lists composite indexes. + * @alias firestore.projects.databases.collectionGroups.indexes.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter The filter to apply to list results. + * @param {integer=} params.pageSize The number of results to return. + * @param {string=} params.pageToken A page token, returned from a previous call to FirestoreAdmin.ListIndexes, that may be used to get the next page of results. + * @param {string} params.parent A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_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 + */ + list( + params?: + Params$Resource$Projects$Databases$Collectiongroups$Indexes$List, + options?: MethodOptions): + AxiosPromise; + list( + params: + Params$Resource$Projects$Databases$Collectiongroups$Indexes$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback< + Schema$GoogleFirestoreAdminV1ListIndexesResponse>): void; + list( + params: + Params$Resource$Projects$Databases$Collectiongroups$Indexes$List, + callback: BodyResponseCallback< + Schema$GoogleFirestoreAdminV1ListIndexesResponse>): void; + list(callback: BodyResponseCallback< + Schema$GoogleFirestoreAdminV1ListIndexesResponse>): void; + list( + paramsOrCallback?: + Params$Resource$Projects$Databases$Collectiongroups$Indexes$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$GoogleFirestoreAdminV1ListIndexesResponse>): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Databases$Collectiongroups$Indexes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Databases$Collectiongroups$Indexes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firestore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/indexes') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest< + Schema$GoogleFirestoreAdminV1ListIndexesResponse>(parameters); + } + } + } + + export interface Params$Resource$Projects$Databases$Collectiongroups$Indexes$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A parent name of the form + * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleFirestoreAdminV1Index; + } + export interface Params$Resource$Projects$Databases$Collectiongroups$Indexes$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A name of the form + * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` + */ + name?: string; + } + export interface Params$Resource$Projects$Databases$Collectiongroups$Indexes$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A name of the form + * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` + */ + name?: string; + } + export interface Params$Resource$Projects$Databases$Collectiongroups$Indexes$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The filter to apply to list results. + */ + filter?: string; + /** + * The number of results to return. + */ + pageSize?: number; + /** + * A page token, returned from a previous call to + * FirestoreAdmin.ListIndexes, that may be used to get the next page of + * results. + */ + pageToken?: string; + /** + * A parent name of the form + * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` + */ + parent?: string; + } + export class Resource$Projects$Databases$Operations { @@ -569,7 +1940,8 @@ export namespace firestore_v1 { } } - export interface Params$Resource$Projects$Databases$Operations$Cancel { + export interface Params$Resource$Projects$Databases$Operations$Cancel extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -585,7 +1957,8 @@ export namespace firestore_v1 { */ requestBody?: Schema$GoogleLongrunningCancelOperationRequest; } - export interface Params$Resource$Projects$Databases$Operations$Delete { + export interface Params$Resource$Projects$Databases$Operations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -596,7 +1969,8 @@ export namespace firestore_v1 { */ name?: string; } - export interface Params$Resource$Projects$Databases$Operations$Get { + export interface Params$Resource$Projects$Databases$Operations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -607,7 +1981,8 @@ export namespace firestore_v1 { */ name?: string; } - export interface Params$Resource$Projects$Databases$Operations$List { + export interface Params$Resource$Projects$Databases$Operations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -777,7 +2152,8 @@ export namespace firestore_v1 { } } - export interface Params$Resource$Projects$Locations$Get { + export interface Params$Resource$Projects$Locations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -788,7 +2164,8 @@ export namespace firestore_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$List { + export interface Params$Resource$Projects$Locations$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/firestore/v1beta1.ts b/src/apis/firestore/v1beta1.ts index 69c9c22e20..d6196e3e7b 100644 --- a/src/apis/firestore/v1beta1.ts +++ b/src/apis/firestore/v1beta1.ts @@ -29,6 +29,57 @@ export namespace firestore_v1beta1 { version: 'v1beta1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Firestore API * @@ -1534,7 +1585,8 @@ export namespace firestore_v1beta1 { } } - export interface Params$Resource$Projects$Databases$Exportdocuments { + export interface Params$Resource$Projects$Databases$Exportdocuments extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1551,7 +1603,8 @@ export namespace firestore_v1beta1 { */ requestBody?: Schema$GoogleFirestoreAdminV1beta1ExportDocumentsRequest; } - export interface Params$Resource$Projects$Databases$Importdocuments { + export interface Params$Resource$Projects$Databases$Importdocuments extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2491,7 +2544,8 @@ export namespace firestore_v1beta1 { } } - export interface Params$Resource$Projects$Databases$Documents$Batchget { + export interface Params$Resource$Projects$Databases$Documents$Batchget extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2508,7 +2562,8 @@ export namespace firestore_v1beta1 { */ requestBody?: Schema$BatchGetDocumentsRequest; } - export interface Params$Resource$Projects$Databases$Documents$Begintransaction { + export interface Params$Resource$Projects$Databases$Documents$Begintransaction + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2525,7 +2580,8 @@ export namespace firestore_v1beta1 { */ requestBody?: Schema$BeginTransactionRequest; } - export interface Params$Resource$Projects$Databases$Documents$Commit { + export interface Params$Resource$Projects$Databases$Documents$Commit extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2542,7 +2598,8 @@ export namespace firestore_v1beta1 { */ requestBody?: Schema$CommitRequest; } - export interface Params$Resource$Projects$Databases$Documents$Createdocument { + export interface Params$Resource$Projects$Databases$Documents$Createdocument + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2575,7 +2632,8 @@ export namespace firestore_v1beta1 { */ requestBody?: Schema$Document; } - export interface Params$Resource$Projects$Databases$Documents$Delete { + export interface Params$Resource$Projects$Databases$Documents$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2597,7 +2655,8 @@ export namespace firestore_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Databases$Documents$Get { + export interface Params$Resource$Projects$Databases$Documents$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2623,7 +2682,8 @@ export namespace firestore_v1beta1 { */ transaction?: string; } - export interface Params$Resource$Projects$Databases$Documents$List { + export interface Params$Resource$Projects$Databases$Documents$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2678,7 +2738,8 @@ export namespace firestore_v1beta1 { */ transaction?: string; } - export interface Params$Resource$Projects$Databases$Documents$Listcollectionids { + export interface Params$Resource$Projects$Databases$Documents$Listcollectionids + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2697,7 +2758,8 @@ export namespace firestore_v1beta1 { */ requestBody?: Schema$ListCollectionIdsRequest; } - export interface Params$Resource$Projects$Databases$Documents$Listen { + export interface Params$Resource$Projects$Databases$Documents$Listen extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2714,7 +2776,8 @@ export namespace firestore_v1beta1 { */ requestBody?: Schema$ListenRequest; } - export interface Params$Resource$Projects$Databases$Documents$Patch { + export interface Params$Resource$Projects$Databases$Documents$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2751,7 +2814,8 @@ export namespace firestore_v1beta1 { */ requestBody?: Schema$Document; } - export interface Params$Resource$Projects$Databases$Documents$Rollback { + export interface Params$Resource$Projects$Databases$Documents$Rollback extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2768,7 +2832,8 @@ export namespace firestore_v1beta1 { */ requestBody?: Schema$RollbackRequest; } - export interface Params$Resource$Projects$Databases$Documents$Runquery { + export interface Params$Resource$Projects$Databases$Documents$Runquery extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2788,7 +2853,8 @@ export namespace firestore_v1beta1 { */ requestBody?: Schema$RunQueryRequest; } - export interface Params$Resource$Projects$Databases$Documents$Write { + export interface Params$Resource$Projects$Databases$Documents$Write extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3119,7 +3185,8 @@ export namespace firestore_v1beta1 { } } - export interface Params$Resource$Projects$Databases$Indexes$Create { + export interface Params$Resource$Projects$Databases$Indexes$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3136,7 +3203,8 @@ export namespace firestore_v1beta1 { */ requestBody?: Schema$GoogleFirestoreAdminV1beta1Index; } - export interface Params$Resource$Projects$Databases$Indexes$Delete { + export interface Params$Resource$Projects$Databases$Indexes$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3148,7 +3216,8 @@ export namespace firestore_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Databases$Indexes$Get { + export interface Params$Resource$Projects$Databases$Indexes$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3160,7 +3229,8 @@ export namespace firestore_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Databases$Indexes$List { + export interface Params$Resource$Projects$Databases$Indexes$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/firestore/v1beta2.ts b/src/apis/firestore/v1beta2.ts index 955713fe7c..5fa0454c5f 100644 --- a/src/apis/firestore/v1beta2.ts +++ b/src/apis/firestore/v1beta2.ts @@ -29,6 +29,57 @@ export namespace firestore_v1beta2 { version: 'v1beta2'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Firestore API * @@ -724,7 +775,8 @@ export namespace firestore_v1beta2 { } } - export interface Params$Resource$Projects$Databases$Exportdocuments { + export interface Params$Resource$Projects$Databases$Exportdocuments extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -741,7 +793,8 @@ export namespace firestore_v1beta2 { */ requestBody?: Schema$GoogleFirestoreAdminV1beta2ExportDocumentsRequest; } - export interface Params$Resource$Projects$Databases$Importdocuments { + export interface Params$Resource$Projects$Databases$Importdocuments extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1039,7 +1092,8 @@ export namespace firestore_v1beta2 { } } - export interface Params$Resource$Projects$Databases$Collectiongroups$Fields$Get { + export interface Params$Resource$Projects$Databases$Collectiongroups$Fields$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1051,7 +1105,8 @@ export namespace firestore_v1beta2 { */ name?: string; } - export interface Params$Resource$Projects$Databases$Collectiongroups$Fields$List { + export interface Params$Resource$Projects$Databases$Collectiongroups$Fields$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1079,7 +1134,8 @@ export namespace firestore_v1beta2 { */ parent?: string; } - export interface Params$Resource$Projects$Databases$Collectiongroups$Fields$Patch { + export interface Params$Resource$Projects$Databases$Collectiongroups$Fields$Patch + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1444,7 +1500,8 @@ export namespace firestore_v1beta2 { } } - export interface Params$Resource$Projects$Databases$Collectiongroups$Indexes$Create { + export interface Params$Resource$Projects$Databases$Collectiongroups$Indexes$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1461,7 +1518,8 @@ export namespace firestore_v1beta2 { */ requestBody?: Schema$GoogleFirestoreAdminV1beta2Index; } - export interface Params$Resource$Projects$Databases$Collectiongroups$Indexes$Delete { + export interface Params$Resource$Projects$Databases$Collectiongroups$Indexes$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1473,7 +1531,8 @@ export namespace firestore_v1beta2 { */ name?: string; } - export interface Params$Resource$Projects$Databases$Collectiongroups$Indexes$Get { + export interface Params$Resource$Projects$Databases$Collectiongroups$Indexes$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1485,7 +1544,8 @@ export namespace firestore_v1beta2 { */ name?: string; } - export interface Params$Resource$Projects$Databases$Collectiongroups$Indexes$List { + export interface Params$Resource$Projects$Databases$Collectiongroups$Indexes$List + extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/fitness/v1.ts b/src/apis/fitness/v1.ts index 3c587e52b3..4a022b1a2f 100644 --- a/src/apis/fitness/v1.ts +++ b/src/apis/fitness/v1.ts @@ -29,6 +29,40 @@ export namespace fitness_v1 { version: 'v1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Fitness * @@ -715,7 +749,8 @@ export namespace fitness_v1 { } } - export interface Params$Resource$Users$Dataset$Aggregate { + export interface Params$Resource$Users$Dataset$Aggregate extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1179,7 +1214,8 @@ export namespace fitness_v1 { } } - export interface Params$Resource$Users$Datasources$Create { + export interface Params$Resource$Users$Datasources$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1196,7 +1232,8 @@ export namespace fitness_v1 { */ requestBody?: Schema$DataSource; } - export interface Params$Resource$Users$Datasources$Delete { + export interface Params$Resource$Users$Datasources$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1212,7 +1249,8 @@ export namespace fitness_v1 { */ userId?: string; } - export interface Params$Resource$Users$Datasources$Get { + export interface Params$Resource$Users$Datasources$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1228,7 +1266,8 @@ export namespace fitness_v1 { */ userId?: string; } - export interface Params$Resource$Users$Datasources$List { + export interface Params$Resource$Users$Datasources$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1245,7 +1284,8 @@ export namespace fitness_v1 { */ userId?: string; } - export interface Params$Resource$Users$Datasources$Patch { + export interface Params$Resource$Users$Datasources$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1266,7 +1306,8 @@ export namespace fitness_v1 { */ requestBody?: Schema$DataSource; } - export interface Params$Resource$Users$Datasources$Update { + export interface Params$Resource$Users$Datasources$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1380,7 +1421,8 @@ export namespace fitness_v1 { } } - export interface Params$Resource$Users$Datasources$Datapointchanges$List { + export interface Params$Resource$Users$Datasources$Datapointchanges$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1645,7 +1687,8 @@ export namespace fitness_v1 { } } - export interface Params$Resource$Users$Datasources$Datasets$Delete { + export interface Params$Resource$Users$Datasources$Datasets$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1676,7 +1719,8 @@ export namespace fitness_v1 { */ userId?: string; } - export interface Params$Resource$Users$Datasources$Datasets$Get { + export interface Params$Resource$Users$Datasources$Datasets$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1713,7 +1757,8 @@ export namespace fitness_v1 { */ userId?: string; } - export interface Params$Resource$Users$Datasources$Datasets$Patch { + export interface Params$Resource$Users$Datasources$Datasets$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1969,7 +2014,8 @@ export namespace fitness_v1 { } } - export interface Params$Resource$Users$Sessions$Delete { + export interface Params$Resource$Users$Sessions$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1989,7 +2035,8 @@ export namespace fitness_v1 { */ userId?: string; } - export interface Params$Resource$Users$Sessions$List { + export interface Params$Resource$Users$Sessions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2023,7 +2070,8 @@ export namespace fitness_v1 { */ userId?: string; } - export interface Params$Resource$Users$Sessions$Update { + export interface Params$Resource$Users$Sessions$Update extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/fusiontables/v1.ts b/src/apis/fusiontables/v1.ts index 1322dac514..324f7af9e1 100644 --- a/src/apis/fusiontables/v1.ts +++ b/src/apis/fusiontables/v1.ts @@ -29,6 +29,40 @@ export namespace fusiontables_v1 { version: 'v1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Fusion Tables API * @@ -1002,7 +1036,7 @@ export namespace fusiontables_v1 { } } - export interface Params$Resource$Column$Delete { + export interface Params$Resource$Column$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1017,7 +1051,7 @@ export namespace fusiontables_v1 { */ tableId?: string; } - export interface Params$Resource$Column$Get { + export interface Params$Resource$Column$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1032,7 +1066,7 @@ export namespace fusiontables_v1 { */ tableId?: string; } - export interface Params$Resource$Column$Insert { + export interface Params$Resource$Column$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1048,7 +1082,7 @@ export namespace fusiontables_v1 { */ requestBody?: Schema$Column; } - export interface Params$Resource$Column$List { + export interface Params$Resource$Column$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1067,7 +1101,7 @@ export namespace fusiontables_v1 { */ tableId?: string; } - export interface Params$Resource$Column$Patch { + export interface Params$Resource$Column$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1087,7 +1121,7 @@ export namespace fusiontables_v1 { */ requestBody?: Schema$Column; } - export interface Params$Resource$Column$Update { + export interface Params$Resource$Column$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1253,7 +1287,7 @@ export namespace fusiontables_v1 { } } - export interface Params$Resource$Query$Sql { + export interface Params$Resource$Query$Sql extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1273,7 +1307,7 @@ export namespace fusiontables_v1 { */ typed?: boolean; } - export interface Params$Resource$Query$Sqlget { + export interface Params$Resource$Query$Sqlget extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1705,7 +1739,7 @@ export namespace fusiontables_v1 { } } - export interface Params$Resource$Style$Delete { + export interface Params$Resource$Style$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1720,7 +1754,7 @@ export namespace fusiontables_v1 { */ tableId?: string; } - export interface Params$Resource$Style$Get { + export interface Params$Resource$Style$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1735,7 +1769,7 @@ export namespace fusiontables_v1 { */ tableId?: string; } - export interface Params$Resource$Style$Insert { + export interface Params$Resource$Style$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1751,7 +1785,7 @@ export namespace fusiontables_v1 { */ requestBody?: Schema$StyleSetting; } - export interface Params$Resource$Style$List { + export interface Params$Resource$Style$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1770,7 +1804,7 @@ export namespace fusiontables_v1 { */ tableId?: string; } - export interface Params$Resource$Style$Patch { + export interface Params$Resource$Style$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1790,7 +1824,7 @@ export namespace fusiontables_v1 { */ requestBody?: Schema$StyleSetting; } - export interface Params$Resource$Style$Update { + export interface Params$Resource$Style$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2426,7 +2460,7 @@ export namespace fusiontables_v1 { } } - export interface Params$Resource$Table$Copy { + export interface Params$Resource$Table$Copy extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2441,7 +2475,7 @@ export namespace fusiontables_v1 { */ tableId?: string; } - export interface Params$Resource$Table$Delete { + export interface Params$Resource$Table$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2452,7 +2486,7 @@ export namespace fusiontables_v1 { */ tableId?: string; } - export interface Params$Resource$Table$Get { + export interface Params$Resource$Table$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2463,7 +2497,7 @@ export namespace fusiontables_v1 { */ tableId?: string; } - export interface Params$Resource$Table$Importrows { + export interface Params$Resource$Table$Importrows extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2522,7 +2556,8 @@ export namespace fusiontables_v1 { body?: any; }; } - export interface Params$Resource$Table$Importtable { + export interface Params$Resource$Table$Importtable extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2559,7 +2594,7 @@ export namespace fusiontables_v1 { body?: any; }; } - export interface Params$Resource$Table$Insert { + export interface Params$Resource$Table$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2571,7 +2606,7 @@ export namespace fusiontables_v1 { */ requestBody?: Schema$Table; } - export interface Params$Resource$Table$List { + export interface Params$Resource$Table$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2586,7 +2621,7 @@ export namespace fusiontables_v1 { */ pageToken?: string; } - export interface Params$Resource$Table$Patch { + export interface Params$Resource$Table$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2608,7 +2643,7 @@ export namespace fusiontables_v1 { */ requestBody?: Schema$Table; } - export interface Params$Resource$Table$Update { + export interface Params$Resource$Table$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2839,7 +2874,7 @@ export namespace fusiontables_v1 { } } - export interface Params$Resource$Task$Delete { + export interface Params$Resource$Task$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2854,7 +2889,7 @@ export namespace fusiontables_v1 { */ taskId?: string; } - export interface Params$Resource$Task$Get { + export interface Params$Resource$Task$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2869,7 +2904,7 @@ export namespace fusiontables_v1 { */ taskId?: string; } - export interface Params$Resource$Task$List { + export interface Params$Resource$Task$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3300,7 +3335,7 @@ export namespace fusiontables_v1 { } } - export interface Params$Resource$Template$Delete { + export interface Params$Resource$Template$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3315,7 +3350,7 @@ export namespace fusiontables_v1 { */ templateId?: number; } - export interface Params$Resource$Template$Get { + export interface Params$Resource$Template$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3330,7 +3365,7 @@ export namespace fusiontables_v1 { */ templateId?: number; } - export interface Params$Resource$Template$Insert { + export interface Params$Resource$Template$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3346,7 +3381,7 @@ export namespace fusiontables_v1 { */ requestBody?: Schema$Template; } - export interface Params$Resource$Template$List { + export interface Params$Resource$Template$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3365,7 +3400,7 @@ export namespace fusiontables_v1 { */ tableId?: string; } - export interface Params$Resource$Template$Patch { + export interface Params$Resource$Template$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3385,7 +3420,7 @@ export namespace fusiontables_v1 { */ requestBody?: Schema$Template; } - export interface Params$Resource$Template$Update { + export interface Params$Resource$Template$Update extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/fusiontables/v2.ts b/src/apis/fusiontables/v2.ts index 697d803a3a..fada2cf9c9 100644 --- a/src/apis/fusiontables/v2.ts +++ b/src/apis/fusiontables/v2.ts @@ -29,6 +29,40 @@ export namespace fusiontables_v2 { version: 'v2'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Fusion Tables API * @@ -1060,7 +1094,7 @@ export namespace fusiontables_v2 { } } - export interface Params$Resource$Column$Delete { + export interface Params$Resource$Column$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1075,7 +1109,7 @@ export namespace fusiontables_v2 { */ tableId?: string; } - export interface Params$Resource$Column$Get { + export interface Params$Resource$Column$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1090,7 +1124,7 @@ export namespace fusiontables_v2 { */ tableId?: string; } - export interface Params$Resource$Column$Insert { + export interface Params$Resource$Column$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1106,7 +1140,7 @@ export namespace fusiontables_v2 { */ requestBody?: Schema$Column; } - export interface Params$Resource$Column$List { + export interface Params$Resource$Column$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1125,7 +1159,7 @@ export namespace fusiontables_v2 { */ tableId?: string; } - export interface Params$Resource$Column$Patch { + export interface Params$Resource$Column$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1145,7 +1179,7 @@ export namespace fusiontables_v2 { */ requestBody?: Schema$Column; } - export interface Params$Resource$Column$Update { + export interface Params$Resource$Column$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1312,7 +1346,7 @@ export namespace fusiontables_v2 { } } - export interface Params$Resource$Query$Sql { + export interface Params$Resource$Query$Sql extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1333,7 +1367,7 @@ export namespace fusiontables_v2 { */ typed?: boolean; } - export interface Params$Resource$Query$Sqlget { + export interface Params$Resource$Query$Sqlget extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1765,7 +1799,7 @@ export namespace fusiontables_v2 { } } - export interface Params$Resource$Style$Delete { + export interface Params$Resource$Style$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1780,7 +1814,7 @@ export namespace fusiontables_v2 { */ tableId?: string; } - export interface Params$Resource$Style$Get { + export interface Params$Resource$Style$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1795,7 +1829,7 @@ export namespace fusiontables_v2 { */ tableId?: string; } - export interface Params$Resource$Style$Insert { + export interface Params$Resource$Style$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1811,7 +1845,7 @@ export namespace fusiontables_v2 { */ requestBody?: Schema$StyleSetting; } - export interface Params$Resource$Style$List { + export interface Params$Resource$Style$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1830,7 +1864,7 @@ export namespace fusiontables_v2 { */ tableId?: string; } - export interface Params$Resource$Style$Patch { + export interface Params$Resource$Style$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1850,7 +1884,7 @@ export namespace fusiontables_v2 { */ requestBody?: Schema$StyleSetting; } - export interface Params$Resource$Style$Update { + export interface Params$Resource$Style$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2631,7 +2665,7 @@ export namespace fusiontables_v2 { } } - export interface Params$Resource$Table$Copy { + export interface Params$Resource$Table$Copy extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2646,7 +2680,7 @@ export namespace fusiontables_v2 { */ tableId?: string; } - export interface Params$Resource$Table$Delete { + export interface Params$Resource$Table$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2657,7 +2691,7 @@ export namespace fusiontables_v2 { */ tableId?: string; } - export interface Params$Resource$Table$Get { + export interface Params$Resource$Table$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2668,7 +2702,7 @@ export namespace fusiontables_v2 { */ tableId?: string; } - export interface Params$Resource$Table$Importrows { + export interface Params$Resource$Table$Importrows extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2723,7 +2757,8 @@ export namespace fusiontables_v2 { body?: any; }; } - export interface Params$Resource$Table$Importtable { + export interface Params$Resource$Table$Importtable extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2760,7 +2795,7 @@ export namespace fusiontables_v2 { body?: any; }; } - export interface Params$Resource$Table$Insert { + export interface Params$Resource$Table$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2772,7 +2807,7 @@ export namespace fusiontables_v2 { */ requestBody?: Schema$Table; } - export interface Params$Resource$Table$List { + export interface Params$Resource$Table$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2787,7 +2822,7 @@ export namespace fusiontables_v2 { */ pageToken?: string; } - export interface Params$Resource$Table$Patch { + export interface Params$Resource$Table$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2809,7 +2844,8 @@ export namespace fusiontables_v2 { */ requestBody?: Schema$Table; } - export interface Params$Resource$Table$Refetchsheet { + export interface Params$Resource$Table$Refetchsheet extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2820,7 +2856,8 @@ export namespace fusiontables_v2 { */ tableId?: string; } - export interface Params$Resource$Table$Replacerows { + export interface Params$Resource$Table$Replacerows extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2876,7 +2913,7 @@ export namespace fusiontables_v2 { body?: any; }; } - export interface Params$Resource$Table$Update { + export interface Params$Resource$Table$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3108,7 +3145,7 @@ export namespace fusiontables_v2 { } } - export interface Params$Resource$Task$Delete { + export interface Params$Resource$Task$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3123,7 +3160,7 @@ export namespace fusiontables_v2 { */ taskId?: string; } - export interface Params$Resource$Task$Get { + export interface Params$Resource$Task$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3138,7 +3175,7 @@ export namespace fusiontables_v2 { */ taskId?: string; } - export interface Params$Resource$Task$List { + export interface Params$Resource$Task$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3569,7 +3606,7 @@ export namespace fusiontables_v2 { } } - export interface Params$Resource$Template$Delete { + export interface Params$Resource$Template$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3584,7 +3621,7 @@ export namespace fusiontables_v2 { */ templateId?: number; } - export interface Params$Resource$Template$Get { + export interface Params$Resource$Template$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3599,7 +3636,7 @@ export namespace fusiontables_v2 { */ templateId?: number; } - export interface Params$Resource$Template$Insert { + export interface Params$Resource$Template$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3615,7 +3652,7 @@ export namespace fusiontables_v2 { */ requestBody?: Schema$Template; } - export interface Params$Resource$Template$List { + export interface Params$Resource$Template$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3634,7 +3671,7 @@ export namespace fusiontables_v2 { */ tableId?: string; } - export interface Params$Resource$Template$Patch { + export interface Params$Resource$Template$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3654,7 +3691,7 @@ export namespace fusiontables_v2 { */ requestBody?: Schema$Template; } - export interface Params$Resource$Template$Update { + export interface Params$Resource$Template$Update extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/games/v1.ts b/src/apis/games/v1.ts index 4a329ec9f0..15ffd602eb 100644 --- a/src/apis/games/v1.ts +++ b/src/apis/games/v1.ts @@ -29,6 +29,40 @@ export namespace games_v1 { version: 'v1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Google Play Game Services API * @@ -3010,7 +3044,8 @@ export namespace games_v1 { } } - export interface Params$Resource$Achievementdefinitions$List { + export interface Params$Resource$Achievementdefinitions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3508,7 +3543,8 @@ export namespace games_v1 { } } - export interface Params$Resource$Achievements$Increment { + export interface Params$Resource$Achievements$Increment extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3529,7 +3565,8 @@ export namespace games_v1 { */ stepsToIncrement?: number; } - export interface Params$Resource$Achievements$List { + export interface Params$Resource$Achievements$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3560,7 +3597,8 @@ export namespace games_v1 { */ state?: string; } - export interface Params$Resource$Achievements$Reveal { + export interface Params$Resource$Achievements$Reveal extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3571,7 +3609,8 @@ export namespace games_v1 { */ achievementId?: string; } - export interface Params$Resource$Achievements$Setstepsatleast { + export interface Params$Resource$Achievements$Setstepsatleast extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3586,7 +3625,8 @@ export namespace games_v1 { */ steps?: number; } - export interface Params$Resource$Achievements$Unlock { + export interface Params$Resource$Achievements$Unlock extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3601,7 +3641,8 @@ export namespace games_v1 { */ builtinGameId?: string; } - export interface Params$Resource$Achievements$Updatemultiple { + export interface Params$Resource$Achievements$Updatemultiple extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3835,7 +3876,7 @@ export namespace games_v1 { } } - export interface Params$Resource$Applications$Get { + export interface Params$Resource$Applications$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3854,7 +3895,8 @@ export namespace games_v1 { */ platformType?: string; } - export interface Params$Resource$Applications$Played { + export interface Params$Resource$Applications$Played extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3865,7 +3907,8 @@ export namespace games_v1 { */ builtinGameId?: string; } - export interface Params$Resource$Applications$Verify { + export interface Params$Resource$Applications$Verify extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4103,7 +4146,8 @@ export namespace games_v1 { } } - export interface Params$Resource$Events$Listbyplayer { + export interface Params$Resource$Events$Listbyplayer extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4124,7 +4168,8 @@ export namespace games_v1 { */ pageToken?: string; } - export interface Params$Resource$Events$Listdefinitions { + export interface Params$Resource$Events$Listdefinitions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4145,7 +4190,7 @@ export namespace games_v1 { */ pageToken?: string; } - export interface Params$Resource$Events$Record { + export interface Params$Resource$Events$Record extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4307,7 +4352,7 @@ export namespace games_v1 { } } - export interface Params$Resource$Leaderboards$Get { + export interface Params$Resource$Leaderboards$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4322,7 +4367,8 @@ export namespace games_v1 { */ leaderboardId?: string; } - export interface Params$Resource$Leaderboards$List { + export interface Params$Resource$Leaderboards$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4499,13 +4545,15 @@ export namespace games_v1 { } } - export interface Params$Resource$Metagame$Getmetagameconfig { + export interface Params$Resource$Metagame$Getmetagameconfig extends + StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; } - export interface Params$Resource$Metagame$Listcategoriesbyplayer { + export interface Params$Resource$Metagame$Listcategoriesbyplayer extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4680,7 +4728,7 @@ export namespace games_v1 { } } - export interface Params$Resource$Players$Get { + export interface Params$Resource$Players$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4696,7 +4744,7 @@ export namespace games_v1 { */ playerId?: string; } - export interface Params$Resource$Players$List { + export interface Params$Resource$Players$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4864,7 +4912,8 @@ export namespace games_v1 { } } - export interface Params$Resource$Pushtokens$Remove { + export interface Params$Resource$Pushtokens$Remove extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4876,7 +4925,8 @@ export namespace games_v1 { */ requestBody?: Schema$PushTokenId; } - export interface Params$Resource$Pushtokens$Update { + export interface Params$Resource$Pushtokens$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4972,7 +5022,8 @@ export namespace games_v1 { } } - export interface Params$Resource$Questmilestones$Claim { + export interface Params$Resource$Questmilestones$Claim extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5141,7 +5192,7 @@ export namespace games_v1 { } } - export interface Params$Resource$Quests$Accept { + export interface Params$Resource$Quests$Accept extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5156,7 +5207,7 @@ export namespace games_v1 { */ questId?: string; } - export interface Params$Resource$Quests$List { + export interface Params$Resource$Quests$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5263,7 +5314,7 @@ export namespace games_v1 { } } - export interface Params$Resource$Revisions$Check { + export interface Params$Resource$Revisions$Check extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5819,7 +5870,7 @@ export namespace games_v1 { } } - export interface Params$Resource$Rooms$Create { + export interface Params$Resource$Rooms$Create extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5835,7 +5886,7 @@ export namespace games_v1 { */ requestBody?: Schema$RoomCreateRequest; } - export interface Params$Resource$Rooms$Decline { + export interface Params$Resource$Rooms$Decline extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5850,7 +5901,7 @@ export namespace games_v1 { */ roomId?: string; } - export interface Params$Resource$Rooms$Dismiss { + export interface Params$Resource$Rooms$Dismiss extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5861,7 +5912,7 @@ export namespace games_v1 { */ roomId?: string; } - export interface Params$Resource$Rooms$Get { + export interface Params$Resource$Rooms$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5876,7 +5927,7 @@ export namespace games_v1 { */ roomId?: string; } - export interface Params$Resource$Rooms$Join { + export interface Params$Resource$Rooms$Join extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5896,7 +5947,7 @@ export namespace games_v1 { */ requestBody?: Schema$RoomJoinRequest; } - export interface Params$Resource$Rooms$Leave { + export interface Params$Resource$Rooms$Leave extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5916,7 +5967,7 @@ export namespace games_v1 { */ requestBody?: Schema$RoomLeaveRequest; } - export interface Params$Resource$Rooms$List { + export interface Params$Resource$Rooms$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5937,7 +5988,8 @@ export namespace games_v1 { */ pageToken?: string; } - export interface Params$Resource$Rooms$Reportstatus { + export interface Params$Resource$Rooms$Reportstatus extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6342,7 +6394,7 @@ export namespace games_v1 { } } - export interface Params$Resource$Scores$Get { + export interface Params$Resource$Scores$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6382,7 +6434,7 @@ export namespace games_v1 { */ timeSpan?: string; } - export interface Params$Resource$Scores$List { + export interface Params$Resource$Scores$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6415,7 +6467,8 @@ export namespace games_v1 { */ timeSpan?: string; } - export interface Params$Resource$Scores$Listwindow { + export interface Params$Resource$Scores$Listwindow extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6460,7 +6513,7 @@ export namespace games_v1 { */ timeSpan?: string; } - export interface Params$Resource$Scores$Submit { + export interface Params$Resource$Scores$Submit extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6490,7 +6543,8 @@ export namespace games_v1 { */ scoreTag?: string; } - export interface Params$Resource$Scores$Submitmultiple { + export interface Params$Resource$Scores$Submitmultiple extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6652,7 +6706,7 @@ export namespace games_v1 { } } - export interface Params$Resource$Snapshots$Get { + export interface Params$Resource$Snapshots$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6667,7 +6721,7 @@ export namespace games_v1 { */ snapshotId?: string; } - export interface Params$Resource$Snapshots$List { + export interface Params$Resource$Snapshots$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7605,7 +7659,8 @@ export namespace games_v1 { } } - export interface Params$Resource$Turnbasedmatches$Cancel { + export interface Params$Resource$Turnbasedmatches$Cancel extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7616,7 +7671,8 @@ export namespace games_v1 { */ matchId?: string; } - export interface Params$Resource$Turnbasedmatches$Create { + export interface Params$Resource$Turnbasedmatches$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7632,7 +7688,8 @@ export namespace games_v1 { */ requestBody?: Schema$TurnBasedMatchCreateRequest; } - export interface Params$Resource$Turnbasedmatches$Decline { + export interface Params$Resource$Turnbasedmatches$Decline extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7647,7 +7704,8 @@ export namespace games_v1 { */ matchId?: string; } - export interface Params$Resource$Turnbasedmatches$Dismiss { + export interface Params$Resource$Turnbasedmatches$Dismiss extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7658,7 +7716,8 @@ export namespace games_v1 { */ matchId?: string; } - export interface Params$Resource$Turnbasedmatches$Finish { + export interface Params$Resource$Turnbasedmatches$Finish extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7678,7 +7737,8 @@ export namespace games_v1 { */ requestBody?: Schema$TurnBasedMatchResults; } - export interface Params$Resource$Turnbasedmatches$Get { + export interface Params$Resource$Turnbasedmatches$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7697,7 +7757,8 @@ export namespace games_v1 { */ matchId?: string; } - export interface Params$Resource$Turnbasedmatches$Join { + export interface Params$Resource$Turnbasedmatches$Join extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7712,7 +7773,8 @@ export namespace games_v1 { */ matchId?: string; } - export interface Params$Resource$Turnbasedmatches$Leave { + export interface Params$Resource$Turnbasedmatches$Leave extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7727,7 +7789,8 @@ export namespace games_v1 { */ matchId?: string; } - export interface Params$Resource$Turnbasedmatches$Leaveturn { + export interface Params$Resource$Turnbasedmatches$Leaveturn extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7753,7 +7816,8 @@ export namespace games_v1 { */ pendingParticipantId?: string; } - export interface Params$Resource$Turnbasedmatches$List { + export interface Params$Resource$Turnbasedmatches$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7788,7 +7852,8 @@ export namespace games_v1 { */ pageToken?: string; } - export interface Params$Resource$Turnbasedmatches$Rematch { + export interface Params$Resource$Turnbasedmatches$Rematch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7809,7 +7874,8 @@ export namespace games_v1 { */ requestId?: string; } - export interface Params$Resource$Turnbasedmatches$Sync { + export interface Params$Resource$Turnbasedmatches$Sync extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7844,7 +7910,8 @@ export namespace games_v1 { */ pageToken?: string; } - export interface Params$Resource$Turnbasedmatches$Taketurn { + export interface Params$Resource$Turnbasedmatches$Taketurn extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/gamesConfiguration/v1configuration.ts b/src/apis/gamesConfiguration/v1configuration.ts index eff2196675..0dad603820 100644 --- a/src/apis/gamesConfiguration/v1configuration.ts +++ b/src/apis/gamesConfiguration/v1configuration.ts @@ -29,6 +29,40 @@ export namespace gamesConfiguration_v1configuration { version: 'v1configuration'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Google Play Game Services Publishing API * @@ -809,7 +843,8 @@ export namespace gamesConfiguration_v1configuration { } } - export interface Params$Resource$Achievementconfigurations$Delete { + export interface Params$Resource$Achievementconfigurations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -820,7 +855,8 @@ export namespace gamesConfiguration_v1configuration { */ achievementId?: string; } - export interface Params$Resource$Achievementconfigurations$Get { + export interface Params$Resource$Achievementconfigurations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -831,7 +867,8 @@ export namespace gamesConfiguration_v1configuration { */ achievementId?: string; } - export interface Params$Resource$Achievementconfigurations$Insert { + export interface Params$Resource$Achievementconfigurations$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -847,7 +884,8 @@ export namespace gamesConfiguration_v1configuration { */ requestBody?: Schema$AchievementConfiguration; } - export interface Params$Resource$Achievementconfigurations$List { + export interface Params$Resource$Achievementconfigurations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -868,7 +906,8 @@ export namespace gamesConfiguration_v1configuration { */ pageToken?: string; } - export interface Params$Resource$Achievementconfigurations$Patch { + export interface Params$Resource$Achievementconfigurations$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -884,7 +923,8 @@ export namespace gamesConfiguration_v1configuration { */ requestBody?: Schema$AchievementConfiguration; } - export interface Params$Resource$Achievementconfigurations$Update { + export interface Params$Resource$Achievementconfigurations$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -991,7 +1031,8 @@ export namespace gamesConfiguration_v1configuration { } } - export interface Params$Resource$Imageconfigurations$Upload { + export interface Params$Resource$Imageconfigurations$Upload extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1467,7 +1508,8 @@ export namespace gamesConfiguration_v1configuration { } } - export interface Params$Resource$Leaderboardconfigurations$Delete { + export interface Params$Resource$Leaderboardconfigurations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1478,7 +1520,8 @@ export namespace gamesConfiguration_v1configuration { */ leaderboardId?: string; } - export interface Params$Resource$Leaderboardconfigurations$Get { + export interface Params$Resource$Leaderboardconfigurations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1489,7 +1532,8 @@ export namespace gamesConfiguration_v1configuration { */ leaderboardId?: string; } - export interface Params$Resource$Leaderboardconfigurations$Insert { + export interface Params$Resource$Leaderboardconfigurations$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1505,7 +1549,8 @@ export namespace gamesConfiguration_v1configuration { */ requestBody?: Schema$LeaderboardConfiguration; } - export interface Params$Resource$Leaderboardconfigurations$List { + export interface Params$Resource$Leaderboardconfigurations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1526,7 +1571,8 @@ export namespace gamesConfiguration_v1configuration { */ pageToken?: string; } - export interface Params$Resource$Leaderboardconfigurations$Patch { + export interface Params$Resource$Leaderboardconfigurations$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1542,7 +1588,8 @@ export namespace gamesConfiguration_v1configuration { */ requestBody?: Schema$LeaderboardConfiguration; } - export interface Params$Resource$Leaderboardconfigurations$Update { + export interface Params$Resource$Leaderboardconfigurations$Update extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/gamesManagement/v1management.ts b/src/apis/gamesManagement/v1management.ts index 27bac74a0b..982c18d002 100644 --- a/src/apis/gamesManagement/v1management.ts +++ b/src/apis/gamesManagement/v1management.ts @@ -29,6 +29,40 @@ export namespace gamesManagement_v1management { version: 'v1management'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Google Play Game Services Management API * @@ -742,7 +776,8 @@ export namespace gamesManagement_v1management { } } - export interface Params$Resource$Achievements$Reset { + export interface Params$Resource$Achievements$Reset extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -753,19 +788,22 @@ export namespace gamesManagement_v1management { */ achievementId?: string; } - export interface Params$Resource$Achievements$Resetall { + export interface Params$Resource$Achievements$Resetall extends + StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; } - export interface Params$Resource$Achievements$Resetallforallplayers { + export interface Params$Resource$Achievements$Resetallforallplayers extends + StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; } - export interface Params$Resource$Achievements$Resetforallplayers { + export interface Params$Resource$Achievements$Resetforallplayers extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -776,7 +814,8 @@ export namespace gamesManagement_v1management { */ achievementId?: string; } - export interface Params$Resource$Achievements$Resetmultipleforallplayers { + export interface Params$Resource$Achievements$Resetmultipleforallplayers + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -874,7 +913,8 @@ export namespace gamesManagement_v1management { } } - export interface Params$Resource$Applications$Listhidden { + export interface Params$Resource$Applications$Listhidden extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1244,7 +1284,7 @@ export namespace gamesManagement_v1management { } } - export interface Params$Resource$Events$Reset { + export interface Params$Resource$Events$Reset extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1255,19 +1295,21 @@ export namespace gamesManagement_v1management { */ eventId?: string; } - export interface Params$Resource$Events$Resetall { + export interface Params$Resource$Events$Resetall extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; } - export interface Params$Resource$Events$Resetallforallplayers { + export interface Params$Resource$Events$Resetallforallplayers extends + StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; } - export interface Params$Resource$Events$Resetforallplayers { + export interface Params$Resource$Events$Resetforallplayers extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1278,7 +1320,8 @@ export namespace gamesManagement_v1management { */ eventId?: string; } - export interface Params$Resource$Events$Resetmultipleforallplayers { + export interface Params$Resource$Events$Resetmultipleforallplayers extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1440,7 +1483,7 @@ export namespace gamesManagement_v1management { } } - export interface Params$Resource$Players$Hide { + export interface Params$Resource$Players$Hide extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1456,7 +1499,7 @@ export namespace gamesManagement_v1management { */ playerId?: string; } - export interface Params$Resource$Players$Unhide { + export interface Params$Resource$Players$Unhide extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1817,7 +1860,7 @@ export namespace gamesManagement_v1management { } } - export interface Params$Resource$Quests$Reset { + export interface Params$Resource$Quests$Reset extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1828,19 +1871,21 @@ export namespace gamesManagement_v1management { */ questId?: string; } - export interface Params$Resource$Quests$Resetall { + export interface Params$Resource$Quests$Resetall extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; } - export interface Params$Resource$Quests$Resetallforallplayers { + export interface Params$Resource$Quests$Resetallforallplayers extends + StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; } - export interface Params$Resource$Quests$Resetforallplayers { + export interface Params$Resource$Quests$Resetforallplayers extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1851,7 +1896,8 @@ export namespace gamesManagement_v1management { */ questId?: string; } - export interface Params$Resource$Quests$Resetmultipleforallplayers { + export interface Params$Resource$Quests$Resetmultipleforallplayers extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2007,13 +2053,14 @@ export namespace gamesManagement_v1management { } } - export interface Params$Resource$Rooms$Reset { + export interface Params$Resource$Rooms$Reset extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; } - export interface Params$Resource$Rooms$Resetforallplayers { + export interface Params$Resource$Rooms$Resetforallplayers extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2379,7 +2426,7 @@ export namespace gamesManagement_v1management { } } - export interface Params$Resource$Scores$Reset { + export interface Params$Resource$Scores$Reset extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2390,19 +2437,21 @@ export namespace gamesManagement_v1management { */ leaderboardId?: string; } - export interface Params$Resource$Scores$Resetall { + export interface Params$Resource$Scores$Resetall extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; } - export interface Params$Resource$Scores$Resetallforallplayers { + export interface Params$Resource$Scores$Resetallforallplayers extends + StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; } - export interface Params$Resource$Scores$Resetforallplayers { + export interface Params$Resource$Scores$Resetforallplayers extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2413,7 +2462,8 @@ export namespace gamesManagement_v1management { */ leaderboardId?: string; } - export interface Params$Resource$Scores$Resetmultipleforallplayers { + export interface Params$Resource$Scores$Resetmultipleforallplayers extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2571,13 +2621,15 @@ export namespace gamesManagement_v1management { } } - export interface Params$Resource$Turnbasedmatches$Reset { + export interface Params$Resource$Turnbasedmatches$Reset extends + StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; } - export interface Params$Resource$Turnbasedmatches$Resetforallplayers { + export interface Params$Resource$Turnbasedmatches$Resetforallplayers extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/genomics/README.md b/src/apis/genomics/README.md index 4cc3d6c715..26d418ee4d 100644 --- a/src/apis/genomics/README.md +++ b/src/apis/genomics/README.md @@ -2,7 +2,7 @@ # @google/genomics -> Upload, process, query, and search Genomics data in the cloud. +> Uploads, processes, queries, and searches Genomics data in the cloud. ## Installation diff --git a/src/apis/genomics/v1.ts b/src/apis/genomics/v1.ts index e5b3ccbf30..79f42d3970 100644 --- a/src/apis/genomics/v1.ts +++ b/src/apis/genomics/v1.ts @@ -29,10 +29,61 @@ export namespace genomics_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Genomics API * - * Upload, process, query, and search Genomics data in the cloud. + * Uploads, processes, queries, and searches Genomics data in the cloud. * * @example * const {google} = require('googleapis'); @@ -3099,7 +3150,8 @@ export namespace genomics_v1 { } } - export interface Params$Resource$Annotations$Batchcreate { + export interface Params$Resource$Annotations$Batchcreate extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3111,7 +3163,8 @@ export namespace genomics_v1 { */ requestBody?: Schema$BatchCreateAnnotationsRequest; } - export interface Params$Resource$Annotations$Create { + export interface Params$Resource$Annotations$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3123,7 +3176,8 @@ export namespace genomics_v1 { */ requestBody?: Schema$Annotation; } - export interface Params$Resource$Annotations$Delete { + export interface Params$Resource$Annotations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3134,7 +3188,7 @@ export namespace genomics_v1 { */ annotationId?: string; } - export interface Params$Resource$Annotations$Get { + export interface Params$Resource$Annotations$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3145,7 +3199,8 @@ export namespace genomics_v1 { */ annotationId?: string; } - export interface Params$Resource$Annotations$Search { + export interface Params$Resource$Annotations$Search extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3157,7 +3212,8 @@ export namespace genomics_v1 { */ requestBody?: Schema$SearchAnnotationsRequest; } - export interface Params$Resource$Annotations$Update { + export interface Params$Resource$Annotations$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3832,7 +3888,8 @@ export namespace genomics_v1 { } } - export interface Params$Resource$Annotationsets$Create { + export interface Params$Resource$Annotationsets$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3844,7 +3901,8 @@ export namespace genomics_v1 { */ requestBody?: Schema$AnnotationSet; } - export interface Params$Resource$Annotationsets$Delete { + export interface Params$Resource$Annotationsets$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3855,7 +3913,8 @@ export namespace genomics_v1 { */ annotationSetId?: string; } - export interface Params$Resource$Annotationsets$Get { + export interface Params$Resource$Annotationsets$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3866,7 +3925,8 @@ export namespace genomics_v1 { */ annotationSetId?: string; } - export interface Params$Resource$Annotationsets$Search { + export interface Params$Resource$Annotationsets$Search extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3878,7 +3938,8 @@ export namespace genomics_v1 { */ requestBody?: Schema$SearchAnnotationSetsRequest; } - export interface Params$Resource$Annotationsets$Update { + export interface Params$Resource$Annotationsets$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4518,7 +4579,7 @@ export namespace genomics_v1 { } } - export interface Params$Resource$Callsets$Create { + export interface Params$Resource$Callsets$Create extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4530,7 +4591,7 @@ export namespace genomics_v1 { */ requestBody?: Schema$CallSet; } - export interface Params$Resource$Callsets$Delete { + export interface Params$Resource$Callsets$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4541,7 +4602,7 @@ export namespace genomics_v1 { */ callSetId?: string; } - export interface Params$Resource$Callsets$Get { + export interface Params$Resource$Callsets$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4552,7 +4613,7 @@ export namespace genomics_v1 { */ callSetId?: string; } - export interface Params$Resource$Callsets$Patch { + export interface Params$Resource$Callsets$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4574,7 +4635,7 @@ export namespace genomics_v1 { */ requestBody?: Schema$CallSet; } - export interface Params$Resource$Callsets$Search { + export interface Params$Resource$Callsets$Search extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5723,7 +5784,7 @@ export namespace genomics_v1 { } } - export interface Params$Resource$Datasets$Create { + export interface Params$Resource$Datasets$Create extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5735,7 +5796,7 @@ export namespace genomics_v1 { */ requestBody?: Schema$Dataset; } - export interface Params$Resource$Datasets$Delete { + export interface Params$Resource$Datasets$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5746,7 +5807,7 @@ export namespace genomics_v1 { */ datasetId?: string; } - export interface Params$Resource$Datasets$Get { + export interface Params$Resource$Datasets$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5757,7 +5818,8 @@ export namespace genomics_v1 { */ datasetId?: string; } - export interface Params$Resource$Datasets$Getiampolicy { + export interface Params$Resource$Datasets$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5774,7 +5836,7 @@ export namespace genomics_v1 { */ requestBody?: Schema$GetIamPolicyRequest; } - export interface Params$Resource$Datasets$List { + export interface Params$Resource$Datasets$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5796,7 +5858,7 @@ export namespace genomics_v1 { */ projectId?: string; } - export interface Params$Resource$Datasets$Patch { + export interface Params$Resource$Datasets$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5818,7 +5880,8 @@ export namespace genomics_v1 { */ requestBody?: Schema$Dataset; } - export interface Params$Resource$Datasets$Setiampolicy { + export interface Params$Resource$Datasets$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5835,7 +5898,8 @@ export namespace genomics_v1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Datasets$Testiampermissions { + export interface Params$Resource$Datasets$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5852,7 +5916,8 @@ export namespace genomics_v1 { */ requestBody?: Schema$TestIamPermissionsRequest; } - export interface Params$Resource$Datasets$Undelete { + export interface Params$Resource$Datasets$Undelete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6264,7 +6329,8 @@ export namespace genomics_v1 { } } - export interface Params$Resource$Operations$Cancel { + export interface Params$Resource$Operations$Cancel extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6280,7 +6346,7 @@ export namespace genomics_v1 { */ requestBody?: Schema$CancelOperationRequest; } - export interface Params$Resource$Operations$Get { + export interface Params$Resource$Operations$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6291,7 +6357,7 @@ export namespace genomics_v1 { */ name?: string; } - export interface Params$Resource$Operations$List { + export interface Params$Resource$Operations$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7076,7 +7142,8 @@ import(paramsOrCallback?: Params$Resource$Readgroupsets$Import|BodyResponseCallb } } - export interface Params$Resource$Readgroupsets$Delete { + export interface Params$Resource$Readgroupsets$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7088,7 +7155,8 @@ import(paramsOrCallback?: Params$Resource$Readgroupsets$Import|BodyResponseCallb */ readGroupSetId?: string; } - export interface Params$Resource$Readgroupsets$Export { + export interface Params$Resource$Readgroupsets$Export extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7105,7 +7173,8 @@ import(paramsOrCallback?: Params$Resource$Readgroupsets$Import|BodyResponseCallb */ requestBody?: Schema$ExportReadGroupSetRequest; } - export interface Params$Resource$Readgroupsets$Get { + export interface Params$Resource$Readgroupsets$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7116,7 +7185,8 @@ import(paramsOrCallback?: Params$Resource$Readgroupsets$Import|BodyResponseCallb */ readGroupSetId?: string; } - export interface Params$Resource$Readgroupsets$Import { + export interface Params$Resource$Readgroupsets$Import extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7128,7 +7198,8 @@ import(paramsOrCallback?: Params$Resource$Readgroupsets$Import|BodyResponseCallb */ requestBody?: Schema$ImportReadGroupSetsRequest; } - export interface Params$Resource$Readgroupsets$Patch { + export interface Params$Resource$Readgroupsets$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7151,7 +7222,8 @@ import(paramsOrCallback?: Params$Resource$Readgroupsets$Import|BodyResponseCallb */ requestBody?: Schema$ReadGroupSet; } - export interface Params$Resource$Readgroupsets$Search { + export interface Params$Resource$Readgroupsets$Search extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7331,7 +7403,8 @@ import(paramsOrCallback?: Params$Resource$Readgroupsets$Import|BodyResponseCallb } } - export interface Params$Resource$Readgroupsets$Coveragebuckets$List { + export interface Params$Resource$Readgroupsets$Coveragebuckets$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7538,7 +7611,7 @@ import(paramsOrCallback?: Params$Resource$Readgroupsets$Import|BodyResponseCallb } } - export interface Params$Resource$Reads$Search { + export interface Params$Resource$Reads$Search extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7819,7 +7892,7 @@ import(paramsOrCallback?: Params$Resource$Readgroupsets$Import|BodyResponseCallb } } - export interface Params$Resource$References$Get { + export interface Params$Resource$References$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7830,7 +7903,8 @@ import(paramsOrCallback?: Params$Resource$Readgroupsets$Import|BodyResponseCallb */ referenceId?: string; } - export interface Params$Resource$References$Search { + export interface Params$Resource$References$Search extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7992,7 +8066,8 @@ import(paramsOrCallback?: Params$Resource$Readgroupsets$Import|BodyResponseCallb } } - export interface Params$Resource$References$Bases$List { + export interface Params$Resource$References$Bases$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8299,7 +8374,8 @@ import(paramsOrCallback?: Params$Resource$Readgroupsets$Import|BodyResponseCallb } } - export interface Params$Resource$Referencesets$Get { + export interface Params$Resource$Referencesets$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8310,7 +8386,8 @@ import(paramsOrCallback?: Params$Resource$Readgroupsets$Import|BodyResponseCallb */ referenceSetId?: string; } - export interface Params$Resource$Referencesets$Search { + export interface Params$Resource$Referencesets$Search extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9149,7 +9226,7 @@ import(paramsOrCallback?: Params$Resource$Variants$Import|BodyResponseCallback IAM Service Account Credentials API +> Creates short-lived, limited-privilege credentials for IAM service accounts. ## Installation diff --git a/src/apis/iamcredentials/v1.ts b/src/apis/iamcredentials/v1.ts index 7314490f12..bb59f8dc95 100644 --- a/src/apis/iamcredentials/v1.ts +++ b/src/apis/iamcredentials/v1.ts @@ -29,10 +29,62 @@ export namespace iamcredentials_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * IAM Service Account Credentials API * - * IAM Service Account Credentials API + * Creates short-lived, limited-privilege credentials for IAM service + * accounts. * * @example * const {google} = require('googleapis'); @@ -631,7 +683,8 @@ export namespace iamcredentials_v1 { } } - export interface Params$Resource$Projects$Serviceaccounts$Generateaccesstoken { + export interface Params$Resource$Projects$Serviceaccounts$Generateaccesstoken + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -649,7 +702,8 @@ export namespace iamcredentials_v1 { */ requestBody?: Schema$GenerateAccessTokenRequest; } - export interface Params$Resource$Projects$Serviceaccounts$Generateidentitybindingaccesstoken { + export interface Params$Resource$Projects$Serviceaccounts$Generateidentitybindingaccesstoken + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -667,7 +721,8 @@ export namespace iamcredentials_v1 { */ requestBody?: Schema$GenerateIdentityBindingAccessTokenRequest; } - export interface Params$Resource$Projects$Serviceaccounts$Generateidtoken { + export interface Params$Resource$Projects$Serviceaccounts$Generateidtoken + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -685,7 +740,8 @@ export namespace iamcredentials_v1 { */ requestBody?: Schema$GenerateIdTokenRequest; } - export interface Params$Resource$Projects$Serviceaccounts$Signblob { + export interface Params$Resource$Projects$Serviceaccounts$Signblob extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -703,7 +759,8 @@ export namespace iamcredentials_v1 { */ requestBody?: Schema$SignBlobRequest; } - export interface Params$Resource$Projects$Serviceaccounts$Signjwt { + export interface Params$Resource$Projects$Serviceaccounts$Signjwt extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/iap/v1beta1.ts b/src/apis/iap/v1beta1.ts index 09a9e12b8d..36f15e324d 100644 --- a/src/apis/iap/v1beta1.ts +++ b/src/apis/iap/v1beta1.ts @@ -29,6 +29,57 @@ export namespace iap_v1beta1 { version: 'v1beta1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Identity-Aware Proxy API * @@ -527,7 +578,8 @@ export namespace iap_v1beta1 { } } - export interface Params$Resource$Projects$Iap_tunnel$Getiampolicy { + export interface Params$Resource$Projects$Iap_tunnel$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -544,7 +596,8 @@ export namespace iap_v1beta1 { */ requestBody?: Schema$GetIamPolicyRequest; } - export interface Params$Resource$Projects$Iap_tunnel$Setiampolicy { + export interface Params$Resource$Projects$Iap_tunnel$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -561,7 +614,8 @@ export namespace iap_v1beta1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Iap_tunnel$Testiampermissions { + export interface Params$Resource$Projects$Iap_tunnel$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -817,7 +871,8 @@ export namespace iap_v1beta1 { } } - export interface Params$Resource$Projects$Iap_tunnel$Zones$Getiampolicy { + export interface Params$Resource$Projects$Iap_tunnel$Zones$Getiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -834,7 +889,8 @@ export namespace iap_v1beta1 { */ requestBody?: Schema$GetIamPolicyRequest; } - export interface Params$Resource$Projects$Iap_tunnel$Zones$Setiampolicy { + export interface Params$Resource$Projects$Iap_tunnel$Zones$Setiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -851,7 +907,8 @@ export namespace iap_v1beta1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Iap_tunnel$Zones$Testiampermissions { + export interface Params$Resource$Projects$Iap_tunnel$Zones$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1116,7 +1173,8 @@ export namespace iap_v1beta1 { } } - export interface Params$Resource$Projects$Iap_tunnel$Zones$Instances$Getiampolicy { + export interface Params$Resource$Projects$Iap_tunnel$Zones$Instances$Getiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1133,7 +1191,8 @@ export namespace iap_v1beta1 { */ requestBody?: Schema$GetIamPolicyRequest; } - export interface Params$Resource$Projects$Iap_tunnel$Zones$Instances$Setiampolicy { + export interface Params$Resource$Projects$Iap_tunnel$Zones$Instances$Setiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1150,7 +1209,8 @@ export namespace iap_v1beta1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Iap_tunnel$Zones$Instances$Testiampermissions { + export interface Params$Resource$Projects$Iap_tunnel$Zones$Instances$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1404,7 +1464,8 @@ export namespace iap_v1beta1 { } } - export interface Params$Resource$Projects$Iap_web$Getiampolicy { + export interface Params$Resource$Projects$Iap_web$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1421,7 +1482,8 @@ export namespace iap_v1beta1 { */ requestBody?: Schema$GetIamPolicyRequest; } - export interface Params$Resource$Projects$Iap_web$Setiampolicy { + export interface Params$Resource$Projects$Iap_web$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1438,7 +1500,8 @@ export namespace iap_v1beta1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Iap_web$Testiampermissions { + export interface Params$Resource$Projects$Iap_web$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1694,7 +1757,8 @@ export namespace iap_v1beta1 { } } - export interface Params$Resource$Projects$Iap_web$Services$Getiampolicy { + export interface Params$Resource$Projects$Iap_web$Services$Getiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1711,7 +1775,8 @@ export namespace iap_v1beta1 { */ requestBody?: Schema$GetIamPolicyRequest; } - export interface Params$Resource$Projects$Iap_web$Services$Setiampolicy { + export interface Params$Resource$Projects$Iap_web$Services$Setiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1728,7 +1793,8 @@ export namespace iap_v1beta1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Iap_web$Services$Testiampermissions { + export interface Params$Resource$Projects$Iap_web$Services$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1989,7 +2055,8 @@ export namespace iap_v1beta1 { } } - export interface Params$Resource$Projects$Iap_web$Services$Versions$Getiampolicy { + export interface Params$Resource$Projects$Iap_web$Services$Versions$Getiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2006,7 +2073,8 @@ export namespace iap_v1beta1 { */ requestBody?: Schema$GetIamPolicyRequest; } - export interface Params$Resource$Projects$Iap_web$Services$Versions$Setiampolicy { + export interface Params$Resource$Projects$Iap_web$Services$Versions$Setiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2023,7 +2091,8 @@ export namespace iap_v1beta1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Iap_web$Services$Versions$Testiampermissions { + export interface Params$Resource$Projects$Iap_web$Services$Versions$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/identitytoolkit/v3.ts b/src/apis/identitytoolkit/v3.ts index f5b088da8b..5e7c0720b1 100644 --- a/src/apis/identitytoolkit/v3.ts +++ b/src/apis/identitytoolkit/v3.ts @@ -29,6 +29,40 @@ export namespace identitytoolkit_v3 { version: 'v3'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Google Identity Toolkit API * @@ -3030,7 +3064,8 @@ export namespace identitytoolkit_v3 { } } - export interface Params$Resource$Relyingparty$Createauthuri { + export interface Params$Resource$Relyingparty$Createauthuri extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3042,7 +3077,8 @@ export namespace identitytoolkit_v3 { */ requestBody?: Schema$IdentitytoolkitRelyingpartyCreateAuthUriRequest; } - export interface Params$Resource$Relyingparty$Deleteaccount { + export interface Params$Resource$Relyingparty$Deleteaccount extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3054,7 +3090,8 @@ export namespace identitytoolkit_v3 { */ requestBody?: Schema$IdentitytoolkitRelyingpartyDeleteAccountRequest; } - export interface Params$Resource$Relyingparty$Downloadaccount { + export interface Params$Resource$Relyingparty$Downloadaccount extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3066,7 +3103,8 @@ export namespace identitytoolkit_v3 { */ requestBody?: Schema$IdentitytoolkitRelyingpartyDownloadAccountRequest; } - export interface Params$Resource$Relyingparty$Emaillinksignin { + export interface Params$Resource$Relyingparty$Emaillinksignin extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3078,7 +3116,8 @@ export namespace identitytoolkit_v3 { */ requestBody?: Schema$IdentitytoolkitRelyingpartyEmailLinkSigninRequest; } - export interface Params$Resource$Relyingparty$Getaccountinfo { + export interface Params$Resource$Relyingparty$Getaccountinfo extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3090,7 +3129,8 @@ export namespace identitytoolkit_v3 { */ requestBody?: Schema$IdentitytoolkitRelyingpartyGetAccountInfoRequest; } - export interface Params$Resource$Relyingparty$Getoobconfirmationcode { + export interface Params$Resource$Relyingparty$Getoobconfirmationcode extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3102,7 +3142,8 @@ export namespace identitytoolkit_v3 { */ requestBody?: Schema$Relyingparty; } - export interface Params$Resource$Relyingparty$Getprojectconfig { + export interface Params$Resource$Relyingparty$Getprojectconfig extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3117,19 +3158,22 @@ export namespace identitytoolkit_v3 { */ projectNumber?: string; } - export interface Params$Resource$Relyingparty$Getpublickeys { + export interface Params$Resource$Relyingparty$Getpublickeys extends + StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; } - export interface Params$Resource$Relyingparty$Getrecaptchaparam { + export interface Params$Resource$Relyingparty$Getrecaptchaparam extends + StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; } - export interface Params$Resource$Relyingparty$Resetpassword { + export interface Params$Resource$Relyingparty$Resetpassword extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3141,7 +3185,8 @@ export namespace identitytoolkit_v3 { */ requestBody?: Schema$IdentitytoolkitRelyingpartyResetPasswordRequest; } - export interface Params$Resource$Relyingparty$Sendverificationcode { + export interface Params$Resource$Relyingparty$Sendverificationcode extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3153,7 +3198,8 @@ export namespace identitytoolkit_v3 { */ requestBody?: Schema$IdentitytoolkitRelyingpartySendVerificationCodeRequest; } - export interface Params$Resource$Relyingparty$Setaccountinfo { + export interface Params$Resource$Relyingparty$Setaccountinfo extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3165,7 +3211,8 @@ export namespace identitytoolkit_v3 { */ requestBody?: Schema$IdentitytoolkitRelyingpartySetAccountInfoRequest; } - export interface Params$Resource$Relyingparty$Setprojectconfig { + export interface Params$Resource$Relyingparty$Setprojectconfig extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3177,7 +3224,8 @@ export namespace identitytoolkit_v3 { */ requestBody?: Schema$IdentitytoolkitRelyingpartySetProjectConfigRequest; } - export interface Params$Resource$Relyingparty$Signoutuser { + export interface Params$Resource$Relyingparty$Signoutuser extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3189,7 +3237,8 @@ export namespace identitytoolkit_v3 { */ requestBody?: Schema$IdentitytoolkitRelyingpartySignOutUserRequest; } - export interface Params$Resource$Relyingparty$Signupnewuser { + export interface Params$Resource$Relyingparty$Signupnewuser extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3201,7 +3250,8 @@ export namespace identitytoolkit_v3 { */ requestBody?: Schema$IdentitytoolkitRelyingpartySignupNewUserRequest; } - export interface Params$Resource$Relyingparty$Uploadaccount { + export interface Params$Resource$Relyingparty$Uploadaccount extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3213,7 +3263,8 @@ export namespace identitytoolkit_v3 { */ requestBody?: Schema$IdentitytoolkitRelyingpartyUploadAccountRequest; } - export interface Params$Resource$Relyingparty$Verifyassertion { + export interface Params$Resource$Relyingparty$Verifyassertion extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3225,7 +3276,8 @@ export namespace identitytoolkit_v3 { */ requestBody?: Schema$IdentitytoolkitRelyingpartyVerifyAssertionRequest; } - export interface Params$Resource$Relyingparty$Verifycustomtoken { + export interface Params$Resource$Relyingparty$Verifycustomtoken extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3237,7 +3289,8 @@ export namespace identitytoolkit_v3 { */ requestBody?: Schema$IdentitytoolkitRelyingpartyVerifyCustomTokenRequest; } - export interface Params$Resource$Relyingparty$Verifypassword { + export interface Params$Resource$Relyingparty$Verifypassword extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3249,7 +3302,8 @@ export namespace identitytoolkit_v3 { */ requestBody?: Schema$IdentitytoolkitRelyingpartyVerifyPasswordRequest; } - export interface Params$Resource$Relyingparty$Verifyphonenumber { + export interface Params$Resource$Relyingparty$Verifyphonenumber extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/index.ts b/src/apis/index.ts index 971681c6e0..dd478a3333 100644 --- a/src/apis/index.ts +++ b/src/apis/index.ts @@ -53,6 +53,7 @@ import * as cloudiot from './cloudiot'; import * as cloudkms from './cloudkms'; import * as cloudprofiler from './cloudprofiler'; import * as cloudresourcemanager from './cloudresourcemanager'; +import * as cloudsearch from './cloudsearch'; import * as cloudshell from './cloudshell'; import * as cloudtasks from './cloudtasks'; import * as cloudtrace from './cloudtrace'; @@ -127,7 +128,6 @@ import * as servicecontrol from './servicecontrol'; import * as servicemanagement from './servicemanagement'; import * as servicenetworking from './servicenetworking'; import * as serviceusage from './serviceusage'; -import * as serviceuser from './serviceuser'; import * as sheets from './sheets'; import * as siteVerification from './siteVerification'; import * as slides from './slides'; @@ -201,6 +201,7 @@ export const APIS: APIList = { cloudkms: cloudkms.VERSIONS, cloudprofiler: cloudprofiler.VERSIONS, cloudresourcemanager: cloudresourcemanager.VERSIONS, + cloudsearch: cloudsearch.VERSIONS, cloudshell: cloudshell.VERSIONS, cloudtasks: cloudtasks.VERSIONS, cloudtrace: cloudtrace.VERSIONS, @@ -275,7 +276,6 @@ export const APIS: APIList = { servicemanagement: servicemanagement.VERSIONS, servicenetworking: servicenetworking.VERSIONS, serviceusage: serviceusage.VERSIONS, - serviceuser: serviceuser.VERSIONS, sheets: sheets.VERSIONS, siteVerification: siteVerification.VERSIONS, slides: slides.VERSIONS, @@ -346,6 +346,7 @@ export class GeneratedAPIs { cloudkms = cloudkms.cloudkms; cloudprofiler = cloudprofiler.cloudprofiler; cloudresourcemanager = cloudresourcemanager.cloudresourcemanager; + cloudsearch = cloudsearch.cloudsearch; cloudshell = cloudshell.cloudshell; cloudtasks = cloudtasks.cloudtasks; cloudtrace = cloudtrace.cloudtrace; @@ -421,7 +422,6 @@ export class GeneratedAPIs { servicemanagement = servicemanagement.servicemanagement; servicenetworking = servicenetworking.servicenetworking; serviceusage = serviceusage.serviceusage; - serviceuser = serviceuser.serviceuser; sheets = sheets.sheets; siteVerification = siteVerification.siteVerification; slides = slides.slides; @@ -489,6 +489,7 @@ export class GeneratedAPIs { this.cloudkms = this.cloudkms.bind(this); this.cloudprofiler = this.cloudprofiler.bind(this); this.cloudresourcemanager = this.cloudresourcemanager.bind(this); + this.cloudsearch = this.cloudsearch.bind(this); this.cloudshell = this.cloudshell.bind(this); this.cloudtasks = this.cloudtasks.bind(this); this.cloudtrace = this.cloudtrace.bind(this); @@ -563,7 +564,6 @@ export class GeneratedAPIs { this.servicemanagement = this.servicemanagement.bind(this); this.servicenetworking = this.servicenetworking.bind(this); this.serviceusage = this.serviceusage.bind(this); - this.serviceuser = this.serviceuser.bind(this); this.sheets = this.sheets.bind(this); this.siteVerification = this.siteVerification.bind(this); this.slides = this.slides.bind(this); diff --git a/src/apis/indexing/README.md b/src/apis/indexing/README.md index 3de557c14b..428e686572 100644 --- a/src/apis/indexing/README.md +++ b/src/apis/indexing/README.md @@ -2,7 +2,7 @@ # @google/indexing -> The Indexing API allows developers to share the life cycle of a Web Document with Google. +> Notifies Google when your web pages change. ## Installation diff --git a/src/apis/indexing/v3.ts b/src/apis/indexing/v3.ts index 56c154a9fe..81c7ec2b07 100644 --- a/src/apis/indexing/v3.ts +++ b/src/apis/indexing/v3.ts @@ -29,11 +29,61 @@ export namespace indexing_v3 { version: 'v3'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Indexing API * - * The Indexing API allows developers to share the life cycle of a Web - * Document with Google. + * Notifies Google when your web pages change. * * @example * const {google} = require('googleapis'); @@ -274,7 +324,8 @@ export namespace indexing_v3 { } } - export interface Params$Resource$Urlnotifications$Getmetadata { + export interface Params$Resource$Urlnotifications$Getmetadata extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -285,7 +336,8 @@ export namespace indexing_v3 { */ url?: string; } - export interface Params$Resource$Urlnotifications$Publish { + export interface Params$Resource$Urlnotifications$Publish extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/jobs/v2.ts b/src/apis/jobs/v2.ts index 0abda5289f..28f36f4d6a 100644 --- a/src/apis/jobs/v2.ts +++ b/src/apis/jobs/v2.ts @@ -29,6 +29,57 @@ export namespace jobs_v2 { version: 'v2'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Talent Solution API * @@ -856,8 +907,8 @@ export namespace jobs_v2 { query?: Schema$JobQuery; /** * Meta information, such as `user_id`, collected from the job searcher or - * other entity conducting the job search, which is used to improve the - * search quality of the service. Users determine identifier values, which + * other entity conducting a job search, is used to improve the + * service's search quality. Users determine identifier values, which * must be unique and consist. */ requestMetadata?: Schema$RequestMetadata; @@ -1118,7 +1169,9 @@ export namespace jobs_v2 { expiryDate?: Schema$Date; /** * Deprecated. Always use compensation_info. Optional. Job compensation - * information. This field replaces compensation_info. + * information. This field replaces compensation_info. Only + * CompensationInfo.entries or extended_compensation_info can be set, + * otherwise an exception is thrown. */ extendedCompensationInfo?: Schema$ExtendedCompensationInfo; /** @@ -1318,8 +1371,8 @@ export namespace jobs_v2 { * EMPTY(<field_name>) to filter on the existence of a key. Boolean * expressions (AND/OR/NOT) are supported up to 3 levels of nesting (For * example, "((A AND B AND C) OR NOT D) AND E"), and there can be - * a maximum of 50 comparisons/functions in the expression. The expression - * must be < 3000 characters in length. Sample Query: (key1 = + * a maximum of 100 comparisons/functions in the expression. The expression + * must be < 3000 bytes in length. Sample Query: (key1 = * "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND * key2 > 100 */ @@ -2032,7 +2085,7 @@ export namespace jobs_v2 { query?: Schema$JobQuery; /** * Required. The meta information collected about the job searcher, used to - * improve the search quality of the service.. The identifiers, (such as + * improve the search quality of the service. The identifiers, (such as * `user_id`) are provided by users, and must be unique and consistent. */ requestMetadata?: Schema$RequestMetadata; @@ -2501,7 +2554,7 @@ export namespace jobs_v2 { } } - export interface Params$Resource$Companies$Create { + export interface Params$Resource$Companies$Create extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2513,7 +2566,7 @@ export namespace jobs_v2 { */ requestBody?: Schema$Company; } - export interface Params$Resource$Companies$Delete { + export interface Params$Resource$Companies$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2525,7 +2578,7 @@ export namespace jobs_v2 { */ name?: string; } - export interface Params$Resource$Companies$Get { + export interface Params$Resource$Companies$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2537,7 +2590,7 @@ export namespace jobs_v2 { */ name?: string; } - export interface Params$Resource$Companies$List { + export interface Params$Resource$Companies$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2559,7 +2612,7 @@ export namespace jobs_v2 { */ pageToken?: string; } - export interface Params$Resource$Companies$Patch { + export interface Params$Resource$Companies$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2674,7 +2727,8 @@ export namespace jobs_v2 { } } - export interface Params$Resource$Companies$Jobs$List { + export interface Params$Resource$Companies$Jobs$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3399,7 +3453,7 @@ export namespace jobs_v2 { } } - export interface Params$Resource$Jobs$Batchdelete { + export interface Params$Resource$Jobs$Batchdelete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3411,7 +3465,7 @@ export namespace jobs_v2 { */ requestBody?: Schema$BatchDeleteJobsRequest; } - export interface Params$Resource$Jobs$Create { + export interface Params$Resource$Jobs$Create extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3423,7 +3477,7 @@ export namespace jobs_v2 { */ requestBody?: Schema$CreateJobRequest; } - export interface Params$Resource$Jobs$Delete { + export interface Params$Resource$Jobs$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3442,7 +3496,8 @@ export namespace jobs_v2 { */ name?: string; } - export interface Params$Resource$Jobs$Deletebyfilter { + export interface Params$Resource$Jobs$Deletebyfilter extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3454,7 +3509,7 @@ export namespace jobs_v2 { */ requestBody?: Schema$DeleteJobsByFilterRequest; } - export interface Params$Resource$Jobs$Get { + export interface Params$Resource$Jobs$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3466,7 +3521,7 @@ export namespace jobs_v2 { */ name?: string; } - export interface Params$Resource$Jobs$Histogram { + export interface Params$Resource$Jobs$Histogram extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3478,7 +3533,7 @@ export namespace jobs_v2 { */ requestBody?: Schema$GetHistogramRequest; } - export interface Params$Resource$Jobs$List { + export interface Params$Resource$Jobs$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3510,7 +3565,7 @@ export namespace jobs_v2 { */ pageToken?: string; } - export interface Params$Resource$Jobs$Patch { + export interface Params$Resource$Jobs$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3528,7 +3583,7 @@ export namespace jobs_v2 { */ requestBody?: Schema$UpdateJobRequest; } - export interface Params$Resource$Jobs$Search { + export interface Params$Resource$Jobs$Search extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3540,7 +3595,8 @@ export namespace jobs_v2 { */ requestBody?: Schema$SearchJobsRequest; } - export interface Params$Resource$Jobs$Searchforalert { + export interface Params$Resource$Jobs$Searchforalert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3638,7 +3694,7 @@ export namespace jobs_v2 { } } - export interface Params$Resource$V2$Complete { + export interface Params$Resource$V2$Complete extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/jobs/v3.ts b/src/apis/jobs/v3.ts index 2d49a73ac5..e6ec50f883 100644 --- a/src/apis/jobs/v3.ts +++ b/src/apis/jobs/v3.ts @@ -29,6 +29,57 @@ export namespace jobs_v3 { version: 'v3'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Talent Solution API * @@ -906,8 +957,8 @@ export namespace jobs_v3 { * case insensitive match and `EMPTY([field_name])` to filter on the * existence of a key. Boolean expressions (AND/OR/NOT) are supported up to * 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) AND - * E"), a maximum of 50 comparisons or functions are allowed in the - * expression. The expression must be < 3000 characters in length. Sample + * E"), a maximum of 100 comparisons or functions are allowed in the + * expression. The expression must be < 3000 bytes in length. Sample * Query: `(LOWER(driving_license)="class \"a\"" OR * EMPTY(driving_license)) AND driving_years > 10` */ @@ -1046,7 +1097,7 @@ export namespace jobs_v3 { */ postalAddress?: Schema$PostalAddress; /** - * Radius in meters of the job location. This value is derived from the + * Radius in miles of the job location. This value is derived from the * location bounding box in which a circle with the specified radius * centered from LatLng coves the area associated with the job location. For * example, currently, "Mountain View, CA, USA" has a radius @@ -1658,7 +1709,8 @@ export namespace jobs_v3 { * * @param {object} params Parameters for request * @param {string=} params.companyName Optional. If provided, restricts completion to specified company. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". - * @param {string=} params.languageCode Required. The language of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with same language_code are returned. For CompletionType.COMBINED type, only open jobs with same language_code or companies having open jobs with same language_code are returned. The maximum number of allowed characters is 255. + * @param {string=} params.languageCode Deprecated. Use language_codes instead. Optional. The language of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with same language_code are returned. For CompletionType.COMBINED type, only open jobs with same language_code or companies having open jobs with same language_code are returned. The maximum number of allowed characters is 255. + * @param {string=} params.languageCodes Optional. The list of languages of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with same language_codes are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with same language_codes are returned. For CompletionType.COMBINED type, only open jobs with same language_codes or companies having open jobs with same language_codes are returned. The maximum number of allowed characters is 255. * @param {string} params.name Required. Resource name of project the completion is performed within. The format is "projects/{project_id}", for example, "projects/api-test-project". * @param {integer=} params.pageSize Required. Completion result count. The maximum allowed page size is 10. * @param {string=} params.query Required. The query used to generate suggestions. The maximum number of allowed characters is 255. @@ -1725,7 +1777,8 @@ export namespace jobs_v3 { } } - export interface Params$Resource$Projects$Complete { + export interface Params$Resource$Projects$Complete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1738,9 +1791,10 @@ export namespace jobs_v3 { */ companyName?: string; /** - * Required. The language of the query. This is the BCP-47 language code, - * such as "en-US" or "sr-Latn". For more information, see [Tags for - * Identifying Languages](https://tools.ietf.org/html/bcp47). For + * Deprecated. Use language_codes instead. Optional. The language of the + * query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". + * For more information, see [Tags for Identifying + * Languages](https://tools.ietf.org/html/bcp47). For * CompletionType.JOB_TITLE type, only open jobs with same language_code are * returned. For CompletionType.COMPANY_NAME type, only companies having * open jobs with same language_code are returned. For @@ -1749,6 +1803,18 @@ export namespace jobs_v3 { * maximum number of allowed characters is 255. */ languageCode?: string; + /** + * Optional. The list of languages of the query. This is the BCP-47 + * language code, such as "en-US" or "sr-Latn". For more information, see + * [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). For + * CompletionType.JOB_TITLE type, only open jobs with same language_codes + * are returned. For CompletionType.COMPANY_NAME type, only companies + * having open jobs with same language_codes are returned. For + * CompletionType.COMBINED type, only open jobs with same language_codes or + * companies having open jobs with same language_codes are returned. The + * maximum number of allowed characters is 255. + */ + languageCodes?: string; /** * Required. Resource name of project the completion is performed within. * The format is "projects/{project_id}", for example, @@ -1856,7 +1922,8 @@ export namespace jobs_v3 { /** * jobs.projects.companies.delete - * @desc Deletes specified company. + * @desc Deletes specified company. Prerequisite: The company has no jobs + * associated with it. * @alias jobs.projects.companies.delete * @memberOf! () * @@ -2119,7 +2186,8 @@ export namespace jobs_v3 { } } - export interface Params$Resource$Projects$Companies$Create { + export interface Params$Resource$Projects$Companies$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2137,7 +2205,8 @@ export namespace jobs_v3 { */ requestBody?: Schema$CreateCompanyRequest; } - export interface Params$Resource$Projects$Companies$Delete { + export interface Params$Resource$Projects$Companies$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2150,7 +2219,8 @@ export namespace jobs_v3 { */ name?: string; } - export interface Params$Resource$Projects$Companies$Get { + export interface Params$Resource$Projects$Companies$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2163,7 +2233,8 @@ export namespace jobs_v3 { */ name?: string; } - export interface Params$Resource$Projects$Companies$List { + export interface Params$Resource$Projects$Companies$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2191,7 +2262,8 @@ export namespace jobs_v3 { */ requireOpenJobs?: boolean; } - export interface Params$Resource$Projects$Companies$Patch { + export interface Params$Resource$Projects$Companies$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2769,7 +2841,8 @@ export namespace jobs_v3 { } } - export interface Params$Resource$Projects$Jobs$Batchdelete { + export interface Params$Resource$Projects$Jobs$Batchdelete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2787,7 +2860,8 @@ export namespace jobs_v3 { */ requestBody?: Schema$BatchDeleteJobsRequest; } - export interface Params$Resource$Projects$Jobs$Create { + export interface Params$Resource$Projects$Jobs$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2805,7 +2879,8 @@ export namespace jobs_v3 { */ requestBody?: Schema$CreateJobRequest; } - export interface Params$Resource$Projects$Jobs$Delete { + export interface Params$Resource$Projects$Jobs$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2818,7 +2893,8 @@ export namespace jobs_v3 { */ name?: string; } - export interface Params$Resource$Projects$Jobs$Get { + export interface Params$Resource$Projects$Jobs$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2831,7 +2907,8 @@ export namespace jobs_v3 { */ name?: string; } - export interface Params$Resource$Projects$Jobs$List { + export interface Params$Resource$Projects$Jobs$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2868,7 +2945,8 @@ export namespace jobs_v3 { */ parent?: string; } - export interface Params$Resource$Projects$Jobs$Patch { + export interface Params$Resource$Projects$Jobs$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2889,7 +2967,8 @@ export namespace jobs_v3 { */ requestBody?: Schema$UpdateJobRequest; } - export interface Params$Resource$Projects$Jobs$Search { + export interface Params$Resource$Projects$Jobs$Search extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2906,7 +2985,8 @@ export namespace jobs_v3 { */ requestBody?: Schema$SearchJobsRequest; } - export interface Params$Resource$Projects$Jobs$Searchforalert { + export interface Params$Resource$Projects$Jobs$Searchforalert extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/jobs/v3p1beta1.ts b/src/apis/jobs/v3p1beta1.ts index b0c363c2b2..bd31cbc7a1 100644 --- a/src/apis/jobs/v3p1beta1.ts +++ b/src/apis/jobs/v3p1beta1.ts @@ -29,6 +29,57 @@ export namespace jobs_v3p1beta1 { version: 'v3p1beta1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Talent Solution API * @@ -1098,8 +1149,8 @@ export namespace jobs_v3p1beta1 { * case insensitive match and `EMPTY([field_name])` to filter on the * existence of a key. Boolean expressions (AND/OR/NOT) are supported up to * 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) AND - * E"), a maximum of 50 comparisons or functions are allowed in the - * expression. The expression must be < 3000 characters in length. Sample + * E"), a maximum of 100 comparisons or functions are allowed in the + * expression. The expression must be < 3000 bytes in length. Sample * Query: `(LOWER(driving_license)="class \"a\"" OR * EMPTY(driving_license)) AND driving_years > 10` */ @@ -1243,7 +1294,7 @@ export namespace jobs_v3p1beta1 { */ postalAddress?: Schema$PostalAddress; /** - * Radius in meters of the job location. This value is derived from the + * Radius in miles of the job location. This value is derived from the * location bounding box in which a circle with the specified radius * centered from LatLng coves the area associated with the job location. For * example, currently, "Mountain View, CA, USA" has a radius @@ -1886,7 +1937,8 @@ export namespace jobs_v3p1beta1 { * * @param {object} params Parameters for request * @param {string=} params.companyName Optional. If provided, restricts completion to specified company. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". - * @param {string=} params.languageCode Required. The language of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with same language_code are returned. For CompletionType.COMBINED type, only open jobs with same language_code or companies having open jobs with same language_code are returned. The maximum number of allowed characters is 255. + * @param {string=} params.languageCode Deprecated. Use language_codes instead. Optional. The language of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with same language_code are returned. For CompletionType.COMBINED type, only open jobs with same language_code or companies having open jobs with same language_code are returned. The maximum number of allowed characters is 255. + * @param {string=} params.languageCodes Optional. The list of languages of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with same language_codes are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with same language_codes are returned. For CompletionType.COMBINED type, only open jobs with same language_codes or companies having open jobs with same language_codes are returned. The maximum number of allowed characters is 255. * @param {string} params.name Required. Resource name of project the completion is performed within. The format is "projects/{project_id}", for example, "projects/api-test-project". * @param {integer=} params.pageSize Required. Completion result count. The maximum allowed page size is 10. * @param {string=} params.query Required. The query used to generate suggestions. The maximum number of allowed characters is 255. @@ -1953,7 +2005,8 @@ export namespace jobs_v3p1beta1 { } } - export interface Params$Resource$Projects$Complete { + export interface Params$Resource$Projects$Complete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1966,9 +2019,10 @@ export namespace jobs_v3p1beta1 { */ companyName?: string; /** - * Required. The language of the query. This is the BCP-47 language code, - * such as "en-US" or "sr-Latn". For more information, see [Tags for - * Identifying Languages](https://tools.ietf.org/html/bcp47). For + * Deprecated. Use language_codes instead. Optional. The language of the + * query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". + * For more information, see [Tags for Identifying + * Languages](https://tools.ietf.org/html/bcp47). For * CompletionType.JOB_TITLE type, only open jobs with same language_code are * returned. For CompletionType.COMPANY_NAME type, only companies having * open jobs with same language_code are returned. For @@ -1977,6 +2031,18 @@ export namespace jobs_v3p1beta1 { * maximum number of allowed characters is 255. */ languageCode?: string; + /** + * Optional. The list of languages of the query. This is the BCP-47 + * language code, such as "en-US" or "sr-Latn". For more information, see + * [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). For + * CompletionType.JOB_TITLE type, only open jobs with same language_codes + * are returned. For CompletionType.COMPANY_NAME type, only companies + * having open jobs with same language_codes are returned. For + * CompletionType.COMBINED type, only open jobs with same language_codes or + * companies having open jobs with same language_codes are returned. The + * maximum number of allowed characters is 255. + */ + languageCodes?: string; /** * Required. Resource name of project the completion is performed within. * The format is "projects/{project_id}", for example, @@ -2088,7 +2154,8 @@ export namespace jobs_v3p1beta1 { } } - export interface Params$Resource$Projects$Clientevents$Create { + export interface Params$Resource$Projects$Clientevents$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2187,7 +2254,8 @@ export namespace jobs_v3p1beta1 { /** * jobs.projects.companies.delete - * @desc Deletes specified company. + * @desc Deletes specified company. Prerequisite: The company has no jobs + * associated with it. * @alias jobs.projects.companies.delete * @memberOf! () * @@ -2453,7 +2521,8 @@ export namespace jobs_v3p1beta1 { } } - export interface Params$Resource$Projects$Companies$Create { + export interface Params$Resource$Projects$Companies$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2471,7 +2540,8 @@ export namespace jobs_v3p1beta1 { */ requestBody?: Schema$CreateCompanyRequest; } - export interface Params$Resource$Projects$Companies$Delete { + export interface Params$Resource$Projects$Companies$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2484,7 +2554,8 @@ export namespace jobs_v3p1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Companies$Get { + export interface Params$Resource$Projects$Companies$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2497,7 +2568,8 @@ export namespace jobs_v3p1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Companies$List { + export interface Params$Resource$Projects$Companies$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2525,7 +2597,8 @@ export namespace jobs_v3p1beta1 { */ requireOpenJobs?: boolean; } - export interface Params$Resource$Projects$Companies$Patch { + export interface Params$Resource$Projects$Companies$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3106,7 +3179,8 @@ export namespace jobs_v3p1beta1 { } } - export interface Params$Resource$Projects$Jobs$Batchdelete { + export interface Params$Resource$Projects$Jobs$Batchdelete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3124,7 +3198,8 @@ export namespace jobs_v3p1beta1 { */ requestBody?: Schema$BatchDeleteJobsRequest; } - export interface Params$Resource$Projects$Jobs$Create { + export interface Params$Resource$Projects$Jobs$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3142,7 +3217,8 @@ export namespace jobs_v3p1beta1 { */ requestBody?: Schema$CreateJobRequest; } - export interface Params$Resource$Projects$Jobs$Delete { + export interface Params$Resource$Projects$Jobs$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3155,7 +3231,8 @@ export namespace jobs_v3p1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Jobs$Get { + export interface Params$Resource$Projects$Jobs$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3168,7 +3245,8 @@ export namespace jobs_v3p1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Jobs$List { + export interface Params$Resource$Projects$Jobs$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3205,7 +3283,8 @@ export namespace jobs_v3p1beta1 { */ parent?: string; } - export interface Params$Resource$Projects$Jobs$Patch { + export interface Params$Resource$Projects$Jobs$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3226,7 +3305,8 @@ export namespace jobs_v3p1beta1 { */ requestBody?: Schema$UpdateJobRequest; } - export interface Params$Resource$Projects$Jobs$Search { + export interface Params$Resource$Projects$Jobs$Search extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3243,7 +3323,8 @@ export namespace jobs_v3p1beta1 { */ requestBody?: Schema$SearchJobsRequest; } - export interface Params$Resource$Projects$Jobs$Searchforalert { + export interface Params$Resource$Projects$Jobs$Searchforalert extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/kgsearch/v1.ts b/src/apis/kgsearch/v1.ts index 40c5a6e0ba..3f7b29819f 100644 --- a/src/apis/kgsearch/v1.ts +++ b/src/apis/kgsearch/v1.ts @@ -29,6 +29,57 @@ export namespace kgsearch_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Knowledge Graph Search API * @@ -170,7 +221,7 @@ export namespace kgsearch_v1 { } } - export interface Params$Resource$Entities$Search { + export interface Params$Resource$Entities$Search extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/language/README.md b/src/apis/language/README.md index 120d8e25f2..3b63beab6f 100644 --- a/src/apis/language/README.md +++ b/src/apis/language/README.md @@ -2,7 +2,7 @@ # @google/language -> Provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, entity sentiment analysis, and text annotations. +> Provides natural language understanding technologies, such as sentiment analysis, entity recognition, entity sentiment analysis, and other text annotations, to developers. ## Installation diff --git a/src/apis/language/v1.ts b/src/apis/language/v1.ts index 616dd1ecd1..ab4c7435f4 100644 --- a/src/apis/language/v1.ts +++ b/src/apis/language/v1.ts @@ -29,12 +29,63 @@ export namespace language_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Natural Language API * - * Provides natural language understanding technologies to developers. - * Examples include sentiment analysis, entity recognition, entity sentiment - * analysis, and text annotations. + * Provides natural language understanding technologies, such as sentiment + * analysis, entity recognition, entity sentiment analysis, and other text + * annotations, to developers. * * @example * const {google} = require('googleapis'); @@ -1028,7 +1079,8 @@ export namespace language_v1 { } } - export interface Params$Resource$Documents$Analyzeentities { + export interface Params$Resource$Documents$Analyzeentities extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1040,7 +1092,8 @@ export namespace language_v1 { */ requestBody?: Schema$AnalyzeEntitiesRequest; } - export interface Params$Resource$Documents$Analyzeentitysentiment { + export interface Params$Resource$Documents$Analyzeentitysentiment extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1052,7 +1105,8 @@ export namespace language_v1 { */ requestBody?: Schema$AnalyzeEntitySentimentRequest; } - export interface Params$Resource$Documents$Analyzesentiment { + export interface Params$Resource$Documents$Analyzesentiment extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1064,7 +1118,8 @@ export namespace language_v1 { */ requestBody?: Schema$AnalyzeSentimentRequest; } - export interface Params$Resource$Documents$Analyzesyntax { + export interface Params$Resource$Documents$Analyzesyntax extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1076,7 +1131,8 @@ export namespace language_v1 { */ requestBody?: Schema$AnalyzeSyntaxRequest; } - export interface Params$Resource$Documents$Annotatetext { + export interface Params$Resource$Documents$Annotatetext extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1088,7 +1144,8 @@ export namespace language_v1 { */ requestBody?: Schema$AnnotateTextRequest; } - export interface Params$Resource$Documents$Classifytext { + export interface Params$Resource$Documents$Classifytext extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/language/v1beta1.ts b/src/apis/language/v1beta1.ts index e05d240460..009ebf76db 100644 --- a/src/apis/language/v1beta1.ts +++ b/src/apis/language/v1beta1.ts @@ -29,12 +29,63 @@ export namespace language_v1beta1 { version: 'v1beta1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Natural Language API * - * Provides natural language understanding technologies to developers. - * Examples include sentiment analysis, entity recognition, entity sentiment - * analysis, and text annotations. + * Provides natural language understanding technologies, such as sentiment + * analysis, entity recognition, entity sentiment analysis, and other text + * annotations, to developers. * * @example * const {google} = require('googleapis'); @@ -800,7 +851,8 @@ export namespace language_v1beta1 { } } - export interface Params$Resource$Documents$Analyzeentities { + export interface Params$Resource$Documents$Analyzeentities extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -812,7 +864,8 @@ export namespace language_v1beta1 { */ requestBody?: Schema$AnalyzeEntitiesRequest; } - export interface Params$Resource$Documents$Analyzesentiment { + export interface Params$Resource$Documents$Analyzesentiment extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -824,7 +877,8 @@ export namespace language_v1beta1 { */ requestBody?: Schema$AnalyzeSentimentRequest; } - export interface Params$Resource$Documents$Analyzesyntax { + export interface Params$Resource$Documents$Analyzesyntax extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -836,7 +890,8 @@ export namespace language_v1beta1 { */ requestBody?: Schema$AnalyzeSyntaxRequest; } - export interface Params$Resource$Documents$Annotatetext { + export interface Params$Resource$Documents$Annotatetext extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/language/v1beta2.ts b/src/apis/language/v1beta2.ts index a19b47e83c..1765de49c5 100644 --- a/src/apis/language/v1beta2.ts +++ b/src/apis/language/v1beta2.ts @@ -29,12 +29,63 @@ export namespace language_v1beta2 { version: 'v1beta2'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Natural Language API * - * Provides natural language understanding technologies to developers. - * Examples include sentiment analysis, entity recognition, entity sentiment - * analysis, and text annotations. + * Provides natural language understanding technologies, such as sentiment + * analysis, entity recognition, entity sentiment analysis, and other text + * annotations, to developers. * * @example * const {google} = require('googleapis'); @@ -1029,7 +1080,8 @@ export namespace language_v1beta2 { } } - export interface Params$Resource$Documents$Analyzeentities { + export interface Params$Resource$Documents$Analyzeentities extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1041,7 +1093,8 @@ export namespace language_v1beta2 { */ requestBody?: Schema$AnalyzeEntitiesRequest; } - export interface Params$Resource$Documents$Analyzeentitysentiment { + export interface Params$Resource$Documents$Analyzeentitysentiment extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1053,7 +1106,8 @@ export namespace language_v1beta2 { */ requestBody?: Schema$AnalyzeEntitySentimentRequest; } - export interface Params$Resource$Documents$Analyzesentiment { + export interface Params$Resource$Documents$Analyzesentiment extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1065,7 +1119,8 @@ export namespace language_v1beta2 { */ requestBody?: Schema$AnalyzeSentimentRequest; } - export interface Params$Resource$Documents$Analyzesyntax { + export interface Params$Resource$Documents$Analyzesyntax extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1077,7 +1132,8 @@ export namespace language_v1beta2 { */ requestBody?: Schema$AnalyzeSyntaxRequest; } - export interface Params$Resource$Documents$Annotatetext { + export interface Params$Resource$Documents$Annotatetext extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1089,7 +1145,8 @@ export namespace language_v1beta2 { */ requestBody?: Schema$AnnotateTextRequest; } - export interface Params$Resource$Documents$Classifytext { + export interface Params$Resource$Documents$Classifytext extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/licensing/v1.ts b/src/apis/licensing/v1.ts index 601c1867a1..34e89d0210 100644 --- a/src/apis/licensing/v1.ts +++ b/src/apis/licensing/v1.ts @@ -29,6 +29,40 @@ export namespace licensing_v1 { version: 'v1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Enterprise License Manager API * @@ -643,7 +677,8 @@ export namespace licensing_v1 { } } - export interface Params$Resource$Licenseassignments$Delete { + export interface Params$Resource$Licenseassignments$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -662,7 +697,8 @@ export namespace licensing_v1 { */ userId?: string; } - export interface Params$Resource$Licenseassignments$Get { + export interface Params$Resource$Licenseassignments$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -681,7 +717,8 @@ export namespace licensing_v1 { */ userId?: string; } - export interface Params$Resource$Licenseassignments$Insert { + export interface Params$Resource$Licenseassignments$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -701,7 +738,8 @@ export namespace licensing_v1 { */ requestBody?: Schema$LicenseAssignmentInsert; } - export interface Params$Resource$Licenseassignments$Listforproduct { + export interface Params$Resource$Licenseassignments$Listforproduct extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -727,7 +765,8 @@ export namespace licensing_v1 { */ productId?: string; } - export interface Params$Resource$Licenseassignments$Listforproductandsku { + export interface Params$Resource$Licenseassignments$Listforproductandsku + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -757,7 +796,8 @@ export namespace licensing_v1 { */ skuId?: string; } - export interface Params$Resource$Licenseassignments$Patch { + export interface Params$Resource$Licenseassignments$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -781,7 +821,8 @@ export namespace licensing_v1 { */ requestBody?: Schema$LicenseAssignment; } - export interface Params$Resource$Licenseassignments$Update { + export interface Params$Resource$Licenseassignments$Update extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/logging/v2.ts b/src/apis/logging/v2.ts index 14d1498e8e..803e3b5f81 100644 --- a/src/apis/logging/v2.ts +++ b/src/apis/logging/v2.ts @@ -29,6 +29,57 @@ export namespace logging_v2 { version: 'v2'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Stackdriver Logging API * @@ -681,6 +732,7 @@ export namespace logging_v2 { bucketOptions?: Schema$BucketOptions; /** * Optional. A description of this metric, which is used in documentation. + * The maximum length of the description is 8000 characters. */ description?: string; /** @@ -777,10 +829,6 @@ export namespace logging_v2 { * exported. For more information, see Exporting Logs With Sinks. */ destination?: string; - /** - * Deprecated. This field is ignored when creating or updating sinks. - */ - endTime?: string; /** * Optional. An advanced logs filter. The only exported log entries are * those that are in the resource owning the sink and that match the filter. @@ -817,10 +865,6 @@ export namespace logging_v2 { * entries. The v2 format is used by default and cannot be changed. */ outputVersionFormat?: string; - /** - * Deprecated. This field is ignored when creating or updating sinks. - */ - startTime?: string; /** * Output only. An IAM identity&mdash;a service account or * group&mdash;under which Logging writes the exported log entries to @@ -1671,7 +1715,8 @@ export namespace logging_v2 { } } - export interface Params$Resource$Billingaccounts$Exclusions$Create { + export interface Params$Resource$Billingaccounts$Exclusions$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1690,7 +1735,8 @@ export namespace logging_v2 { */ requestBody?: Schema$LogExclusion; } - export interface Params$Resource$Billingaccounts$Exclusions$Delete { + export interface Params$Resource$Billingaccounts$Exclusions$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1706,7 +1752,8 @@ export namespace logging_v2 { */ name?: string; } - export interface Params$Resource$Billingaccounts$Exclusions$Get { + export interface Params$Resource$Billingaccounts$Exclusions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1722,7 +1769,8 @@ export namespace logging_v2 { */ name?: string; } - export interface Params$Resource$Billingaccounts$Exclusions$List { + export interface Params$Resource$Billingaccounts$Exclusions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1748,7 +1796,8 @@ export namespace logging_v2 { */ parent?: string; } - export interface Params$Resource$Billingaccounts$Exclusions$Patch { + export interface Params$Resource$Billingaccounts$Exclusions$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1929,7 +1978,8 @@ export namespace logging_v2 { } } - export interface Params$Resource$Billingaccounts$Logs$Delete { + export interface Params$Resource$Billingaccounts$Logs$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1947,7 +1997,8 @@ export namespace logging_v2 { */ logName?: string; } - export interface Params$Resource$Billingaccounts$Logs$List { + export interface Params$Resource$Billingaccounts$Logs$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2396,7 +2447,8 @@ export namespace logging_v2 { } } - export interface Params$Resource$Billingaccounts$Sinks$Create { + export interface Params$Resource$Billingaccounts$Sinks$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2428,7 +2480,8 @@ export namespace logging_v2 { */ requestBody?: Schema$LogSink; } - export interface Params$Resource$Billingaccounts$Sinks$Delete { + export interface Params$Resource$Billingaccounts$Sinks$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2445,7 +2498,8 @@ export namespace logging_v2 { */ sinkName?: string; } - export interface Params$Resource$Billingaccounts$Sinks$Get { + export interface Params$Resource$Billingaccounts$Sinks$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2461,7 +2515,8 @@ export namespace logging_v2 { */ sinkName?: string; } - export interface Params$Resource$Billingaccounts$Sinks$List { + export interface Params$Resource$Billingaccounts$Sinks$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2487,7 +2542,8 @@ export namespace logging_v2 { */ parent?: string; } - export interface Params$Resource$Billingaccounts$Sinks$Patch { + export interface Params$Resource$Billingaccounts$Sinks$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2533,7 +2589,8 @@ export namespace logging_v2 { */ requestBody?: Schema$LogSink; } - export interface Params$Resource$Billingaccounts$Sinks$Update { + export interface Params$Resource$Billingaccounts$Sinks$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2731,7 +2788,7 @@ export namespace logging_v2 { } } - export interface Params$Resource$Entries$List { + export interface Params$Resource$Entries$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2743,7 +2800,7 @@ export namespace logging_v2 { */ requestBody?: Schema$ListLogEntriesRequest; } - export interface Params$Resource$Entries$Write { + export interface Params$Resource$Entries$Write extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3097,7 +3154,8 @@ export namespace logging_v2 { } } - export interface Params$Resource$Exclusions$Create { + export interface Params$Resource$Exclusions$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3116,7 +3174,8 @@ export namespace logging_v2 { */ requestBody?: Schema$LogExclusion; } - export interface Params$Resource$Exclusions$Delete { + export interface Params$Resource$Exclusions$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3132,7 +3191,7 @@ export namespace logging_v2 { */ name?: string; } - export interface Params$Resource$Exclusions$Get { + export interface Params$Resource$Exclusions$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3148,7 +3207,7 @@ export namespace logging_v2 { */ name?: string; } - export interface Params$Resource$Exclusions$List { + export interface Params$Resource$Exclusions$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3174,7 +3233,7 @@ export namespace logging_v2 { */ parent?: string; } - export interface Params$Resource$Exclusions$Patch { + export interface Params$Resource$Exclusions$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3572,7 +3631,8 @@ export namespace logging_v2 { } } - export interface Params$Resource$Folders$Exclusions$Create { + export interface Params$Resource$Folders$Exclusions$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3591,7 +3651,8 @@ export namespace logging_v2 { */ requestBody?: Schema$LogExclusion; } - export interface Params$Resource$Folders$Exclusions$Delete { + export interface Params$Resource$Folders$Exclusions$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3607,7 +3668,8 @@ export namespace logging_v2 { */ name?: string; } - export interface Params$Resource$Folders$Exclusions$Get { + export interface Params$Resource$Folders$Exclusions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3623,7 +3685,8 @@ export namespace logging_v2 { */ name?: string; } - export interface Params$Resource$Folders$Exclusions$List { + export interface Params$Resource$Folders$Exclusions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3649,7 +3712,8 @@ export namespace logging_v2 { */ parent?: string; } - export interface Params$Resource$Folders$Exclusions$Patch { + export interface Params$Resource$Folders$Exclusions$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3829,7 +3893,8 @@ export namespace logging_v2 { } } - export interface Params$Resource$Folders$Logs$Delete { + export interface Params$Resource$Folders$Logs$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3847,7 +3912,8 @@ export namespace logging_v2 { */ logName?: string; } - export interface Params$Resource$Folders$Logs$List { + export interface Params$Resource$Folders$Logs$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4295,7 +4361,8 @@ export namespace logging_v2 { } } - export interface Params$Resource$Folders$Sinks$Create { + export interface Params$Resource$Folders$Sinks$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4327,7 +4394,8 @@ export namespace logging_v2 { */ requestBody?: Schema$LogSink; } - export interface Params$Resource$Folders$Sinks$Delete { + export interface Params$Resource$Folders$Sinks$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4344,7 +4412,8 @@ export namespace logging_v2 { */ sinkName?: string; } - export interface Params$Resource$Folders$Sinks$Get { + export interface Params$Resource$Folders$Sinks$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4360,7 +4429,8 @@ export namespace logging_v2 { */ sinkName?: string; } - export interface Params$Resource$Folders$Sinks$List { + export interface Params$Resource$Folders$Sinks$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4386,7 +4456,8 @@ export namespace logging_v2 { */ parent?: string; } - export interface Params$Resource$Folders$Sinks$Patch { + export interface Params$Resource$Folders$Sinks$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4432,7 +4503,8 @@ export namespace logging_v2 { */ requestBody?: Schema$LogSink; } - export interface Params$Resource$Folders$Sinks$Update { + export interface Params$Resource$Folders$Sinks$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4626,7 +4698,7 @@ export namespace logging_v2 { } } - export interface Params$Resource$Logs$Delete { + export interface Params$Resource$Logs$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4644,7 +4716,7 @@ export namespace logging_v2 { */ logName?: string; } - export interface Params$Resource$Logs$List { + export interface Params$Resource$Logs$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4760,7 +4832,8 @@ export namespace logging_v2 { } } - export interface Params$Resource$Monitoredresourcedescriptors$List { + export interface Params$Resource$Monitoredresourcedescriptors$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5148,7 +5221,8 @@ export namespace logging_v2 { } } - export interface Params$Resource$Organizations$Exclusions$Create { + export interface Params$Resource$Organizations$Exclusions$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5167,7 +5241,8 @@ export namespace logging_v2 { */ requestBody?: Schema$LogExclusion; } - export interface Params$Resource$Organizations$Exclusions$Delete { + export interface Params$Resource$Organizations$Exclusions$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5183,7 +5258,8 @@ export namespace logging_v2 { */ name?: string; } - export interface Params$Resource$Organizations$Exclusions$Get { + export interface Params$Resource$Organizations$Exclusions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5199,7 +5275,8 @@ export namespace logging_v2 { */ name?: string; } - export interface Params$Resource$Organizations$Exclusions$List { + export interface Params$Resource$Organizations$Exclusions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5225,7 +5302,8 @@ export namespace logging_v2 { */ parent?: string; } - export interface Params$Resource$Organizations$Exclusions$Patch { + export interface Params$Resource$Organizations$Exclusions$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5406,7 +5484,8 @@ export namespace logging_v2 { } } - export interface Params$Resource$Organizations$Logs$Delete { + export interface Params$Resource$Organizations$Logs$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5424,7 +5503,8 @@ export namespace logging_v2 { */ logName?: string; } - export interface Params$Resource$Organizations$Logs$List { + export interface Params$Resource$Organizations$Logs$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5873,7 +5953,8 @@ export namespace logging_v2 { } } - export interface Params$Resource$Organizations$Sinks$Create { + export interface Params$Resource$Organizations$Sinks$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5905,7 +5986,8 @@ export namespace logging_v2 { */ requestBody?: Schema$LogSink; } - export interface Params$Resource$Organizations$Sinks$Delete { + export interface Params$Resource$Organizations$Sinks$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5922,7 +6004,8 @@ export namespace logging_v2 { */ sinkName?: string; } - export interface Params$Resource$Organizations$Sinks$Get { + export interface Params$Resource$Organizations$Sinks$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5938,7 +6021,8 @@ export namespace logging_v2 { */ sinkName?: string; } - export interface Params$Resource$Organizations$Sinks$List { + export interface Params$Resource$Organizations$Sinks$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5964,7 +6048,8 @@ export namespace logging_v2 { */ parent?: string; } - export interface Params$Resource$Organizations$Sinks$Patch { + export interface Params$Resource$Organizations$Sinks$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6010,7 +6095,8 @@ export namespace logging_v2 { */ requestBody?: Schema$LogSink; } - export interface Params$Resource$Organizations$Sinks$Update { + export interface Params$Resource$Organizations$Sinks$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6427,7 +6513,8 @@ export namespace logging_v2 { } } - export interface Params$Resource$Projects$Exclusions$Create { + export interface Params$Resource$Projects$Exclusions$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6446,7 +6533,8 @@ export namespace logging_v2 { */ requestBody?: Schema$LogExclusion; } - export interface Params$Resource$Projects$Exclusions$Delete { + export interface Params$Resource$Projects$Exclusions$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6462,7 +6550,8 @@ export namespace logging_v2 { */ name?: string; } - export interface Params$Resource$Projects$Exclusions$Get { + export interface Params$Resource$Projects$Exclusions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6478,7 +6567,8 @@ export namespace logging_v2 { */ name?: string; } - export interface Params$Resource$Projects$Exclusions$List { + export interface Params$Resource$Projects$Exclusions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6504,7 +6594,8 @@ export namespace logging_v2 { */ parent?: string; } - export interface Params$Resource$Projects$Exclusions$Patch { + export interface Params$Resource$Projects$Exclusions$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6684,7 +6775,8 @@ export namespace logging_v2 { } } - export interface Params$Resource$Projects$Logs$Delete { + export interface Params$Resource$Projects$Logs$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6702,7 +6794,8 @@ export namespace logging_v2 { */ logName?: string; } - export interface Params$Resource$Projects$Logs$List { + export interface Params$Resource$Projects$Logs$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7077,7 +7170,8 @@ export namespace logging_v2 { } } - export interface Params$Resource$Projects$Metrics$Create { + export interface Params$Resource$Projects$Metrics$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7094,7 +7188,8 @@ export namespace logging_v2 { */ requestBody?: Schema$LogMetric; } - export interface Params$Resource$Projects$Metrics$Delete { + export interface Params$Resource$Projects$Metrics$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7106,7 +7201,8 @@ export namespace logging_v2 { */ metricName?: string; } - export interface Params$Resource$Projects$Metrics$Get { + export interface Params$Resource$Projects$Metrics$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7118,7 +7214,8 @@ export namespace logging_v2 { */ metricName?: string; } - export interface Params$Resource$Projects$Metrics$List { + export interface Params$Resource$Projects$Metrics$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7143,7 +7240,8 @@ export namespace logging_v2 { */ parent?: string; } - export interface Params$Resource$Projects$Metrics$Update { + export interface Params$Resource$Projects$Metrics$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7585,7 +7683,8 @@ export namespace logging_v2 { } } - export interface Params$Resource$Projects$Sinks$Create { + export interface Params$Resource$Projects$Sinks$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7617,7 +7716,8 @@ export namespace logging_v2 { */ requestBody?: Schema$LogSink; } - export interface Params$Resource$Projects$Sinks$Delete { + export interface Params$Resource$Projects$Sinks$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7634,7 +7734,8 @@ export namespace logging_v2 { */ sinkName?: string; } - export interface Params$Resource$Projects$Sinks$Get { + export interface Params$Resource$Projects$Sinks$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7650,7 +7751,8 @@ export namespace logging_v2 { */ sinkName?: string; } - export interface Params$Resource$Projects$Sinks$List { + export interface Params$Resource$Projects$Sinks$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7676,7 +7778,8 @@ export namespace logging_v2 { */ parent?: string; } - export interface Params$Resource$Projects$Sinks$Patch { + export interface Params$Resource$Projects$Sinks$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7722,7 +7825,8 @@ export namespace logging_v2 { */ requestBody?: Schema$LogSink; } - export interface Params$Resource$Projects$Sinks$Update { + export interface Params$Resource$Projects$Sinks$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8112,7 +8216,7 @@ export namespace logging_v2 { } } - export interface Params$Resource$Sinks$Create { + export interface Params$Resource$Sinks$Create extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8144,7 +8248,7 @@ export namespace logging_v2 { */ requestBody?: Schema$LogSink; } - export interface Params$Resource$Sinks$Delete { + export interface Params$Resource$Sinks$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8161,7 +8265,7 @@ export namespace logging_v2 { */ sinkName?: string; } - export interface Params$Resource$Sinks$Get { + export interface Params$Resource$Sinks$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8177,7 +8281,7 @@ export namespace logging_v2 { */ sinkName?: string; } - export interface Params$Resource$Sinks$List { + export interface Params$Resource$Sinks$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8203,7 +8307,7 @@ export namespace logging_v2 { */ parent?: string; } - export interface Params$Resource$Sinks$Update { + export interface Params$Resource$Sinks$Update extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/logging/v2beta1.ts b/src/apis/logging/v2beta1.ts index a401ed83cd..45d5d6c673 100644 --- a/src/apis/logging/v2beta1.ts +++ b/src/apis/logging/v2beta1.ts @@ -29,6 +29,57 @@ export namespace logging_v2beta1 { version: 'v2beta1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Stackdriver Logging API * @@ -49,10 +100,8 @@ export namespace logging_v2beta1 { google?: GoogleConfigurable; root = this; - billingAccounts: Resource$Billingaccounts; entries: Resource$Entries; monitoredResourceDescriptors: Resource$Monitoredresourcedescriptors; - organizations: Resource$Organizations; projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { @@ -60,11 +109,9 @@ export namespace logging_v2beta1 { this.google = google; this.getRoot.bind(this); - this.billingAccounts = new Resource$Billingaccounts(this); this.entries = new Resource$Entries(this); this.monitoredResourceDescriptors = new Resource$Monitoredresourcedescriptors(this); - this.organizations = new Resource$Organizations(this); this.projects = new Resource$Projects(this); } @@ -359,23 +406,6 @@ export namespace logging_v2beta1 { */ nextPageToken?: string; } - /** - * Result returned from ListLogs. - */ - export interface Schema$ListLogsResponse { - /** - * A list of log names. For example, "projects/my-project/syslog" - * or - * "organizations/123/cloudresourcemanager.googleapis.com%2Factivity". - */ - logNames?: string[]; - /** - * If there might be more results than those appearing in this response, - * then nextPageToken is included. To get the next set of results, call this - * method again using the value of nextPageToken as pageToken. - */ - nextPageToken?: string; - } /** * Result returned from ListMonitoredResourceDescriptors. */ @@ -623,6 +653,7 @@ export namespace logging_v2beta1 { bucketOptions?: Schema$BucketOptions; /** * Optional. A description of this metric, which is used in documentation. + * The maximum length of the description is 8000 characters. */ description?: string; /** @@ -719,10 +750,6 @@ export namespace logging_v2beta1 { * exported. For more information, see Exporting Logs With Sinks. */ destination?: string; - /** - * Deprecated. This field is ignored when creating or updating sinks. - */ - endTime?: string; /** * Optional. An advanced logs filter. The only exported log entries are * those that are in the resource owning the sink and that match the filter. @@ -759,10 +786,6 @@ export namespace logging_v2beta1 { * entries. The v2 format is used by default and cannot be changed. */ outputVersionFormat?: string; - /** - * Deprecated. This field is ignored when creating or updating sinks. - */ - startTime?: string; /** * Output only. An IAM identity&mdash;a service account or * group&mdash;under which Logging writes the exported log entries to @@ -1247,22 +1270,7 @@ export namespace logging_v2beta1 { export interface Schema$WriteLogEntriesResponse {} - export class Resource$Billingaccounts { - root: Logging; - logs: Resource$Billingaccounts$Logs; - constructor(root: Logging) { - this.root = root; - this.getRoot.bind(this); - this.logs = new Resource$Billingaccounts$Logs(root); - } - - getRoot() { - return this.root; - } - } - - - export class Resource$Billingaccounts$Logs { + export class Resource$Entries { root: Logging; constructor(root: Logging) { this.root = root; @@ -1275,10 +1283,9 @@ export namespace logging_v2beta1 { /** - * logging.billingAccounts.logs.delete - * @desc Deletes all the log entries in a log. The log reappears if it - * receives new entries. Log entries written shortly before the delete - * operation might not be deleted. + * logging.entries.list + * @desc Lists log entries. Use this method to retrieve log entries from + * Logging. For ways to export log entries, see Exporting Logs. * @example * * // BEFORE RUNNING: * // --------------- @@ -1301,29 +1308,35 @@ export namespace logging_v2beta1 { * * authorize(function(authClient) { * var request = { - * // Required. The resource name of the log to delete: - * // "projects/[PROJECT_ID]/logs/[LOG_ID]" - * // "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" - * // "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" - * // "folders/[FOLDER_ID]/logs/[LOG_ID]" - * // [LOG_ID] must be URL-encoded. For example, - * "projects/my-project-id/logs/syslog", - * // - * "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". - * For more - * // information about log names, see LogEntry. - * logName: 'billingAccounts/my-billing-account/logs/my-log', // TODO: - * Update placeholder value. + * resource: { + * // TODO: Add desired properties to the request body. + * }, * * auth: authClient, * }; * - * logging.billingAccounts.logs.delete(request, function(err) { + * var handlePage = function(err, response) { * if (err) { * console.error(err); * return; * } - * }); + * + * var entriesPage = response['entries']; + * if (!entriesPage) { + * return; + * } + * for (var i = 0; i < entriesPage.length; i++) { + * // TODO: Change code below to process each resource in + * `entriesPage`: console.log(JSON.stringify(entriesPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.resource.pageToken = response.nextPageToken; + * logging.entries.list(request, handlePage); + * } + * }; + * + * logging.entries.list(request, handlePage); * }); * * function authorize(callback) { @@ -1340,39 +1353,39 @@ export namespace logging_v2beta1 { * callback(authClient); * }); * } - * @alias logging.billingAccounts.logs.delete + * @alias logging.entries.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.logName Required. The resource name of the log to delete: "projects/[PROJECT_ID]/logs/[LOG_ID]" "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" "folders/[FOLDER_ID]/logs/[LOG_ID]" [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog", "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". For more information about log names, see LogEntry. + * @param {().ListLogEntriesRequest} 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 */ - delete( - params?: Params$Resource$Billingaccounts$Logs$Delete, - options?: MethodOptions): AxiosPromise; - delete( - params: Params$Resource$Billingaccounts$Logs$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( - params: Params$Resource$Billingaccounts$Logs$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: Params$Resource$Billingaccounts$Logs$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Billingaccounts$Logs$Delete; + list(params?: Params$Resource$Entries$List, options?: MethodOptions): + AxiosPromise; + list( + params: Params$Resource$Entries$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Entries$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Entries$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Entries$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Billingaccounts$Logs$Delete; + params = {} as Params$Resource$Entries$List; options = {}; } @@ -1385,28 +1398,32 @@ export namespace logging_v2beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2beta1/{+logName}') + url: (rootUrl + '/v2beta1/entries:list') .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' + method: 'POST' }, options), params, - requiredParams: ['logName'], - pathParams: ['logName'], + requiredParams: [], + pathParams: [], context: this.getRoot() }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * logging.billingAccounts.logs.list - * @desc Lists the logs in projects, organizations, folders, or billing - * accounts. Only logs that have entries are listed. + * logging.entries.write + * @desc Writes log entries to Logging. This API method is the only way to + * send log entries to Logging. This method is used, directly or indirectly, + * by the Logging agent (fluentd) and all logging libraries configured to + * use Logging. A single request may contain log entries for a maximum of + * 1000 different resources (projects, organizations, billing accounts or + * folders) * @example * * // BEFORE RUNNING: * // --------------- @@ -1429,39 +1446,22 @@ export namespace logging_v2beta1 { * * authorize(function(authClient) { * var request = { - * // Required. The resource name that owns the logs: - * // "projects/[PROJECT_ID]" - * // "organizations/[ORGANIZATION_ID]" - * // "billingAccounts/[BILLING_ACCOUNT_ID]" - * // "folders/[FOLDER_ID]" - * parent: 'billingAccounts/my-billing-account', // TODO: Update - * placeholder value. + * resource: { + * // TODO: Add desired properties to the request body. + * }, * * auth: authClient, * }; * - * var handlePage = function(err, response) { + * logging.entries.write(request, function(err, response) { * if (err) { * console.error(err); * return; * } * - * var logNamesPage = response['logNames']; - * if (!logNamesPage) { - * return; - * } - * for (var i = 0; i < logNamesPage.length; i++) { - * // TODO: Change code below to process each resource in - * `logNamesPage`: console.log(JSON.stringify(logNamesPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * logging.billingAccounts.logs.list(request, handlePage); - * } - * }; - * - * logging.billingAccounts.logs.list(request, handlePage); + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); * }); * * function authorize(callback) { @@ -1478,42 +1478,39 @@ export namespace logging_v2beta1 { * callback(authClient); * }); * } - * @alias logging.billingAccounts.logs.list + * @alias logging.entries.write * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. - * @param {string=} params.pageToken Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. - * @param {string} params.parent Required. The resource name that owns the logs: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" + * @param {().WriteLogEntriesRequest} 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 */ - list( - params?: Params$Resource$Billingaccounts$Logs$List, - options?: MethodOptions): AxiosPromise; - list( - params: Params$Resource$Billingaccounts$Logs$List, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Billingaccounts$Logs$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Billingaccounts$Logs$List| - BodyResponseCallback, + write(params?: Params$Resource$Entries$Write, options?: MethodOptions): + AxiosPromise; + write( + params: Params$Resource$Entries$Write, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + write( + params: Params$Resource$Entries$Write, + callback: BodyResponseCallback): void; + write(callback: BodyResponseCallback): void; + write( + paramsOrCallback?: Params$Resource$Entries$Write| + BodyResponseCallback, optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Billingaccounts$Logs$List; + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Entries$Write; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Billingaccounts$Logs$List; + params = {} as Params$Resource$Entries$Write; options = {}; } @@ -1526,72 +1523,51 @@ export namespace logging_v2beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2beta1/{+parent}/logs') + url: (rootUrl + '/v2beta1/entries:write') .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' + method: 'POST' }, options), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: [], + pathParams: [], context: this.getRoot() }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Billingaccounts$Logs$Delete { + export interface Params$Resource$Entries$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + /** - * Required. The resource name of the log to delete: - * "projects/[PROJECT_ID]/logs/[LOG_ID]" - * "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" - * "folders/[FOLDER_ID]/logs/[LOG_ID]" [LOG_ID] must be URL-encoded. For - * example, "projects/my-project-id/logs/syslog", - * "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". - * For more information about log names, see LogEntry. + * Request body metadata */ - logName?: string; + requestBody?: Schema$ListLogEntriesRequest; } - export interface Params$Resource$Billingaccounts$Logs$List { + export interface Params$Resource$Entries$Write extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + /** - * Optional. The maximum number of results to return from this request. - * Non-positive values are ignored. The presence of nextPageToken in the - * response indicates that more results might be available. - */ - pageSize?: number; - /** - * Optional. If present, then retrieve the next batch of results from the - * preceding call to this method. pageToken must be the value of - * nextPageToken from the previous response. The values of other method - * parameters should be identical to those in the previous call. - */ - pageToken?: string; - /** - * Required. The resource name that owns the logs: "projects/[PROJECT_ID]" - * "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" - * "folders/[FOLDER_ID]" + * Request body metadata */ - parent?: string; + requestBody?: Schema$WriteLogEntriesRequest; } - - export class Resource$Entries { + export class Resource$Monitoredresourcedescriptors { root: Logging; constructor(root: Logging) { this.root = root; @@ -1604,9 +1580,8 @@ export namespace logging_v2beta1 { /** - * logging.entries.list - * @desc Lists log entries. Use this method to retrieve log entries from - * Logging. For ways to export log entries, see Exporting Logs. + * logging.monitoredResourceDescriptors.list + * @desc Lists the descriptors for monitored resource types used by Logging. * @example * * // BEFORE RUNNING: * // --------------- @@ -1629,10 +1604,6 @@ export namespace logging_v2beta1 { * * authorize(function(authClient) { * var request = { - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * * auth: authClient, * }; * @@ -1642,22 +1613,23 @@ export namespace logging_v2beta1 { * return; * } * - * var entriesPage = response['entries']; - * if (!entriesPage) { + * var resourceDescriptorsPage = response['resourceDescriptors']; + * if (!resourceDescriptorsPage) { * return; * } - * for (var i = 0; i < entriesPage.length; i++) { + * for (var i = 0; i < resourceDescriptorsPage.length; i++) { * // TODO: Change code below to process each resource in - * `entriesPage`: console.log(JSON.stringify(entriesPage[i], null, 2)); + * `resourceDescriptorsPage`: + * console.log(JSON.stringify(resourceDescriptorsPage[i], null, 2)); * } * * if (response.nextPageToken) { - * request.resource.pageToken = response.nextPageToken; - * logging.entries.list(request, handlePage); + * request.pageToken = response.nextPageToken; + * logging.monitoredResourceDescriptors.list(request, handlePage); * } * }; * - * logging.entries.list(request, handlePage); + * logging.monitoredResourceDescriptors.list(request, handlePage); * }); * * function authorize(callback) { @@ -1674,164 +1646,47 @@ export namespace logging_v2beta1 { * callback(authClient); * }); * } - * @alias logging.entries.list + * @alias logging.monitoredResourceDescriptors.list * @memberOf! () * * @param {object} params Parameters for request - * @param {().ListLogEntriesRequest} params.resource Request body data + * @param {integer=} params.pageSize Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. + * @param {string=} params.pageToken Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. * @param {object} [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$Entries$List, options?: MethodOptions): - AxiosPromise; list( - params: Params$Resource$Entries$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; + params?: Params$Resource$Monitoredresourcedescriptors$List, + options?: MethodOptions): + AxiosPromise; list( - params: Params$Resource$Entries$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Entries$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Entries$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Entries$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/entries:list') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: [], - pathParams: [], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * logging.entries.write - * @desc Writes log entries to Logging. This API method is the only way to - * send log entries to Logging. This method is used, directly or indirectly, - * by the Logging agent (fluentd) and all logging libraries configured to - * use Logging. A single request may contain log entries for a maximum of - * 1000 different resources (projects, organizations, billing accounts or - * folders) - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Stackdriver Logging API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/logging - * // 2. This sample uses Application Default Credentials for - * authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var logging = google.logging('v2beta1'); - * - * authorize(function(authClient) { - * var request = { - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * logging.entries.write(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); - * } - * callback(authClient); - * }); - * } - * @alias logging.entries.write - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {().WriteLogEntriesRequest} 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 - */ - write(params?: Params$Resource$Entries$Write, options?: MethodOptions): - AxiosPromise; - write( - params: Params$Resource$Entries$Write, + params: Params$Resource$Monitoredresourcedescriptors$List, options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - write( - params: Params$Resource$Entries$Write, - callback: BodyResponseCallback): void; - write(callback: BodyResponseCallback): void; - write( - paramsOrCallback?: Params$Resource$Entries$Write| - BodyResponseCallback, + BodyResponseCallback, + callback: BodyResponseCallback< + Schema$ListMonitoredResourceDescriptorsResponse>): void; + list( + params: Params$Resource$Monitoredresourcedescriptors$List, + callback: BodyResponseCallback< + Schema$ListMonitoredResourceDescriptorsResponse>): void; + list(callback: BodyResponseCallback< + Schema$ListMonitoredResourceDescriptorsResponse>): void; + list( + paramsOrCallback?: Params$Resource$Monitoredresourcedescriptors$List| + BodyResponseCallback, optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Entries$Write; + BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$ListMonitoredResourceDescriptorsResponse>): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Monitoredresourcedescriptors$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Entries$Write; + params = {} as Params$Resource$Monitoredresourcedescriptors$List; options = {}; } @@ -1844,9 +1699,9 @@ export namespace logging_v2beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2beta1/entries:write') + url: (rootUrl + '/v2beta1/monitoredResourceDescriptors') .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' + method: 'GET' }, options), params, @@ -1855,899 +1710,52 @@ export namespace logging_v2beta1 { context: this.getRoot() }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest< + Schema$ListMonitoredResourceDescriptorsResponse>(parameters); } } } - export interface Params$Resource$Entries$List { + export interface Params$Resource$Monitoredresourcedescriptors$List extends + StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Request body metadata - */ - requestBody?: Schema$ListLogEntriesRequest; - } - export interface Params$Resource$Entries$Write { /** - * Auth client or API Key for the request + * Optional. The maximum number of results to return from this request. + * Non-positive values are ignored. The presence of nextPageToken in the + * response indicates that more results might be available. */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - + pageSize?: number; /** - * Request body metadata + * Optional. If present, then retrieve the next batch of results from the + * preceding call to this method. pageToken must be the value of + * nextPageToken from the previous response. The values of other method + * parameters should be identical to those in the previous call. */ - requestBody?: Schema$WriteLogEntriesRequest; + pageToken?: string; } - export class Resource$Monitoredresourcedescriptors { + export class Resource$Projects { root: Logging; + metrics: Resource$Projects$Metrics; + sinks: Resource$Projects$Sinks; constructor(root: Logging) { this.root = root; this.getRoot.bind(this); + this.metrics = new Resource$Projects$Metrics(root); + this.sinks = new Resource$Projects$Sinks(root); } getRoot() { return this.root; } - - - /** - * logging.monitoredResourceDescriptors.list - * @desc Lists the descriptors for monitored resource types used by Logging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Stackdriver Logging API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/logging - * // 2. This sample uses Application Default Credentials for - * authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var logging = google.logging('v2beta1'); - * - * authorize(function(authClient) { - * var request = { - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var resourceDescriptorsPage = response['resourceDescriptors']; - * if (!resourceDescriptorsPage) { - * return; - * } - * for (var i = 0; i < resourceDescriptorsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `resourceDescriptorsPage`: - * console.log(JSON.stringify(resourceDescriptorsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * logging.monitoredResourceDescriptors.list(request, handlePage); - * } - * }; - * - * logging.monitoredResourceDescriptors.list(request, handlePage); - * }); - * - * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); - * } - * callback(authClient); - * }); - * } - * @alias logging.monitoredResourceDescriptors.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.pageSize Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. - * @param {string=} params.pageToken Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. - * @param {object} [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$Monitoredresourcedescriptors$List, - options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Monitoredresourcedescriptors$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback< - Schema$ListMonitoredResourceDescriptorsResponse>): void; - list( - params: Params$Resource$Monitoredresourcedescriptors$List, - callback: BodyResponseCallback< - Schema$ListMonitoredResourceDescriptorsResponse>): void; - list(callback: BodyResponseCallback< - Schema$ListMonitoredResourceDescriptorsResponse>): void; - list( - paramsOrCallback?: Params$Resource$Monitoredresourcedescriptors$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$ListMonitoredResourceDescriptorsResponse>): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Monitoredresourcedescriptors$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Monitoredresourcedescriptors$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/monitoredResourceDescriptors') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: [], - pathParams: [], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest< - Schema$ListMonitoredResourceDescriptorsResponse>(parameters); - } - } - } - - export interface Params$Resource$Monitoredresourcedescriptors$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Optional. The maximum number of results to return from this request. - * Non-positive values are ignored. The presence of nextPageToken in the - * response indicates that more results might be available. - */ - pageSize?: number; - /** - * Optional. If present, then retrieve the next batch of results from the - * preceding call to this method. pageToken must be the value of - * nextPageToken from the previous response. The values of other method - * parameters should be identical to those in the previous call. - */ - pageToken?: string; - } - - - export class Resource$Organizations { - root: Logging; - logs: Resource$Organizations$Logs; - constructor(root: Logging) { - this.root = root; - this.getRoot.bind(this); - this.logs = new Resource$Organizations$Logs(root); - } - - getRoot() { - return this.root; - } - } - - - export class Resource$Organizations$Logs { - root: Logging; - constructor(root: Logging) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * logging.organizations.logs.delete - * @desc Deletes all the log entries in a log. The log reappears if it - * receives new entries. Log entries written shortly before the delete - * operation might not be deleted. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Stackdriver Logging API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/logging - * // 2. This sample uses Application Default Credentials for - * authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var logging = google.logging('v2beta1'); - * - * authorize(function(authClient) { - * var request = { - * // Required. The resource name of the log to delete: - * // "projects/[PROJECT_ID]/logs/[LOG_ID]" - * // "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" - * // "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" - * // "folders/[FOLDER_ID]/logs/[LOG_ID]" - * // [LOG_ID] must be URL-encoded. For example, - * "projects/my-project-id/logs/syslog", - * // - * "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". - * For more - * // information about log names, see LogEntry. - * logName: 'organizations/my-organization/logs/my-log', // TODO: - * Update placeholder value. - * - * auth: authClient, - * }; - * - * logging.organizations.logs.delete(request, function(err) { - * if (err) { - * console.error(err); - * return; - * } - * }); - * }); - * - * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); - * } - * callback(authClient); - * }); - * } - * @alias logging.organizations.logs.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.logName Required. The resource name of the log to delete: "projects/[PROJECT_ID]/logs/[LOG_ID]" "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" "folders/[FOLDER_ID]/logs/[LOG_ID]" [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog", "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". For more information about log names, see LogEntry. - * @param {object} [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$Organizations$Logs$Delete, - options?: MethodOptions): AxiosPromise; - delete( - params: Params$Resource$Organizations$Logs$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( - params: Params$Resource$Organizations$Logs$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: Params$Resource$Organizations$Logs$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Organizations$Logs$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Logs$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+logName}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['logName'], - pathParams: ['logName'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * logging.organizations.logs.list - * @desc Lists the logs in projects, organizations, folders, or billing - * accounts. Only logs that have entries are listed. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Stackdriver Logging API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/logging - * // 2. This sample uses Application Default Credentials for - * authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var logging = google.logging('v2beta1'); - * - * authorize(function(authClient) { - * var request = { - * // Required. The resource name that owns the logs: - * // "projects/[PROJECT_ID]" - * // "organizations/[ORGANIZATION_ID]" - * // "billingAccounts/[BILLING_ACCOUNT_ID]" - * // "folders/[FOLDER_ID]" - * parent: 'organizations/my-organization', // TODO: Update placeholder - * value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var logNamesPage = response['logNames']; - * if (!logNamesPage) { - * return; - * } - * for (var i = 0; i < logNamesPage.length; i++) { - * // TODO: Change code below to process each resource in - * `logNamesPage`: console.log(JSON.stringify(logNamesPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * logging.organizations.logs.list(request, handlePage); - * } - * }; - * - * logging.organizations.logs.list(request, handlePage); - * }); - * - * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); - * } - * callback(authClient); - * }); - * } - * @alias logging.organizations.logs.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.pageSize Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. - * @param {string=} params.pageToken Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. - * @param {string} params.parent Required. The resource name that owns the logs: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_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 - */ - list( - params?: Params$Resource$Organizations$Logs$List, - options?: MethodOptions): AxiosPromise; - list( - params: Params$Resource$Organizations$Logs$List, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Organizations$Logs$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Organizations$Logs$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Organizations$Logs$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Logs$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+parent}/logs') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Organizations$Logs$Delete { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Required. The resource name of the log to delete: - * "projects/[PROJECT_ID]/logs/[LOG_ID]" - * "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" - * "folders/[FOLDER_ID]/logs/[LOG_ID]" [LOG_ID] must be URL-encoded. For - * example, "projects/my-project-id/logs/syslog", - * "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". - * For more information about log names, see LogEntry. - */ - logName?: string; - } - export interface Params$Resource$Organizations$Logs$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Optional. The maximum number of results to return from this request. - * Non-positive values are ignored. The presence of nextPageToken in the - * response indicates that more results might be available. - */ - pageSize?: number; - /** - * Optional. If present, then retrieve the next batch of results from the - * preceding call to this method. pageToken must be the value of - * nextPageToken from the previous response. The values of other method - * parameters should be identical to those in the previous call. - */ - pageToken?: string; - /** - * Required. The resource name that owns the logs: "projects/[PROJECT_ID]" - * "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" - * "folders/[FOLDER_ID]" - */ - parent?: string; - } - - - - export class Resource$Projects { - root: Logging; - logs: Resource$Projects$Logs; - metrics: Resource$Projects$Metrics; - sinks: Resource$Projects$Sinks; - constructor(root: Logging) { - this.root = root; - this.getRoot.bind(this); - this.logs = new Resource$Projects$Logs(root); - this.metrics = new Resource$Projects$Metrics(root); - this.sinks = new Resource$Projects$Sinks(root); - } - - getRoot() { - return this.root; - } - } - - - export class Resource$Projects$Logs { - root: Logging; - constructor(root: Logging) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * logging.projects.logs.delete - * @desc Deletes all the log entries in a log. The log reappears if it - * receives new entries. Log entries written shortly before the delete - * operation might not be deleted. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Stackdriver Logging API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/logging - * // 2. This sample uses Application Default Credentials for - * authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var logging = google.logging('v2beta1'); - * - * authorize(function(authClient) { - * var request = { - * // Required. The resource name of the log to delete: - * // "projects/[PROJECT_ID]/logs/[LOG_ID]" - * // "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" - * // "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" - * // "folders/[FOLDER_ID]/logs/[LOG_ID]" - * // [LOG_ID] must be URL-encoded. For example, - * "projects/my-project-id/logs/syslog", - * // - * "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". - * For more - * // information about log names, see LogEntry. - * logName: 'projects/my-project/logs/my-log', // TODO: Update - * placeholder value. - * - * auth: authClient, - * }; - * - * logging.projects.logs.delete(request, function(err) { - * if (err) { - * console.error(err); - * return; - * } - * }); - * }); - * - * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); - * } - * callback(authClient); - * }); - * } - * @alias logging.projects.logs.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.logName Required. The resource name of the log to delete: "projects/[PROJECT_ID]/logs/[LOG_ID]" "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" "folders/[FOLDER_ID]/logs/[LOG_ID]" [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog", "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". For more information about log names, see LogEntry. - * @param {object} [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$Logs$Delete, - options?: MethodOptions): AxiosPromise; - delete( - params: Params$Resource$Projects$Logs$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( - params: Params$Resource$Projects$Logs$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: Params$Resource$Projects$Logs$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Projects$Logs$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Logs$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+logName}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['logName'], - pathParams: ['logName'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * logging.projects.logs.list - * @desc Lists the logs in projects, organizations, folders, or billing - * accounts. Only logs that have entries are listed. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Stackdriver Logging API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/logging - * // 2. This sample uses Application Default Credentials for - * authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // - * https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var logging = google.logging('v2beta1'); - * - * authorize(function(authClient) { - * var request = { - * // Required. The resource name that owns the logs: - * // "projects/[PROJECT_ID]" - * // "organizations/[ORGANIZATION_ID]" - * // "billingAccounts/[BILLING_ACCOUNT_ID]" - * // "folders/[FOLDER_ID]" - * parent: 'projects/my-project', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var logNamesPage = response['logNames']; - * if (!logNamesPage) { - * return; - * } - * for (var i = 0; i < logNamesPage.length; i++) { - * // TODO: Change code below to process each resource in - * `logNamesPage`: console.log(JSON.stringify(logNamesPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * logging.projects.logs.list(request, handlePage); - * } - * }; - * - * logging.projects.logs.list(request, handlePage); - * }); - * - * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && - * authClient.createScopedRequired()) { var scopes = - * ['https://www.googleapis.com/auth/cloud-platform']; authClient = - * authClient.createScoped(scopes); - * } - * callback(authClient); - * }); - * } - * @alias logging.projects.logs.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.pageSize Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. - * @param {string=} params.pageToken Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. - * @param {string} params.parent Required. The resource name that owns the logs: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_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 - */ - list(params?: Params$Resource$Projects$Logs$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Projects$Logs$List, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Projects$Logs$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Projects$Logs$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Projects$Logs$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Logs$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+parent}/logs') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Logs$Delete { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Required. The resource name of the log to delete: - * "projects/[PROJECT_ID]/logs/[LOG_ID]" - * "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" - * "folders/[FOLDER_ID]/logs/[LOG_ID]" [LOG_ID] must be URL-encoded. For - * example, "projects/my-project-id/logs/syslog", - * "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". - * For more information about log names, see LogEntry. - */ - logName?: string; - } - export interface Params$Resource$Projects$Logs$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Optional. The maximum number of results to return from this request. - * Non-positive values are ignored. The presence of nextPageToken in the - * response indicates that more results might be available. - */ - pageSize?: number; - /** - * Optional. If present, then retrieve the next batch of results from the - * preceding call to this method. pageToken must be the value of - * nextPageToken from the previous response. The values of other method - * parameters should be identical to those in the previous call. - */ - pageToken?: string; - /** - * Required. The resource name that owns the logs: "projects/[PROJECT_ID]" - * "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" - * "folders/[FOLDER_ID]" - */ - parent?: string; } @@ -3396,7 +2404,8 @@ export namespace logging_v2beta1 { } } - export interface Params$Resource$Projects$Metrics$Create { + export interface Params$Resource$Projects$Metrics$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3413,7 +2422,8 @@ export namespace logging_v2beta1 { */ requestBody?: Schema$LogMetric; } - export interface Params$Resource$Projects$Metrics$Delete { + export interface Params$Resource$Projects$Metrics$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3425,7 +2435,8 @@ export namespace logging_v2beta1 { */ metricName?: string; } - export interface Params$Resource$Projects$Metrics$Get { + export interface Params$Resource$Projects$Metrics$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3437,7 +2448,8 @@ export namespace logging_v2beta1 { */ metricName?: string; } - export interface Params$Resource$Projects$Metrics$List { + export interface Params$Resource$Projects$Metrics$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3462,7 +2474,8 @@ export namespace logging_v2beta1 { */ parent?: string; } - export interface Params$Resource$Projects$Metrics$Update { + export interface Params$Resource$Projects$Metrics$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4153,7 +3166,8 @@ export namespace logging_v2beta1 { } } - export interface Params$Resource$Projects$Sinks$Create { + export interface Params$Resource$Projects$Sinks$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4185,7 +3199,8 @@ export namespace logging_v2beta1 { */ requestBody?: Schema$LogSink; } - export interface Params$Resource$Projects$Sinks$Delete { + export interface Params$Resource$Projects$Sinks$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4202,7 +3217,8 @@ export namespace logging_v2beta1 { */ sinkName?: string; } - export interface Params$Resource$Projects$Sinks$Get { + export interface Params$Resource$Projects$Sinks$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4218,7 +3234,8 @@ export namespace logging_v2beta1 { */ sinkName?: string; } - export interface Params$Resource$Projects$Sinks$List { + export interface Params$Resource$Projects$Sinks$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4244,7 +3261,8 @@ export namespace logging_v2beta1 { */ parent?: string; } - export interface Params$Resource$Projects$Sinks$Update { + export interface Params$Resource$Projects$Sinks$Update extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/manufacturers/v1.ts b/src/apis/manufacturers/v1.ts index 6c801459a5..26dddbc9fc 100644 --- a/src/apis/manufacturers/v1.ts +++ b/src/apis/manufacturers/v1.ts @@ -29,6 +29,57 @@ export namespace manufacturers_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Manufacturer Center API * @@ -777,7 +828,8 @@ export namespace manufacturers_v1 { } } - export interface Params$Resource$Accounts$Products$Delete { + export interface Params$Resource$Accounts$Products$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -799,7 +851,8 @@ export namespace manufacturers_v1 { */ parent?: string; } - export interface Params$Resource$Accounts$Products$Get { + export interface Params$Resource$Accounts$Products$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -826,7 +879,8 @@ export namespace manufacturers_v1 { */ parent?: string; } - export interface Params$Resource$Accounts$Products$List { + export interface Params$Resource$Accounts$Products$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -852,7 +906,8 @@ export namespace manufacturers_v1 { */ parent?: string; } - export interface Params$Resource$Accounts$Products$Update { + export interface Params$Resource$Accounts$Products$Update extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/mirror/v1.ts b/src/apis/mirror/v1.ts index dd60e920ca..bcd291c7ca 100644 --- a/src/apis/mirror/v1.ts +++ b/src/apis/mirror/v1.ts @@ -29,6 +29,40 @@ export namespace mirror_v1 { version: 'v1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Google Mirror API * @@ -798,7 +832,7 @@ export namespace mirror_v1 { } } - export interface Params$Resource$Accounts$Insert { + export interface Params$Resource$Accounts$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1219,7 +1253,7 @@ export namespace mirror_v1 { } } - export interface Params$Resource$Contacts$Delete { + export interface Params$Resource$Contacts$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1230,7 +1264,7 @@ export namespace mirror_v1 { */ id?: string; } - export interface Params$Resource$Contacts$Get { + export interface Params$Resource$Contacts$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1241,7 +1275,7 @@ export namespace mirror_v1 { */ id?: string; } - export interface Params$Resource$Contacts$Insert { + export interface Params$Resource$Contacts$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1253,13 +1287,13 @@ export namespace mirror_v1 { */ requestBody?: Schema$Contact; } - export interface Params$Resource$Contacts$List { + export interface Params$Resource$Contacts$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; } - export interface Params$Resource$Contacts$Patch { + export interface Params$Resource$Contacts$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1275,7 +1309,7 @@ export namespace mirror_v1 { */ requestBody?: Schema$Contact; } - export interface Params$Resource$Contacts$Update { + export interface Params$Resource$Contacts$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1431,7 +1465,7 @@ export namespace mirror_v1 { } } - export interface Params$Resource$Locations$Get { + export interface Params$Resource$Locations$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1442,7 +1476,7 @@ export namespace mirror_v1 { */ id?: string; } - export interface Params$Resource$Locations$List { + export interface Params$Resource$Locations$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1523,7 +1557,7 @@ export namespace mirror_v1 { } } - export interface Params$Resource$Settings$Get { + export interface Params$Resource$Settings$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1821,7 +1855,8 @@ export namespace mirror_v1 { } } - export interface Params$Resource$Subscriptions$Delete { + export interface Params$Resource$Subscriptions$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1832,7 +1867,8 @@ export namespace mirror_v1 { */ id?: string; } - export interface Params$Resource$Subscriptions$Insert { + export interface Params$Resource$Subscriptions$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1844,13 +1880,15 @@ export namespace mirror_v1 { */ requestBody?: Schema$Subscription; } - export interface Params$Resource$Subscriptions$List { + export interface Params$Resource$Subscriptions$List extends + StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; } - export interface Params$Resource$Subscriptions$Update { + export interface Params$Resource$Subscriptions$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2287,7 +2325,7 @@ export namespace mirror_v1 { } } - export interface Params$Resource$Timeline$Delete { + export interface Params$Resource$Timeline$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2298,7 +2336,7 @@ export namespace mirror_v1 { */ id?: string; } - export interface Params$Resource$Timeline$Get { + export interface Params$Resource$Timeline$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2309,7 +2347,7 @@ export namespace mirror_v1 { */ id?: string; } - export interface Params$Resource$Timeline$Insert { + export interface Params$Resource$Timeline$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2336,7 +2374,7 @@ export namespace mirror_v1 { body?: any; }; } - export interface Params$Resource$Timeline$List { + export interface Params$Resource$Timeline$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2371,7 +2409,7 @@ export namespace mirror_v1 { */ sourceItemId?: string; } - export interface Params$Resource$Timeline$Patch { + export interface Params$Resource$Timeline$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2387,7 +2425,7 @@ export namespace mirror_v1 { */ requestBody?: Schema$TimelineItem; } - export interface Params$Resource$Timeline$Update { + export interface Params$Resource$Timeline$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2704,7 +2742,8 @@ export namespace mirror_v1 { } } - export interface Params$Resource$Timeline$Attachments$Delete { + export interface Params$Resource$Timeline$Attachments$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2719,7 +2758,8 @@ export namespace mirror_v1 { */ itemId?: string; } - export interface Params$Resource$Timeline$Attachments$Get { + export interface Params$Resource$Timeline$Attachments$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2734,7 +2774,8 @@ export namespace mirror_v1 { */ itemId?: string; } - export interface Params$Resource$Timeline$Attachments$Insert { + export interface Params$Resource$Timeline$Attachments$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2761,7 +2802,8 @@ export namespace mirror_v1 { body?: any; }; } - export interface Params$Resource$Timeline$Attachments$List { + export interface Params$Resource$Timeline$Attachments$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/ml/v1.ts b/src/apis/ml/v1.ts index efce824d80..dd539b9b82 100644 --- a/src/apis/ml/v1.ts +++ b/src/apis/ml/v1.ts @@ -29,6 +29,57 @@ export namespace ml_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Machine Learning Engine * @@ -1445,7 +1496,8 @@ export namespace ml_v1 { } } - export interface Params$Resource$Projects$Getconfig { + export interface Params$Resource$Projects$Getconfig extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1456,7 +1508,7 @@ export namespace ml_v1 { */ name?: string; } - export interface Params$Resource$Projects$Predict { + export interface Params$Resource$Projects$Predict extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2056,7 +2108,8 @@ export namespace ml_v1 { } } - export interface Params$Resource$Projects$Jobs$Cancel { + export interface Params$Resource$Projects$Jobs$Cancel extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2072,7 +2125,8 @@ export namespace ml_v1 { */ requestBody?: Schema$GoogleCloudMlV1__CancelJobRequest; } - export interface Params$Resource$Projects$Jobs$Create { + export interface Params$Resource$Projects$Jobs$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2088,7 +2142,8 @@ export namespace ml_v1 { */ requestBody?: Schema$GoogleCloudMlV1__Job; } - export interface Params$Resource$Projects$Jobs$Get { + export interface Params$Resource$Projects$Jobs$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2099,7 +2154,8 @@ export namespace ml_v1 { */ name?: string; } - export interface Params$Resource$Projects$Jobs$Getiampolicy { + export interface Params$Resource$Projects$Jobs$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2111,7 +2167,8 @@ export namespace ml_v1 { */ resource?: string; } - export interface Params$Resource$Projects$Jobs$List { + export interface Params$Resource$Projects$Jobs$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2146,7 +2203,8 @@ export namespace ml_v1 { */ parent?: string; } - export interface Params$Resource$Projects$Jobs$Patch { + export interface Params$Resource$Projects$Jobs$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2176,7 +2234,8 @@ export namespace ml_v1 { */ requestBody?: Schema$GoogleCloudMlV1__Job; } - export interface Params$Resource$Projects$Jobs$Setiampolicy { + export interface Params$Resource$Projects$Jobs$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2193,7 +2252,8 @@ export namespace ml_v1 { */ requestBody?: Schema$GoogleIamV1__SetIamPolicyRequest; } - export interface Params$Resource$Projects$Jobs$Testiampermissions { + export interface Params$Resource$Projects$Jobs$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2368,7 +2428,8 @@ export namespace ml_v1 { } } - export interface Params$Resource$Projects$Locations$Get { + export interface Params$Resource$Projects$Locations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2379,7 +2440,8 @@ export namespace ml_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$List { + export interface Params$Resource$Projects$Locations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3010,7 +3072,8 @@ export namespace ml_v1 { } } - export interface Params$Resource$Projects$Models$Create { + export interface Params$Resource$Projects$Models$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3026,7 +3089,8 @@ export namespace ml_v1 { */ requestBody?: Schema$GoogleCloudMlV1__Model; } - export interface Params$Resource$Projects$Models$Delete { + export interface Params$Resource$Projects$Models$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3037,7 +3101,8 @@ export namespace ml_v1 { */ name?: string; } - export interface Params$Resource$Projects$Models$Get { + export interface Params$Resource$Projects$Models$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3048,7 +3113,8 @@ export namespace ml_v1 { */ name?: string; } - export interface Params$Resource$Projects$Models$Getiampolicy { + export interface Params$Resource$Projects$Models$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3060,7 +3126,8 @@ export namespace ml_v1 { */ resource?: string; } - export interface Params$Resource$Projects$Models$List { + export interface Params$Resource$Projects$Models$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3088,7 +3155,8 @@ export namespace ml_v1 { */ parent?: string; } - export interface Params$Resource$Projects$Models$Patch { + export interface Params$Resource$Projects$Models$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3115,7 +3183,8 @@ export namespace ml_v1 { */ requestBody?: Schema$GoogleCloudMlV1__Model; } - export interface Params$Resource$Projects$Models$Setiampolicy { + export interface Params$Resource$Projects$Models$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3132,7 +3201,8 @@ export namespace ml_v1 { */ requestBody?: Schema$GoogleIamV1__SetIamPolicyRequest; } - export interface Params$Resource$Projects$Models$Testiampermissions { + export interface Params$Resource$Projects$Models$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3623,7 +3693,8 @@ export namespace ml_v1 { } } - export interface Params$Resource$Projects$Models$Versions$Create { + export interface Params$Resource$Projects$Models$Versions$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3639,7 +3710,8 @@ export namespace ml_v1 { */ requestBody?: Schema$GoogleCloudMlV1__Version; } - export interface Params$Resource$Projects$Models$Versions$Delete { + export interface Params$Resource$Projects$Models$Versions$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3652,7 +3724,8 @@ export namespace ml_v1 { */ name?: string; } - export interface Params$Resource$Projects$Models$Versions$Get { + export interface Params$Resource$Projects$Models$Versions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3663,7 +3736,8 @@ export namespace ml_v1 { */ name?: string; } - export interface Params$Resource$Projects$Models$Versions$List { + export interface Params$Resource$Projects$Models$Versions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3691,7 +3765,8 @@ export namespace ml_v1 { */ parent?: string; } - export interface Params$Resource$Projects$Models$Versions$Patch { + export interface Params$Resource$Projects$Models$Versions$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3717,7 +3792,8 @@ export namespace ml_v1 { */ requestBody?: Schema$GoogleCloudMlV1__Version; } - export interface Params$Resource$Projects$Models$Versions$Setdefault { + export interface Params$Resource$Projects$Models$Versions$Setdefault extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4053,7 +4129,8 @@ export namespace ml_v1 { } } - export interface Params$Resource$Projects$Operations$Cancel { + export interface Params$Resource$Projects$Operations$Cancel extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4064,7 +4141,8 @@ export namespace ml_v1 { */ name?: string; } - export interface Params$Resource$Projects$Operations$Delete { + export interface Params$Resource$Projects$Operations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4075,7 +4153,8 @@ export namespace ml_v1 { */ name?: string; } - export interface Params$Resource$Projects$Operations$Get { + export interface Params$Resource$Projects$Operations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4086,7 +4165,8 @@ export namespace ml_v1 { */ name?: string; } - export interface Params$Resource$Projects$Operations$List { + export interface Params$Resource$Projects$Operations$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/monitoring/v3.ts b/src/apis/monitoring/v3.ts index 1d6f8af096..9dfa1b8e79 100644 --- a/src/apis/monitoring/v3.ts +++ b/src/apis/monitoring/v3.ts @@ -29,6 +29,57 @@ export namespace monitoring_v3 { version: 'v3'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Stackdriver Monitoring API * @@ -51,7 +102,10 @@ export namespace monitoring_v3 { google?: GoogleConfigurable; root = this; + metricDescriptors: Resource$Metricdescriptors; + monitoredResourceDescriptors: Resource$Monitoredresourcedescriptors; projects: Resource$Projects; + timeSeries: Resource$Timeseries; uptimeCheckIps: Resource$Uptimecheckips; constructor(options: GlobalOptions, google?: GoogleConfigurable) { @@ -59,7 +113,11 @@ export namespace monitoring_v3 { this.google = google; this.getRoot.bind(this); + this.metricDescriptors = new Resource$Metricdescriptors(this); + this.monitoredResourceDescriptors = + new Resource$Monitoredresourcedescriptors(this); this.projects = new Resource$Projects(this); + this.timeSeries = new Resource$Timeseries(this); this.uptimeCheckIps = new Resource$Uptimecheckips(this); } @@ -383,13 +441,12 @@ export namespace monitoring_v3 { name?: string; } /** - * Used to perform string matching. Currently, this matches on the exact - * content. In the future, it can be expanded to allow for regular expressions - * and more complex matching. + * Used to perform string matching. It allows substring and regular + * expressions, together with their negations. */ export interface Schema$ContentMatcher { /** - * String content to match (max 1024 bytes) + * String or regex content to match (max 1024 bytes) */ content?: string; } @@ -791,8 +848,8 @@ export namespace monitoring_v3 { useSsl?: boolean; } /** - * Nimbus InternalCheckers. The API currently only allows reading of internal - * checkers, creation of internal checkers is a manual process. + * An internal checker allows uptime checks to run on private/internal GCP + * resources. */ export interface Schema$InternalChecker { /** @@ -808,9 +865,9 @@ export namespace monitoring_v3 { gcpZone?: string; /** * A unique resource name for this InternalChecker. The format - * is:projects/[PROJECT_ID]/internalCheckers/[CHECKER_ID].PROJECT_ID is the - * GCP project ID where the internal resource lives. Not necessarily the - * same as the project_id for the config. + * is:projects/[PROJECT_ID]/internalCheckers/[INTERNAL_CHECKER_ID].PROJECT_ID + * is the stackdriver workspace project for the uptime check config + * associated with the internal checker. */ name?: string; /** @@ -818,6 +875,11 @@ export namespace monitoring_v3 { * internal resource lives (ex: "default"). */ network?: string; + /** + * The GCP project_id where the internal checker lives. Not necessary the + * same as the workspace project. + */ + peerProjectId?: string; } /** * A description of a label. @@ -1837,12 +1899,16 @@ export namespace monitoring_v3 { httpCheck?: Schema$HttpCheck; /** * The internal checkers that this check will egress from. If is_internal is - * true and this list is empty, the check will egress from all + * true and this list is empty, the check will egress from all the * InternalCheckers configured for the project that owns this CheckConfig. */ internalCheckers?: Schema$InternalChecker[]; /** - * Denotes whether this is a check that egresses from InternalCheckers. + * If this is true, then checks are made only from the + * 'internal_checkers'. If it is false, then checks are made only + * from the 'selected_regions'. It is an error to provide + * 'selected_regions' when is_internal is true, or to provide + * 'internal_checkers' when is_internal is false. */ isInternal?: boolean; /** @@ -1872,7 +1938,8 @@ export namespace monitoring_v3 { */ resourceGroup?: Schema$ResourceGroup; /** - * The list of regions from which the check will be run. If this field is + * The list of regions from which the check will be run. Some regions + * contain one location, and others contain more than one. If this field is * specified, enough regions to include a minimum of 3 locations must be * provided, or an error message is returned. Not specifying this field will * result in uptime checks running from all regions. @@ -1929,43 +1996,7 @@ export namespace monitoring_v3 { } - export class Resource$Projects { - root: Monitoring; - alertPolicies: Resource$Projects$Alertpolicies; - collectdTimeSeries: Resource$Projects$Collectdtimeseries; - groups: Resource$Projects$Groups; - metricDescriptors: Resource$Projects$Metricdescriptors; - monitoredResourceDescriptors: - Resource$Projects$Monitoredresourcedescriptors; - notificationChannelDescriptors: - Resource$Projects$Notificationchanneldescriptors; - notificationChannels: Resource$Projects$Notificationchannels; - timeSeries: Resource$Projects$Timeseries; - uptimeCheckConfigs: Resource$Projects$Uptimecheckconfigs; - constructor(root: Monitoring) { - this.root = root; - this.getRoot.bind(this); - this.alertPolicies = new Resource$Projects$Alertpolicies(root); - this.collectdTimeSeries = new Resource$Projects$Collectdtimeseries(root); - this.groups = new Resource$Projects$Groups(root); - this.metricDescriptors = new Resource$Projects$Metricdescriptors(root); - this.monitoredResourceDescriptors = - new Resource$Projects$Monitoredresourcedescriptors(root); - this.notificationChannelDescriptors = - new Resource$Projects$Notificationchanneldescriptors(root); - this.notificationChannels = - new Resource$Projects$Notificationchannels(root); - this.timeSeries = new Resource$Projects$Timeseries(root); - this.uptimeCheckConfigs = new Resource$Projects$Uptimecheckconfigs(root); - } - - getRoot() { - return this.root; - } - } - - - export class Resource$Projects$Alertpolicies { + export class Resource$Metricdescriptors { root: Monitoring; constructor(root: Monitoring) { this.root = root; @@ -1978,43 +2009,44 @@ export namespace monitoring_v3 { /** - * monitoring.projects.alertPolicies.create - * @desc Creates a new alerting policy. - * @alias monitoring.projects.alertPolicies.create + * monitoring.metricDescriptors.create + * @desc Creates a new metric descriptor. User-created metric descriptors + * define custom metrics. + * @alias monitoring.metricDescriptors.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The project in which to create the alerting policy. The format is projects/[PROJECT_ID].Note that this field names the parent container in which the alerting policy will be written, not the name of the created policy. The alerting policy that is returned will have a name that contains a normalized representation of this name as a prefix but adds a suffix of the form /alertPolicies/[POLICY_ID], identifying the policy in the container. - * @param {().AlertPolicy} params.resource Request body data + * @param {string} params.name The project on which to execute the request. The format is "projects/{project_id_or_number}". + * @param {().MetricDescriptor} 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$Alertpolicies$Create, - options?: MethodOptions): AxiosPromise; + params?: Params$Resource$Metricdescriptors$Create, + options?: MethodOptions): AxiosPromise; create( - params: Params$Resource$Projects$Alertpolicies$Create, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; + params: Params$Resource$Metricdescriptors$Create, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; create( - params: Params$Resource$Projects$Alertpolicies$Create, - callback: BodyResponseCallback): void; - create(callback: BodyResponseCallback): void; + params: Params$Resource$Metricdescriptors$Create, + callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; create( - paramsOrCallback?: Params$Resource$Projects$Alertpolicies$Create| - BodyResponseCallback, + paramsOrCallback?: Params$Resource$Metricdescriptors$Create| + BodyResponseCallback, optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Alertpolicies$Create; + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Metricdescriptors$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Alertpolicies$Create; + params = {} as Params$Resource$Metricdescriptors$Create; options = {}; } @@ -2027,7 +2059,7 @@ export namespace monitoring_v3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v3/{+name}/alertPolicies') + url: (rootUrl + '/v3/{+name}/metricDescriptors') .replace(/([^:]\/)\/+/g, '$1'), method: 'POST' }, @@ -2038,49 +2070,50 @@ export namespace monitoring_v3 { context: this.getRoot() }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * monitoring.projects.alertPolicies.delete - * @desc Deletes an alerting policy. - * @alias monitoring.projects.alertPolicies.delete + * monitoring.metricDescriptors.delete + * @desc Deletes a metric descriptor. Only user-created custom metrics can + * be deleted. + * @alias monitoring.metricDescriptors.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The alerting policy to delete. The format is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] For more information, see AlertPolicy. + * @param {string} params.name The metric descriptor on which to execute the request. The format is "projects/{project_id_or_number}/metricDescriptors/{metric_id}". An example of {metric_id} is: "custom.googleapis.com/my_test_metric". * @param {object} [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$Alertpolicies$Delete, + params?: Params$Resource$Metricdescriptors$Delete, options?: MethodOptions): AxiosPromise; delete( - params: Params$Resource$Projects$Alertpolicies$Delete, + params: Params$Resource$Metricdescriptors$Delete, options: MethodOptions|BodyResponseCallback, callback: BodyResponseCallback): void; delete( - params: Params$Resource$Projects$Alertpolicies$Delete, + params: Params$Resource$Metricdescriptors$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; delete( - paramsOrCallback?: Params$Resource$Projects$Alertpolicies$Delete| + paramsOrCallback?: Params$Resource$Metricdescriptors$Delete| BodyResponseCallback, optionsOrCallback?: MethodOptions|BodyResponseCallback, callback?: BodyResponseCallback): void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Alertpolicies$Delete; + let params = + (paramsOrCallback || {}) as Params$Resource$Metricdescriptors$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Alertpolicies$Delete; + params = {} as Params$Resource$Metricdescriptors$Delete; options = {}; } @@ -2111,38 +2144,39 @@ export namespace monitoring_v3 { /** - * monitoring.projects.alertPolicies.get - * @desc Gets a single alerting policy. - * @alias monitoring.projects.alertPolicies.get + * monitoring.metricDescriptors.get + * @desc Gets a single metric descriptor. This method does not require a + * Stackdriver account. + * @alias monitoring.metricDescriptors.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The alerting policy to retrieve. The format is projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] + * @param {string} params.name The metric descriptor on which to execute the request. The format is "projects/{project_id_or_number}/metricDescriptors/{metric_id}". An example value of {metric_id} is "compute.googleapis.com/instance/disk/read_bytes_count". * @param {object} [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$Alertpolicies$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Projects$Alertpolicies$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Projects$Alertpolicies$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Projects$Alertpolicies$Get| - BodyResponseCallback, + get(params?: Params$Resource$Metricdescriptors$Get, + options?: MethodOptions): AxiosPromise; + get(params: Params$Resource$Metricdescriptors$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Metricdescriptors$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Metricdescriptors$Get| + BodyResponseCallback, optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Alertpolicies$Get; + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Metricdescriptors$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Alertpolicies$Get; + params = {} as Params$Resource$Metricdescriptors$Get; options = {}; } @@ -2165,57 +2199,59 @@ export namespace monitoring_v3 { context: this.getRoot() }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * monitoring.projects.alertPolicies.list - * @desc Lists the existing alerting policies for the project. - * @alias monitoring.projects.alertPolicies.list + * monitoring.metricDescriptors.list + * @desc Lists metric descriptors that match a filter. This method does not + * require a Stackdriver account. + * @alias monitoring.metricDescriptors.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter If provided, this field specifies the criteria that must be met by alert policies to be included in the response.For more details, see sorting and filtering. - * @param {string} params.name The project whose alert policies are to be listed. The format is projects/[PROJECT_ID] Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the GetAlertPolicy operation, instead. - * @param {string=} params.orderBy A comma-separated list of fields by which to sort the result. Supports the same set of field references as the filter field. Entries can be prefixed with a minus sign to sort by the field in descending order.For more details, see sorting and filtering. - * @param {integer=} params.pageSize The maximum number of results to return in a single response. - * @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. + * @param {string=} params.filter If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics: metric.type = starts_with("custom.googleapis.com/") + * @param {string} params.name The project on which to execute the request. The format is "projects/{project_id_or_number}". + * @param {integer=} params.pageSize A positive number that is the maximum number of results to return. + * @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. * @param {object} [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$Alertpolicies$List, + params?: Params$Resource$Metricdescriptors$List, options?: MethodOptions): - AxiosPromise; + AxiosPromise; list( - params: Params$Resource$Projects$Alertpolicies$List, + params: Params$Resource$Metricdescriptors$List, options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; + BodyResponseCallback, + callback: BodyResponseCallback): + void; list( - params: Params$Resource$Projects$Alertpolicies$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): + params: Params$Resource$Metricdescriptors$List, + callback: BodyResponseCallback): + void; + list(callback: BodyResponseCallback): void; list( - paramsOrCallback?: Params$Resource$Projects$Alertpolicies$List| - BodyResponseCallback, + paramsOrCallback?: Params$Resource$Metricdescriptors$List| + BodyResponseCallback, optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Alertpolicies$List; + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Metricdescriptors$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Alertpolicies$List; + params = {} as Params$Resource$Metricdescriptors$List; options = {}; } @@ -2228,7 +2264,7 @@ export namespace monitoring_v3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v3/{+name}/alertPolicies') + url: (rootUrl + '/v3/{+name}/metricDescriptors') .replace(/([^:]\/)\/+/g, '$1'), method: 'GET' }, @@ -2239,58 +2275,662 @@ export namespace monitoring_v3 { context: this.getRoot() }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters); } } + } + export interface Params$Resource$Metricdescriptors$Create extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * monitoring.projects.alertPolicies.patch - * @desc Updates an alerting policy. You can either replace the entire - * policy with a new one or replace only certain fields in the current - * alerting policy by specifying the fields to be updated via updateMask. - * Returns the updated alerting policy. - * @alias monitoring.projects.alertPolicies.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Required if the policy exists. The resource name for this policy. The syntax is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Stackdriver Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request. - * @param {string=} params.updateMask Optional. A list of alerting policy field names. If this field is not empty, each listed field in the existing alerting policy is set to the value of the corresponding field in the supplied policy (alert_policy), or to the field's default value if the field is not in the supplied alerting policy. Fields not listed retain their previous value.Examples of valid field masks include display_name, documentation, documentation.content, documentation.mime_type, user_labels, user_label.nameofkey, enabled, conditions, combiner, etc.If this field is empty, then the supplied alerting policy replaces the existing policy. It is the same as deleting the existing policy and adding the supplied policy, except for the following: The new policy will have the same [ALERT_POLICY_ID] as the former policy. This gives you continuity with the former policy in your notifications and incidents. Conditions in the new policy will keep their former [CONDITION_ID] if the supplied condition includes the name field with that [CONDITION_ID]. If the supplied condition omits the name field, then a new [CONDITION_ID] is created. - * @param {().AlertPolicy} 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 + * The project on which to execute the request. The format is + * "projects/{project_id_or_number}". */ - patch( - params?: Params$Resource$Projects$Alertpolicies$Patch, - options?: MethodOptions): AxiosPromise; - patch( - params: Params$Resource$Projects$Alertpolicies$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Projects$Alertpolicies$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Projects$Alertpolicies$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Alertpolicies$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; + name?: string; - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Alertpolicies$Patch; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$MetricDescriptor; + } + export interface Params$Resource$Metricdescriptors$Delete extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The metric descriptor on which to execute the request. The format is + * "projects/{project_id_or_number}/metricDescriptors/{metric_id}". An + * example of {metric_id} is: "custom.googleapis.com/my_test_metric". + */ + name?: string; + } + export interface Params$Resource$Metricdescriptors$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The metric descriptor on which to execute the request. The format is + * "projects/{project_id_or_number}/metricDescriptors/{metric_id}". An + * example value of {metric_id} is + * "compute.googleapis.com/instance/disk/read_bytes_count". + */ + name?: string; + } + export interface Params$Resource$Metricdescriptors$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * If this field is empty, all custom and system-defined metric descriptors + * are returned. Otherwise, the filter specifies which metric descriptors + * are to be returned. For example, the following filter matches all custom + * metrics: metric.type = starts_with("custom.googleapis.com/") + */ + filter?: string; + /** + * The project on which to execute the request. The format is + * "projects/{project_id_or_number}". + */ + name?: string; + /** + * A positive number that is the maximum number of results to return. + */ + pageSize?: number; + /** + * If this field is not empty then it must contain the nextPageToken value + * returned by a previous call to this method. Using this field causes the + * method to return additional results from the previous method call. + */ + pageToken?: string; + } + + + export class Resource$Monitoredresourcedescriptors { + root: Monitoring; + constructor(root: Monitoring) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * monitoring.monitoredResourceDescriptors.get + * @desc Gets a single monitored resource descriptor. This method does not + * require a Stackdriver account. + * @alias monitoring.monitoredResourceDescriptors.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The monitored resource descriptor to get. The format is "projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}". The {resource_type} is a predefined type, such as cloudsql_database. + * @param {object} [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$Monitoredresourcedescriptors$Get, + options?: MethodOptions): + AxiosPromise; + get(params: Params$Resource$Monitoredresourcedescriptors$Get, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + get(params: Params$Resource$Monitoredresourcedescriptors$Get, + callback: BodyResponseCallback): + void; + get(callback: BodyResponseCallback): + void; + get(paramsOrCallback?: Params$Resource$Monitoredresourcedescriptors$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Monitoredresourcedescriptors$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Monitoredresourcedescriptors$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://monitoring.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * monitoring.monitoredResourceDescriptors.list + * @desc Lists monitored resource descriptors that match a filter. This + * method does not require a Stackdriver account. + * @alias monitoring.monitoredResourceDescriptors.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter An optional filter describing the descriptors to be returned. The filter can reference the descriptor's type and labels. For example, the following filter returns only Google Compute Engine descriptors that have an id label: resource.type = starts_with("gce_") AND resource.label:id + * @param {string} params.name The project on which to execute the request. The format is "projects/{project_id_or_number}". + * @param {integer=} params.pageSize A positive number that is the maximum number of results to return. + * @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. + * @param {object} [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$Monitoredresourcedescriptors$List, + options?: MethodOptions): + AxiosPromise; + list( + params: Params$Resource$Monitoredresourcedescriptors$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback< + Schema$ListMonitoredResourceDescriptorsResponse>): void; + list( + params: Params$Resource$Monitoredresourcedescriptors$List, + callback: BodyResponseCallback< + Schema$ListMonitoredResourceDescriptorsResponse>): void; + list(callback: BodyResponseCallback< + Schema$ListMonitoredResourceDescriptorsResponse>): void; + list( + paramsOrCallback?: Params$Resource$Monitoredresourcedescriptors$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$ListMonitoredResourceDescriptorsResponse>): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Monitoredresourcedescriptors$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Monitoredresourcedescriptors$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://monitoring.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+name}/monitoredResourceDescriptors') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest< + Schema$ListMonitoredResourceDescriptorsResponse>(parameters); + } + } + } + + export interface Params$Resource$Monitoredresourcedescriptors$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The monitored resource descriptor to get. The format is + * "projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}". + * The {resource_type} is a predefined type, such as cloudsql_database. + */ + name?: string; + } + export interface Params$Resource$Monitoredresourcedescriptors$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * An optional filter describing the descriptors to be returned. The filter + * can reference the descriptor's type and labels. For example, the + * following filter returns only Google Compute Engine descriptors that have + * an id label: resource.type = starts_with("gce_") AND resource.label:id + */ + filter?: string; + /** + * The project on which to execute the request. The format is + * "projects/{project_id_or_number}". + */ + name?: string; + /** + * A positive number that is the maximum number of results to return. + */ + pageSize?: number; + /** + * If this field is not empty then it must contain the nextPageToken value + * returned by a previous call to this method. Using this field causes the + * method to return additional results from the previous method call. + */ + pageToken?: string; + } + + + export class Resource$Projects { + root: Monitoring; + alertPolicies: Resource$Projects$Alertpolicies; + collectdTimeSeries: Resource$Projects$Collectdtimeseries; + groups: Resource$Projects$Groups; + metricDescriptors: Resource$Projects$Metricdescriptors; + monitoredResourceDescriptors: + Resource$Projects$Monitoredresourcedescriptors; + notificationChannelDescriptors: + Resource$Projects$Notificationchanneldescriptors; + notificationChannels: Resource$Projects$Notificationchannels; + timeSeries: Resource$Projects$Timeseries; + uptimeCheckConfigs: Resource$Projects$Uptimecheckconfigs; + constructor(root: Monitoring) { + this.root = root; + this.getRoot.bind(this); + this.alertPolicies = new Resource$Projects$Alertpolicies(root); + this.collectdTimeSeries = new Resource$Projects$Collectdtimeseries(root); + this.groups = new Resource$Projects$Groups(root); + this.metricDescriptors = new Resource$Projects$Metricdescriptors(root); + this.monitoredResourceDescriptors = + new Resource$Projects$Monitoredresourcedescriptors(root); + this.notificationChannelDescriptors = + new Resource$Projects$Notificationchanneldescriptors(root); + this.notificationChannels = + new Resource$Projects$Notificationchannels(root); + this.timeSeries = new Resource$Projects$Timeseries(root); + this.uptimeCheckConfigs = new Resource$Projects$Uptimecheckconfigs(root); + } + + getRoot() { + return this.root; + } + } + + + export class Resource$Projects$Alertpolicies { + root: Monitoring; + constructor(root: Monitoring) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * monitoring.projects.alertPolicies.create + * @desc Creates a new alerting policy. + * @alias monitoring.projects.alertPolicies.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The project in which to create the alerting policy. The format is projects/[PROJECT_ID].Note that this field names the parent container in which the alerting policy will be written, not the name of the created policy. The alerting policy that is returned will have a name that contains a normalized representation of this name as a prefix but adds a suffix of the form /alertPolicies/[POLICY_ID], identifying the policy in the container. + * @param {().AlertPolicy} 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$Alertpolicies$Create, + options?: MethodOptions): AxiosPromise; + create( + params: Params$Resource$Projects$Alertpolicies$Create, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + create( + params: Params$Resource$Projects$Alertpolicies$Create, + callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: Params$Resource$Projects$Alertpolicies$Create| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Alertpolicies$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Alertpolicies$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://monitoring.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+name}/alertPolicies') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * monitoring.projects.alertPolicies.delete + * @desc Deletes an alerting policy. + * @alias monitoring.projects.alertPolicies.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The alerting policy to delete. The format is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] For more information, see AlertPolicy. + * @param {object} [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$Alertpolicies$Delete, + options?: MethodOptions): AxiosPromise; + delete( + params: Params$Resource$Projects$Alertpolicies$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Projects$Alertpolicies$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Projects$Alertpolicies$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Alertpolicies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Alertpolicies$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://monitoring.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * monitoring.projects.alertPolicies.get + * @desc Gets a single alerting policy. + * @alias monitoring.projects.alertPolicies.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The alerting policy to retrieve. The format is projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_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 + */ + get(params?: Params$Resource$Projects$Alertpolicies$Get, + options?: MethodOptions): AxiosPromise; + get(params: Params$Resource$Projects$Alertpolicies$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Projects$Alertpolicies$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Projects$Alertpolicies$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Alertpolicies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Alertpolicies$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://monitoring.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * monitoring.projects.alertPolicies.list + * @desc Lists the existing alerting policies for the project. + * @alias monitoring.projects.alertPolicies.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter If provided, this field specifies the criteria that must be met by alert policies to be included in the response.For more details, see sorting and filtering. + * @param {string} params.name The project whose alert policies are to be listed. The format is projects/[PROJECT_ID] Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the GetAlertPolicy operation, instead. + * @param {string=} params.orderBy A comma-separated list of fields by which to sort the result. Supports the same set of field references as the filter field. Entries can be prefixed with a minus sign to sort by the field in descending order.For more details, see sorting and filtering. + * @param {integer=} params.pageSize The maximum number of results to return in a single response. + * @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. + * @param {object} [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$Alertpolicies$List, + options?: MethodOptions): + AxiosPromise; + list( + params: Params$Resource$Projects$Alertpolicies$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Projects$Alertpolicies$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Projects$Alertpolicies$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Alertpolicies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Alertpolicies$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://monitoring.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+name}/alertPolicies') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * monitoring.projects.alertPolicies.patch + * @desc Updates an alerting policy. You can either replace the entire + * policy with a new one or replace only certain fields in the current + * alerting policy by specifying the fields to be updated via updateMask. + * Returns the updated alerting policy. + * @alias monitoring.projects.alertPolicies.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required if the policy exists. The resource name for this policy. The syntax is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Stackdriver Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request. + * @param {string=} params.updateMask Optional. A list of alerting policy field names. If this field is not empty, each listed field in the existing alerting policy is set to the value of the corresponding field in the supplied policy (alert_policy), or to the field's default value if the field is not in the supplied alerting policy. Fields not listed retain their previous value.Examples of valid field masks include display_name, documentation, documentation.content, documentation.mime_type, user_labels, user_label.nameofkey, enabled, conditions, combiner, etc.If this field is empty, then the supplied alerting policy replaces the existing policy. It is the same as deleting the existing policy and adding the supplied policy, except for the following: The new policy will have the same [ALERT_POLICY_ID] as the former policy. This gives you continuity with the former policy in your notifications and incidents. Conditions in the new policy will keep their former [CONDITION_ID] if the supplied condition includes the name field with that [CONDITION_ID]. If the supplied condition omits the name field, then a new [CONDITION_ID] is created. + * @param {().AlertPolicy} 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 + */ + patch( + params?: Params$Resource$Projects$Alertpolicies$Patch, + options?: MethodOptions): AxiosPromise; + patch( + params: Params$Resource$Projects$Alertpolicies$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Projects$Alertpolicies$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Projects$Alertpolicies$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Alertpolicies$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Alertpolicies$Patch; + options = {}; + } if (typeof optionsOrCallback === 'function') { callback = optionsOrCallback; @@ -2318,7 +2958,8 @@ export namespace monitoring_v3 { } } - export interface Params$Resource$Projects$Alertpolicies$Create { + export interface Params$Resource$Projects$Alertpolicies$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2340,7 +2981,8 @@ export namespace monitoring_v3 { */ requestBody?: Schema$AlertPolicy; } - export interface Params$Resource$Projects$Alertpolicies$Delete { + export interface Params$Resource$Projects$Alertpolicies$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2353,7 +2995,8 @@ export namespace monitoring_v3 { */ name?: string; } - export interface Params$Resource$Projects$Alertpolicies$Get { + export interface Params$Resource$Projects$Alertpolicies$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2365,7 +3008,8 @@ export namespace monitoring_v3 { */ name?: string; } - export interface Params$Resource$Projects$Alertpolicies$List { + export interface Params$Resource$Projects$Alertpolicies$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2402,7 +3046,8 @@ export namespace monitoring_v3 { */ pageToken?: string; } - export interface Params$Resource$Projects$Alertpolicies$Patch { + export interface Params$Resource$Projects$Alertpolicies$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2581,7 +3226,8 @@ export namespace monitoring_v3 { } } - export interface Params$Resource$Projects$Collectdtimeseries$Create { + export interface Params$Resource$Projects$Collectdtimeseries$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3195,7 +3841,8 @@ export namespace monitoring_v3 { } } - export interface Params$Resource$Projects$Groups$Create { + export interface Params$Resource$Projects$Groups$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3216,7 +3863,8 @@ export namespace monitoring_v3 { */ requestBody?: Schema$Group; } - export interface Params$Resource$Projects$Groups$Delete { + export interface Params$Resource$Projects$Groups$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3228,7 +3876,8 @@ export namespace monitoring_v3 { */ name?: string; } - export interface Params$Resource$Projects$Groups$Get { + export interface Params$Resource$Projects$Groups$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3240,7 +3889,8 @@ export namespace monitoring_v3 { */ name?: string; } - export interface Params$Resource$Projects$Groups$List { + export interface Params$Resource$Projects$Groups$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3283,7 +3933,8 @@ export namespace monitoring_v3 { */ pageToken?: string; } - export interface Params$Resource$Projects$Groups$Update { + export interface Params$Resource$Projects$Groups$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3447,7 +4098,8 @@ export namespace monitoring_v3 { } } - export interface Params$Resource$Projects$Groups$Members$List { + export interface Params$Resource$Projects$Groups$Members$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3969,7 +4621,8 @@ export namespace monitoring_v3 { } } - export interface Params$Resource$Projects$Metricdescriptors$Create { + export interface Params$Resource$Projects$Metricdescriptors$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3986,7 +4639,8 @@ export namespace monitoring_v3 { */ requestBody?: Schema$MetricDescriptor; } - export interface Params$Resource$Projects$Metricdescriptors$Delete { + export interface Params$Resource$Projects$Metricdescriptors$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3999,7 +4653,8 @@ export namespace monitoring_v3 { */ name?: string; } - export interface Params$Resource$Projects$Metricdescriptors$Get { + export interface Params$Resource$Projects$Metricdescriptors$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4013,7 +4668,8 @@ export namespace monitoring_v3 { */ name?: string; } - export interface Params$Resource$Projects$Metricdescriptors$List { + export interface Params$Resource$Projects$Metricdescriptors$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4311,7 +4967,8 @@ export namespace monitoring_v3 { } } - export interface Params$Resource$Projects$Monitoredresourcedescriptors$Get { + export interface Params$Resource$Projects$Monitoredresourcedescriptors$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4324,7 +4981,8 @@ export namespace monitoring_v3 { */ name?: string; } - export interface Params$Resource$Projects$Monitoredresourcedescriptors$List { + export interface Params$Resource$Projects$Monitoredresourcedescriptors$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4521,7 +5179,8 @@ export namespace monitoring_v3 { } } - export interface Params$Resource$Projects$Notificationchanneldescriptors$Get { + export interface Params$Resource$Projects$Notificationchanneldescriptors$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4533,7 +5192,8 @@ export namespace monitoring_v3 { */ name?: string; } - export interface Params$Resource$Projects$Notificationchanneldescriptors$List { + export interface Params$Resource$Projects$Notificationchanneldescriptors$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5172,7 +5832,8 @@ export namespace monitoring_v3 { } } - export interface Params$Resource$Projects$Notificationchannels$Create { + export interface Params$Resource$Projects$Notificationchannels$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5193,7 +5854,8 @@ export namespace monitoring_v3 { */ requestBody?: Schema$NotificationChannel; } - export interface Params$Resource$Projects$Notificationchannels$Delete { + export interface Params$Resource$Projects$Notificationchannels$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5212,7 +5874,8 @@ export namespace monitoring_v3 { */ name?: string; } - export interface Params$Resource$Projects$Notificationchannels$Get { + export interface Params$Resource$Projects$Notificationchannels$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5224,7 +5887,8 @@ export namespace monitoring_v3 { */ name?: string; } - export interface Params$Resource$Projects$Notificationchannels$Getverificationcode { + export interface Params$Resource$Projects$Notificationchannels$Getverificationcode + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5242,7 +5906,8 @@ export namespace monitoring_v3 { */ requestBody?: Schema$GetNotificationChannelVerificationCodeRequest; } - export interface Params$Resource$Projects$Notificationchannels$List { + export interface Params$Resource$Projects$Notificationchannels$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5281,7 +5946,8 @@ export namespace monitoring_v3 { */ pageToken?: string; } - export interface Params$Resource$Projects$Notificationchannels$Patch { + export interface Params$Resource$Projects$Notificationchannels$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5303,7 +5969,8 @@ export namespace monitoring_v3 { */ requestBody?: Schema$NotificationChannel; } - export interface Params$Resource$Projects$Notificationchannels$Sendverificationcode { + export interface Params$Resource$Projects$Notificationchannels$Sendverificationcode + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5319,7 +5986,8 @@ export namespace monitoring_v3 { */ requestBody?: Schema$SendNotificationChannelVerificationCodeRequest; } - export interface Params$Resource$Projects$Notificationchannels$Verify { + export interface Params$Resource$Projects$Notificationchannels$Verify extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5599,7 +6267,8 @@ export namespace monitoring_v3 { } } - export interface Params$Resource$Projects$Timeseries$Create { + export interface Params$Resource$Projects$Timeseries$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5616,7 +6285,8 @@ export namespace monitoring_v3 { */ requestBody?: Schema$CreateTimeSeriesRequest; } - export interface Params$Resource$Projects$Timeseries$List { + export interface Params$Resource$Projects$Timeseries$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5929,50 +6599,305 @@ export namespace monitoring_v3 { /** - * monitoring.projects.uptimeCheckConfigs.list - * @desc Lists the existing valid uptime check configurations for the - * project, leaving out any invalid configurations. - * @alias monitoring.projects.uptimeCheckConfigs.list + * monitoring.projects.uptimeCheckConfigs.list + * @desc Lists the existing valid uptime check configurations for the + * project, leaving out any invalid configurations. + * @alias monitoring.projects.uptimeCheckConfigs.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is <=0, the server will decide the number of results to be returned. + * @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. + * @param {string} params.parent The project whose uptime check configurations are listed. The format is 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 + */ + list( + params?: Params$Resource$Projects$Uptimecheckconfigs$List, + options?: MethodOptions): + AxiosPromise; + list( + params: Params$Resource$Projects$Uptimecheckconfigs$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + list( + params: Params$Resource$Projects$Uptimecheckconfigs$List, + callback: BodyResponseCallback): + void; + list(callback: BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Projects$Uptimecheckconfigs$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Uptimecheckconfigs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Uptimecheckconfigs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://monitoring.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+parent}/uptimeCheckConfigs') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + + + /** + * monitoring.projects.uptimeCheckConfigs.patch + * @desc Updates an uptime check configuration. You can either replace the + * entire configuration with a new one or replace only certain fields in the + * current configuration by specifying the fields to be updated via + * "updateMask". Returns the updated configuration. + * @alias monitoring.projects.uptimeCheckConfigs.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name A unique resource name for this UptimeCheckConfig. The format is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field should be omitted when creating the uptime check configuration; on create, the resource name is assigned by the server and included in the response. + * @param {string=} params.updateMask Optional. If present, only the listed fields in the current uptime check configuration are updated with values from the new configuration. If this field is empty, then the current configuration is completely replaced with the new configuration. + * @param {().UptimeCheckConfig} 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 + */ + patch( + params?: Params$Resource$Projects$Uptimecheckconfigs$Patch, + options?: MethodOptions): AxiosPromise; + patch( + params: Params$Resource$Projects$Uptimecheckconfigs$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Projects$Uptimecheckconfigs$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Projects$Uptimecheckconfigs$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Uptimecheckconfigs$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Uptimecheckconfigs$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://monitoring.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Uptimecheckconfigs$Create extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The project in which to create the uptime check. The format is + * projects/[PROJECT_ID]. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UptimeCheckConfig; + } + export interface Params$Resource$Projects$Uptimecheckconfigs$Delete extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The uptime check configuration to delete. The format is + * projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]. + */ + name?: string; + } + export interface Params$Resource$Projects$Uptimecheckconfigs$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The uptime check configuration to retrieve. The format is + * projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]. + */ + name?: string; + } + export interface Params$Resource$Projects$Uptimecheckconfigs$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The maximum number of results to return in a single response. The server + * may further constrain the maximum number of results returned in a single + * page. If the page_size is <=0, the server will decide the number of + * results to be returned. + */ + pageSize?: number; + /** + * If this field is not empty then it must contain the nextPageToken value + * returned by a previous call to this method. Using this field causes the + * method to return more results from the previous method call. + */ + pageToken?: string; + /** + * The project whose uptime check configurations are listed. The format is + * projects/[PROJECT_ID]. + */ + parent?: string; + } + export interface Params$Resource$Projects$Uptimecheckconfigs$Patch extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A unique resource name for this UptimeCheckConfig. The format + * is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field + * should be omitted when creating the uptime check configuration; on + * create, the resource name is assigned by the server and included in the + * response. + */ + name?: string; + /** + * Optional. If present, only the listed fields in the current uptime check + * configuration are updated with values from the new configuration. If this + * field is empty, then the current configuration is completely replaced + * with the new configuration. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UptimeCheckConfig; + } + + + + export class Resource$Timeseries { + root: Monitoring; + constructor(root: Monitoring) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * monitoring.timeSeries.create + * @desc Creates or adds data to one or more time series. The response is + * empty if all time series in the request were written. If any time series + * could not be written, a corresponding failure message is included in the + * error response. + * @alias monitoring.timeSeries.create * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is <=0, the server will decide the number of results to be returned. - * @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. - * @param {string} params.parent The project whose uptime check configurations are listed. The format is projects/[PROJECT_ID]. + * @param {string} params.name The project on which to execute the request. The format is "projects/{project_id_or_number}". + * @param {().CreateTimeSeriesRequest} 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 */ - list( - params?: Params$Resource$Projects$Uptimecheckconfigs$List, - options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Projects$Uptimecheckconfigs$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - list( - params: Params$Resource$Projects$Uptimecheckconfigs$List, - callback: BodyResponseCallback): - void; - list(callback: BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Projects$Uptimecheckconfigs$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Uptimecheckconfigs$List; + create(params?: Params$Resource$Timeseries$Create, options?: MethodOptions): + AxiosPromise; + create( + params: Params$Resource$Timeseries$Create, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + create( + params: Params$Resource$Timeseries$Create, + callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: Params$Resource$Timeseries$Create| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Timeseries$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Uptimecheckconfigs$List; + params = {} as Params$Resource$Timeseries$Create; options = {}; } @@ -5985,68 +6910,72 @@ export namespace monitoring_v3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v3/{+parent}/uptimeCheckConfigs') + url: (rootUrl + '/v3/{+name}/timeSeries') .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' + method: 'POST' }, options), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.getRoot() }; if (callback) { - createAPIRequest( - parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest( - parameters); + return createAPIRequest(parameters); } } /** - * monitoring.projects.uptimeCheckConfigs.patch - * @desc Updates an uptime check configuration. You can either replace the - * entire configuration with a new one or replace only certain fields in the - * current configuration by specifying the fields to be updated via - * "updateMask". Returns the updated configuration. - * @alias monitoring.projects.uptimeCheckConfigs.patch + * monitoring.timeSeries.list + * @desc Lists time series that match a filter. This method does not require + * a Stackdriver account. + * @alias monitoring.timeSeries.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name A unique resource name for this UptimeCheckConfig. The format is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field should be omitted when creating the uptime check configuration; on create, the resource name is assigned by the server and included in the response. - * @param {string=} params.updateMask Optional. If present, only the listed fields in the current uptime check configuration are updated with values from the new configuration. If this field is empty, then the current configuration is completely replaced with the new configuration. - * @param {().UptimeCheckConfig} params.resource Request body data + * @param {string=} params.aggregation.alignmentPeriod The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned. + * @param {string=} params.aggregation.crossSeriesReducer The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. + * @param {string=} params.aggregation.groupByFields The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored. + * @param {string=} params.aggregation.perSeriesAligner The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. + * @param {string=} params.filter A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example: metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND metric.label.instance_name = "my-instance-name" + * @param {string=} params.interval.endTime Required. The end of the time interval. + * @param {string=} params.interval.startTime Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time. + * @param {string} params.name The project on which to execute the request. The format is "projects/{project_id_or_number}". + * @param {string=} params.orderBy Unsupported: must be left blank. The points in each time series are returned in reverse time order. + * @param {integer=} params.pageSize A positive number that is the maximum number of results to return. If page_size is empty or more than 100,000 results, the effective page_size is 100,000 results. If view is set to FULL, this is the maximum number of Points returned. If view is set to HEADERS, this is the maximum number of TimeSeries returned. + * @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. + * @param {string=} params.view Specifies which information is returned about the time series. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - patch( - params?: Params$Resource$Projects$Uptimecheckconfigs$Patch, - options?: MethodOptions): AxiosPromise; - patch( - params: Params$Resource$Projects$Uptimecheckconfigs$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Projects$Uptimecheckconfigs$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Projects$Uptimecheckconfigs$Patch| - BodyResponseCallback, + list(params?: Params$Resource$Timeseries$List, options?: MethodOptions): + AxiosPromise; + list( + params: Params$Resource$Timeseries$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Timeseries$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Timeseries$List| + BodyResponseCallback, optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Uptimecheckconfigs$Patch; + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Timeseries$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Uptimecheckconfigs$Patch; + params = {} as Params$Resource$Timeseries$List; options = {}; } @@ -6059,8 +6988,9 @@ export namespace monitoring_v3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v3/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' + url: (rootUrl + '/v3/{+name}/timeSeries') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' }, options), params, @@ -6069,109 +6999,133 @@ export namespace monitoring_v3 { context: this.getRoot() }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Uptimecheckconfigs$Create { + export interface Params$Resource$Timeseries$Create extends + StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * The project in which to create the uptime check. The format is - * projects/[PROJECT_ID]. + * The project on which to execute the request. The format is + * "projects/{project_id_or_number}". */ - parent?: string; + name?: string; /** * Request body metadata */ - requestBody?: Schema$UptimeCheckConfig; + requestBody?: Schema$CreateTimeSeriesRequest; } - export interface Params$Resource$Projects$Uptimecheckconfigs$Delete { + export interface Params$Resource$Timeseries$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * The uptime check configuration to delete. The format is - * projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]. + * The alignment period for per-time series alignment. If present, + * alignmentPeriod must be at least 60 seconds. After per-time series + * alignment, each time series will contain data points only on the period + * boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, + * then this field is ignored. If perSeriesAligner is specified and does not + * equal ALIGN_NONE, then this field must be defined; otherwise an error is + * returned. */ - name?: string; - } - export interface Params$Resource$Projects$Uptimecheckconfigs$Get { + 'aggregation.alignmentPeriod'?: string; /** - * Auth client or API Key for the request + * The approach to be used to combine time series. Not all reducer functions + * may be applied to all time series, depending on the metric type and the + * value type of the original time series. Reduction may change the metric + * type of value type of the time series.Time series data must be aligned in + * order to perform cross-time series reduction. If crossSeriesReducer is + * specified, then perSeriesAligner must be specified and not equal + * ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is + * returned. */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - + 'aggregation.crossSeriesReducer'?: string; /** - * The uptime check configuration to retrieve. The format is - * projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]. + * The set of fields to preserve when crossSeriesReducer is specified. The + * groupByFields determine how the time series are partitioned into subsets + * prior to applying the aggregation function. Each subset contains time + * series that have the same value for each of the grouping fields. Each + * individual time series is a member of exactly one subset. The + * crossSeriesReducer is applied to each subset of time series. It is not + * possible to reduce across different resource types, so this field + * implicitly contains resource.type. Fields not specified in groupByFields + * are aggregated away. If groupByFields is not specified and all the time + * series have the same resource type, then the time series are aggregated + * into a single output time series. If crossSeriesReducer is not defined, + * this field is ignored. */ - name?: string; - } - export interface Params$Resource$Projects$Uptimecheckconfigs$List { + 'aggregation.groupByFields'?: string; /** - * Auth client or API Key for the request + * The approach to be used to align individual time series. Not all + * alignment functions may be applied to all time series, depending on the + * metric type and value type of the original time series. Alignment may + * change the metric type or the value type of the time series.Time series + * data must be aligned in order to perform cross-time series reduction. If + * crossSeriesReducer is specified, then perSeriesAligner must be specified + * and not equal ALIGN_NONE and alignmentPeriod must be specified; + * otherwise, an error is returned. */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - + 'aggregation.perSeriesAligner'?: string; /** - * The maximum number of results to return in a single response. The server - * may further constrain the maximum number of results returned in a single - * page. If the page_size is <=0, the server will decide the number of - * results to be returned. + * A monitoring filter that specifies which time series should be returned. + * The filter must specify a single metric type, and can additionally + * specify metric labels and other information. For example: metric.type = + * "compute.googleapis.com/instance/cpu/usage_time" AND + * metric.label.instance_name = "my-instance-name" */ - pageSize?: number; + filter?: string; /** - * If this field is not empty then it must contain the nextPageToken value - * returned by a previous call to this method. Using this field causes the - * method to return more results from the previous method call. + * Required. The end of the time interval. */ - pageToken?: string; + 'interval.endTime'?: string; /** - * The project whose uptime check configurations are listed. The format is - * projects/[PROJECT_ID]. + * Optional. The beginning of the time interval. The default value for the + * start time is the end time. The start time must not be later than the end + * time. */ - parent?: string; - } - export interface Params$Resource$Projects$Uptimecheckconfigs$Patch { + 'interval.startTime'?: string; /** - * Auth client or API Key for the request + * The project on which to execute the request. The format is + * "projects/{project_id_or_number}". */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - + name?: string; /** - * A unique resource name for this UptimeCheckConfig. The format - * is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field - * should be omitted when creating the uptime check configuration; on - * create, the resource name is assigned by the server and included in the - * response. + * Unsupported: must be left blank. The points in each time series are + * returned in reverse time order. */ - name?: string; + orderBy?: string; /** - * Optional. If present, only the listed fields in the current uptime check - * configuration are updated with values from the new configuration. If this - * field is empty, then the current configuration is completely replaced - * with the new configuration. + * A positive number that is the maximum number of results to return. If + * page_size is empty or more than 100,000 results, the effective page_size + * is 100,000 results. If view is set to FULL, this is the maximum number of + * Points returned. If view is set to HEADERS, this is the maximum number of + * TimeSeries returned. */ - updateMask?: string; - + pageSize?: number; /** - * Request body metadata + * If this field is not empty then it must contain the nextPageToken value + * returned by a previous call to this method. Using this field causes the + * method to return additional results from the previous method call. */ - requestBody?: Schema$UptimeCheckConfig; + pageToken?: string; + /** + * Specifies which information is returned about the time series. + */ + view?: string; } - export class Resource$Uptimecheckips { root: Monitoring; constructor(root: Monitoring) { @@ -6256,7 +7210,8 @@ export namespace monitoring_v3 { } } - export interface Params$Resource$Uptimecheckips$List { + export interface Params$Resource$Uptimecheckips$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/oauth2/v1.ts b/src/apis/oauth2/v1.ts index 81436e26da..083e195a6b 100644 --- a/src/apis/oauth2/v1.ts +++ b/src/apis/oauth2/v1.ts @@ -29,6 +29,40 @@ export namespace oauth2_v1 { version: 'v1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Google OAuth2 API * @@ -556,19 +590,20 @@ export namespace oauth2_v1 { } export interface Schema$X509 {} - export interface Params$$Getcertforopenidconnect { + export interface Params$$Getcertforopenidconnect extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; } - export interface Params$$Getcertforopenidconnectraw { + export interface Params$$Getcertforopenidconnectraw extends + StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; } - export interface Params$$Getrobotjwk { + export interface Params$$Getrobotjwk extends StandardParameters { /** * Auth client or API Key for the request */ @@ -579,7 +614,7 @@ export namespace oauth2_v1 { */ robotEmail?: string; } - export interface Params$$Getrobotmetadataraw { + export interface Params$$Getrobotmetadataraw extends StandardParameters { /** * Auth client or API Key for the request */ @@ -590,7 +625,7 @@ export namespace oauth2_v1 { */ robotEmail?: string; } - export interface Params$$Getrobotmetadatax509 { + export interface Params$$Getrobotmetadatax509 extends StandardParameters { /** * Auth client or API Key for the request */ @@ -601,7 +636,7 @@ export namespace oauth2_v1 { */ robotEmail?: string; } - export interface Params$$Tokeninfo { + export interface Params$$Tokeninfo extends StandardParameters { /** * Auth client or API Key for the request */ @@ -692,7 +727,7 @@ export namespace oauth2_v1 { } } - export interface Params$Resource$Userinfo$Get { + export interface Params$Resource$Userinfo$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -787,7 +822,8 @@ export namespace oauth2_v1 { } } - export interface Params$Resource$Userinfo$V2$Me$Get { + export interface Params$Resource$Userinfo$V2$Me$Get extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/oauth2/v2.ts b/src/apis/oauth2/v2.ts index 350a600c4f..7507b8c19d 100644 --- a/src/apis/oauth2/v2.ts +++ b/src/apis/oauth2/v2.ts @@ -29,6 +29,40 @@ export namespace oauth2_v2 { version: 'v2'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Google OAuth2 API * @@ -284,13 +318,13 @@ export namespace oauth2_v2 { verified_email?: boolean; } - export interface Params$$Getcertforopenidconnect { + export interface Params$$Getcertforopenidconnect extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; } - export interface Params$$Tokeninfo { + export interface Params$$Tokeninfo extends StandardParameters { /** * Auth client or API Key for the request */ @@ -384,7 +418,7 @@ export namespace oauth2_v2 { } } - export interface Params$Resource$Userinfo$Get { + export interface Params$Resource$Userinfo$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -478,7 +512,8 @@ export namespace oauth2_v2 { } } - export interface Params$Resource$Userinfo$V2$Me$Get { + export interface Params$Resource$Userinfo$V2$Me$Get extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/oslogin/v1.ts b/src/apis/oslogin/v1.ts index e8c6b24333..0e8d47d3b3 100644 --- a/src/apis/oslogin/v1.ts +++ b/src/apis/oslogin/v1.ts @@ -29,6 +29,57 @@ export namespace oslogin_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud OS Login API * @@ -191,6 +242,8 @@ export namespace oslogin_v1 { * * @param {object} params Parameters for request * @param {string} params.name The unique ID for the user in format `users/{user}`. + * @param {string=} params.projectId The project ID of the Google Cloud Platform project. + * @param {string=} params.systemId A system ID for filtering the results of the 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 @@ -328,7 +381,8 @@ export namespace oslogin_v1 { } } - export interface Params$Resource$Users$Getloginprofile { + export interface Params$Resource$Users$Getloginprofile extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -338,8 +392,17 @@ export namespace oslogin_v1 { * The unique ID for the user in format `users/{user}`. */ name?: string; + /** + * The project ID of the Google Cloud Platform project. + */ + projectId?: string; + /** + * A system ID for filtering the results of the request. + */ + systemId?: string; } - export interface Params$Resource$Users$Importsshpublickey { + export interface Params$Resource$Users$Importsshpublickey extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -437,7 +500,8 @@ export namespace oslogin_v1 { } } - export interface Params$Resource$Users$Projects$Delete { + export interface Params$Resource$Users$Projects$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -660,7 +724,8 @@ export namespace oslogin_v1 { } } - export interface Params$Resource$Users$Sshpublickeys$Delete { + export interface Params$Resource$Users$Sshpublickeys$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -673,7 +738,8 @@ export namespace oslogin_v1 { */ name?: string; } - export interface Params$Resource$Users$Sshpublickeys$Get { + export interface Params$Resource$Users$Sshpublickeys$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -686,7 +752,8 @@ export namespace oslogin_v1 { */ name?: string; } - export interface Params$Resource$Users$Sshpublickeys$Patch { + export interface Params$Resource$Users$Sshpublickeys$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/oslogin/v1alpha.ts b/src/apis/oslogin/v1alpha.ts index c9f30f1623..6e3d324a19 100644 --- a/src/apis/oslogin/v1alpha.ts +++ b/src/apis/oslogin/v1alpha.ts @@ -29,6 +29,57 @@ export namespace oslogin_v1alpha { version: 'v1alpha'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud OS Login API * @@ -191,6 +242,9 @@ export namespace oslogin_v1alpha { * * @param {object} params Parameters for request * @param {string} params.name The unique ID for the user in format `users/{user}`. + * @param {string=} params.operatingSystemType The type of operating system associated with the account. + * @param {string=} params.projectId The project ID of the Google Cloud Platform project. + * @param {string=} params.systemId A system ID for filtering the results of the 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 @@ -328,7 +382,8 @@ export namespace oslogin_v1alpha { } } - export interface Params$Resource$Users$Getloginprofile { + export interface Params$Resource$Users$Getloginprofile extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -338,8 +393,21 @@ export namespace oslogin_v1alpha { * The unique ID for the user in format `users/{user}`. */ name?: string; + /** + * The type of operating system associated with the account. + */ + operatingSystemType?: string; + /** + * The project ID of the Google Cloud Platform project. + */ + projectId?: string; + /** + * A system ID for filtering the results of the request. + */ + systemId?: string; } - export interface Params$Resource$Users$Importsshpublickey { + export interface Params$Resource$Users$Importsshpublickey extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -438,7 +506,8 @@ export namespace oslogin_v1alpha { } } - export interface Params$Resource$Users$Projects$Delete { + export interface Params$Resource$Users$Projects$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -665,7 +734,8 @@ export namespace oslogin_v1alpha { } } - export interface Params$Resource$Users$Sshpublickeys$Delete { + export interface Params$Resource$Users$Sshpublickeys$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -678,7 +748,8 @@ export namespace oslogin_v1alpha { */ name?: string; } - export interface Params$Resource$Users$Sshpublickeys$Get { + export interface Params$Resource$Users$Sshpublickeys$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -691,7 +762,8 @@ export namespace oslogin_v1alpha { */ name?: string; } - export interface Params$Resource$Users$Sshpublickeys$Patch { + export interface Params$Resource$Users$Sshpublickeys$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/oslogin/v1beta.ts b/src/apis/oslogin/v1beta.ts index c3c81640dd..2cd9013592 100644 --- a/src/apis/oslogin/v1beta.ts +++ b/src/apis/oslogin/v1beta.ts @@ -29,6 +29,57 @@ export namespace oslogin_v1beta { version: 'v1beta'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud OS Login API * @@ -191,6 +242,8 @@ export namespace oslogin_v1beta { * * @param {object} params Parameters for request * @param {string} params.name The unique ID for the user in format `users/{user}`. + * @param {string=} params.projectId The project ID of the Google Cloud Platform project. + * @param {string=} params.systemId A system ID for filtering the results of the 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 @@ -328,7 +381,8 @@ export namespace oslogin_v1beta { } } - export interface Params$Resource$Users$Getloginprofile { + export interface Params$Resource$Users$Getloginprofile extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -338,8 +392,17 @@ export namespace oslogin_v1beta { * The unique ID for the user in format `users/{user}`. */ name?: string; + /** + * The project ID of the Google Cloud Platform project. + */ + projectId?: string; + /** + * A system ID for filtering the results of the request. + */ + systemId?: string; } - export interface Params$Resource$Users$Importsshpublickey { + export interface Params$Resource$Users$Importsshpublickey extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -437,7 +500,8 @@ export namespace oslogin_v1beta { } } - export interface Params$Resource$Users$Projects$Delete { + export interface Params$Resource$Users$Projects$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -660,7 +724,8 @@ export namespace oslogin_v1beta { } } - export interface Params$Resource$Users$Sshpublickeys$Delete { + export interface Params$Resource$Users$Sshpublickeys$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -673,7 +738,8 @@ export namespace oslogin_v1beta { */ name?: string; } - export interface Params$Resource$Users$Sshpublickeys$Get { + export interface Params$Resource$Users$Sshpublickeys$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -686,7 +752,8 @@ export namespace oslogin_v1beta { */ name?: string; } - export interface Params$Resource$Users$Sshpublickeys$Patch { + export interface Params$Resource$Users$Sshpublickeys$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/pagespeedonline/v1.ts b/src/apis/pagespeedonline/v1.ts index 8579d21663..452fe24fef 100644 --- a/src/apis/pagespeedonline/v1.ts +++ b/src/apis/pagespeedonline/v1.ts @@ -29,6 +29,40 @@ export namespace pagespeedonline_v1 { version: 'v1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * PageSpeed Insights API * @@ -205,7 +239,8 @@ export namespace pagespeedonline_v1 { } } - export interface Params$Resource$Pagespeedapi$Runpagespeed { + export interface Params$Resource$Pagespeedapi$Runpagespeed extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/pagespeedonline/v2.ts b/src/apis/pagespeedonline/v2.ts index e3182ce003..27e675ddfe 100644 --- a/src/apis/pagespeedonline/v2.ts +++ b/src/apis/pagespeedonline/v2.ts @@ -29,6 +29,40 @@ export namespace pagespeedonline_v2 { version: 'v2'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * PageSpeed Insights API * @@ -243,7 +277,8 @@ export namespace pagespeedonline_v2 { } } - export interface Params$Resource$Pagespeedapi$Runpagespeed { + export interface Params$Resource$Pagespeedapi$Runpagespeed extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/pagespeedonline/v4.ts b/src/apis/pagespeedonline/v4.ts index 551723ace6..e0497e9e0f 100644 --- a/src/apis/pagespeedonline/v4.ts +++ b/src/apis/pagespeedonline/v4.ts @@ -29,6 +29,40 @@ export namespace pagespeedonline_v4 { version: 'v4'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * PageSpeed Insights API * @@ -261,7 +295,8 @@ export namespace pagespeedonline_v4 { } } - export interface Params$Resource$Pagespeedapi$Runpagespeed { + export interface Params$Resource$Pagespeedapi$Runpagespeed extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/partners/v2.ts b/src/apis/partners/v2.ts index 1abe030901..18fe80aa42 100644 --- a/src/apis/partners/v2.ts +++ b/src/apis/partners/v2.ts @@ -29,6 +29,57 @@ export namespace partners_v2 { version: 'v2'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Google Partners API * @@ -1484,7 +1535,7 @@ export namespace partners_v2 { } } - export interface Params$Resource$Analytics$List { + export interface Params$Resource$Analytics$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1619,7 +1670,8 @@ export namespace partners_v2 { } } - export interface Params$Resource$Clientmessages$Log { + export interface Params$Resource$Clientmessages$Log extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1809,7 +1861,7 @@ export namespace partners_v2 { } } - export interface Params$Resource$Companies$Get { + export interface Params$Resource$Companies$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1874,7 +1926,7 @@ export namespace partners_v2 { */ view?: string; } - export interface Params$Resource$Companies$List { + export interface Params$Resource$Companies$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2092,7 +2144,8 @@ export namespace partners_v2 { } } - export interface Params$Resource$Companies$Leads$Create { + export interface Params$Resource$Companies$Leads$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2197,7 +2250,7 @@ export namespace partners_v2 { } } - export interface Params$Resource$Leads$List { + export interface Params$Resource$Leads$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2337,7 +2390,7 @@ export namespace partners_v2 { } } - export interface Params$Resource$Offers$List { + export interface Params$Resource$Offers$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2468,7 +2521,8 @@ export namespace partners_v2 { } } - export interface Params$Resource$Offers$History$List { + export interface Params$Resource$Offers$History$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2603,7 +2657,7 @@ export namespace partners_v2 { } } - export interface Params$Resource$Userevents$Log { + export interface Params$Resource$Userevents$Log extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2924,7 +2978,8 @@ export namespace partners_v2 { } } - export interface Params$Resource$Users$Createcompanyrelation { + export interface Params$Resource$Users$Createcompanyrelation extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2972,7 +3027,8 @@ export namespace partners_v2 { */ requestBody?: Schema$CompanyRelation; } - export interface Params$Resource$Users$Deletecompanyrelation { + export interface Params$Resource$Users$Deletecompanyrelation extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3015,7 +3071,7 @@ export namespace partners_v2 { */ userId?: string; } - export interface Params$Resource$Users$Get { + export interface Params$Resource$Users$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3062,7 +3118,8 @@ export namespace partners_v2 { */ userView?: string; } - export interface Params$Resource$Users$Updateprofile { + export interface Params$Resource$Users$Updateprofile extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3190,7 +3247,7 @@ export namespace partners_v2 { } } - export interface Params$Resource$Userstates$List { + export interface Params$Resource$Userstates$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3465,7 +3522,8 @@ export namespace partners_v2 { } } - export interface Params$Resource$V2$Getpartnersstatus { + export interface Params$Resource$V2$Getpartnersstatus extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3503,7 +3561,8 @@ export namespace partners_v2 { */ 'requestMetadata.userOverrides.userId'?: string; } - export interface Params$Resource$V2$Updatecompanies { + export interface Params$Resource$V2$Updatecompanies extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3551,7 +3610,7 @@ export namespace partners_v2 { */ requestBody?: Schema$Company; } - export interface Params$Resource$V2$Updateleads { + export interface Params$Resource$V2$Updateleads extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/people/v1.ts b/src/apis/people/v1.ts index f1a93d498a..cc35f6b74c 100644 --- a/src/apis/people/v1.ts +++ b/src/apis/people/v1.ts @@ -29,6 +29,57 @@ export namespace people_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * People API * @@ -1735,7 +1786,8 @@ export namespace people_v1 { } } - export interface Params$Resource$Contactgroups$Batchget { + export interface Params$Resource$Contactgroups$Batchget extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1750,7 +1802,8 @@ export namespace people_v1 { */ resourceNames?: string; } - export interface Params$Resource$Contactgroups$Create { + export interface Params$Resource$Contactgroups$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1762,7 +1815,8 @@ export namespace people_v1 { */ requestBody?: Schema$CreateContactGroupRequest; } - export interface Params$Resource$Contactgroups$Delete { + export interface Params$Resource$Contactgroups$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1777,7 +1831,8 @@ export namespace people_v1 { */ resourceName?: string; } - export interface Params$Resource$Contactgroups$Get { + export interface Params$Resource$Contactgroups$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1792,7 +1847,8 @@ export namespace people_v1 { */ resourceName?: string; } - export interface Params$Resource$Contactgroups$List { + export interface Params$Resource$Contactgroups$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1814,7 +1870,8 @@ export namespace people_v1 { */ syncToken?: string; } - export interface Params$Resource$Contactgroups$Update { + export interface Params$Resource$Contactgroups$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1924,7 +1981,8 @@ export namespace people_v1 { } } - export interface Params$Resource$Contactgroups$Members$Modify { + export interface Params$Resource$Contactgroups$Members$Modify extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2304,7 +2362,8 @@ export namespace people_v1 { } } - export interface Params$Resource$People$Createcontact { + export interface Params$Resource$People$Createcontact extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2320,7 +2379,8 @@ export namespace people_v1 { */ requestBody?: Schema$Person; } - export interface Params$Resource$People$Deletecontact { + export interface Params$Resource$People$Deletecontact extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2331,7 +2391,7 @@ export namespace people_v1 { */ resourceName?: string; } - export interface Params$Resource$People$Get { + export interface Params$Resource$People$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2364,7 +2424,8 @@ export namespace people_v1 { */ resourceName?: string; } - export interface Params$Resource$People$Getbatchget { + export interface Params$Resource$People$Getbatchget extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2398,7 +2459,8 @@ export namespace people_v1 { */ resourceNames?: string; } - export interface Params$Resource$People$Updatecontact { + export interface Params$Resource$People$Updatecontact extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2515,7 +2577,8 @@ export namespace people_v1 { } } - export interface Params$Resource$People$Connections$List { + export interface Params$Resource$People$Connections$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/playcustomapp/v1.ts b/src/apis/playcustomapp/v1.ts index f8e9c23001..dc862a7668 100644 --- a/src/apis/playcustomapp/v1.ts +++ b/src/apis/playcustomapp/v1.ts @@ -29,6 +29,40 @@ export namespace playcustomapp_v1 { version: 'v1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Google Play Custom App Publishing API * @@ -180,7 +214,8 @@ export namespace playcustomapp_v1 { } } - export interface Params$Resource$Accounts$Customapps$Create { + export interface Params$Resource$Accounts$Customapps$Create extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/plus/v1.ts b/src/apis/plus/v1.ts index 6addbeafe8..831be89193 100644 --- a/src/apis/plus/v1.ts +++ b/src/apis/plus/v1.ts @@ -29,6 +29,40 @@ export namespace plus_v1 { version: 'v1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Google+ API * @@ -747,7 +781,7 @@ export namespace plus_v1 { } } - export interface Params$Resource$Activities$Get { + export interface Params$Resource$Activities$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -758,7 +792,7 @@ export namespace plus_v1 { */ activityId?: string; } - export interface Params$Resource$Activities$List { + export interface Params$Resource$Activities$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -786,7 +820,8 @@ export namespace plus_v1 { */ userId?: string; } - export interface Params$Resource$Activities$Search { + export interface Params$Resource$Activities$Search extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -962,7 +997,7 @@ export namespace plus_v1 { } } - export interface Params$Resource$Comments$Get { + export interface Params$Resource$Comments$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -973,7 +1008,7 @@ export namespace plus_v1 { */ commentId?: string; } - export interface Params$Resource$Comments$List { + export interface Params$Resource$Comments$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1285,7 +1320,7 @@ export namespace plus_v1 { } } - export interface Params$Resource$People$Get { + export interface Params$Resource$People$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1297,7 +1332,7 @@ export namespace plus_v1 { */ userId?: string; } - export interface Params$Resource$People$List { + export interface Params$Resource$People$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1329,7 +1364,8 @@ export namespace plus_v1 { */ userId?: string; } - export interface Params$Resource$People$Listbyactivity { + export interface Params$Resource$People$Listbyactivity extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1356,7 +1392,7 @@ export namespace plus_v1 { */ pageToken?: string; } - export interface Params$Resource$People$Search { + export interface Params$Resource$People$Search extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/plusDomains/v1.ts b/src/apis/plusDomains/v1.ts index ddb279d6db..dad9f2f5a5 100644 --- a/src/apis/plusDomains/v1.ts +++ b/src/apis/plusDomains/v1.ts @@ -29,6 +29,40 @@ export namespace plusDomains_v1 { version: 'v1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Google+ Domains API * @@ -968,7 +1002,7 @@ export namespace plusDomains_v1 { } } - export interface Params$Resource$Activities$Get { + export interface Params$Resource$Activities$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -979,7 +1013,8 @@ export namespace plusDomains_v1 { */ activityId?: string; } - export interface Params$Resource$Activities$Insert { + export interface Params$Resource$Activities$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1002,7 +1037,7 @@ export namespace plusDomains_v1 { */ requestBody?: Schema$Activity; } - export interface Params$Resource$Activities$List { + export interface Params$Resource$Activities$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1111,7 +1146,7 @@ export namespace plusDomains_v1 { } } - export interface Params$Resource$Audiences$List { + export interface Params$Resource$Audiences$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1672,7 +1707,8 @@ export namespace plusDomains_v1 { } } - export interface Params$Resource$Circles$Addpeople { + export interface Params$Resource$Circles$Addpeople extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1691,7 +1727,7 @@ export namespace plusDomains_v1 { */ userId?: string; } - export interface Params$Resource$Circles$Get { + export interface Params$Resource$Circles$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1702,7 +1738,7 @@ export namespace plusDomains_v1 { */ circleId?: string; } - export interface Params$Resource$Circles$Insert { + export interface Params$Resource$Circles$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1719,7 +1755,7 @@ export namespace plusDomains_v1 { */ requestBody?: Schema$Circle; } - export interface Params$Resource$Circles$List { + export interface Params$Resource$Circles$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1743,7 +1779,7 @@ export namespace plusDomains_v1 { */ userId?: string; } - export interface Params$Resource$Circles$Patch { + export interface Params$Resource$Circles$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1759,7 +1795,7 @@ export namespace plusDomains_v1 { */ requestBody?: Schema$Circle; } - export interface Params$Resource$Circles$Remove { + export interface Params$Resource$Circles$Remove extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1770,7 +1806,8 @@ export namespace plusDomains_v1 { */ circleId?: string; } - export interface Params$Resource$Circles$Removepeople { + export interface Params$Resource$Circles$Removepeople extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1789,7 +1826,7 @@ export namespace plusDomains_v1 { */ userId?: string; } - export interface Params$Resource$Circles$Update { + export interface Params$Resource$Circles$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2015,7 +2052,7 @@ export namespace plusDomains_v1 { } } - export interface Params$Resource$Comments$Get { + export interface Params$Resource$Comments$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2026,7 +2063,7 @@ export namespace plusDomains_v1 { */ commentId?: string; } - export interface Params$Resource$Comments$Insert { + export interface Params$Resource$Comments$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2042,7 +2079,7 @@ export namespace plusDomains_v1 { */ requestBody?: Schema$Comment; } - export interface Params$Resource$Comments$List { + export interface Params$Resource$Comments$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2159,7 +2196,7 @@ export namespace plusDomains_v1 { } } - export interface Params$Resource$Media$Insert { + export interface Params$Resource$Media$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2481,7 +2518,7 @@ export namespace plusDomains_v1 { } } - export interface Params$Resource$People$Get { + export interface Params$Resource$People$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2493,7 +2530,7 @@ export namespace plusDomains_v1 { */ userId?: string; } - export interface Params$Resource$People$List { + export interface Params$Resource$People$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2525,7 +2562,8 @@ export namespace plusDomains_v1 { */ userId?: string; } - export interface Params$Resource$People$Listbyactivity { + export interface Params$Resource$People$Listbyactivity extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2552,7 +2590,8 @@ export namespace plusDomains_v1 { */ pageToken?: string; } - export interface Params$Resource$People$Listbycircle { + export interface Params$Resource$People$Listbycircle extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/poly/README.md b/src/apis/poly/README.md index 25dcbd0975..87ed61f314 100644 --- a/src/apis/poly/README.md +++ b/src/apis/poly/README.md @@ -2,7 +2,7 @@ # @google/poly -> The Poly API provides read-only access to assets hosted on poly.google.com. +> The Poly API provides read access to assets hosted on poly.google.com to all, and upload access to poly.google.com for whitelisted accounts. ## Installation diff --git a/src/apis/poly/v1.ts b/src/apis/poly/v1.ts index f059cc755f..2b79d0db51 100644 --- a/src/apis/poly/v1.ts +++ b/src/apis/poly/v1.ts @@ -29,6 +29,57 @@ export namespace poly_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Poly API * @@ -588,7 +639,7 @@ export namespace poly_v1 { } } - export interface Params$Resource$Assets$Get { + export interface Params$Resource$Assets$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -599,7 +650,7 @@ export namespace poly_v1 { */ name?: string; } - export interface Params$Resource$Assets$List { + export interface Params$Resource$Assets$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -756,7 +807,8 @@ export namespace poly_v1 { } } - export interface Params$Resource$Users$Assets$List { + export interface Params$Resource$Users$Assets$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -884,7 +936,8 @@ export namespace poly_v1 { } } - export interface Params$Resource$Users$Likedassets$List { + export interface Params$Resource$Users$Likedassets$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/proximitybeacon/v1beta1.ts b/src/apis/proximitybeacon/v1beta1.ts index 955ff2e56d..3285641f1c 100644 --- a/src/apis/proximitybeacon/v1beta1.ts +++ b/src/apis/proximitybeacon/v1beta1.ts @@ -29,6 +29,57 @@ export namespace proximitybeacon_v1beta1 { version: 'v1beta1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Proximity Beacon API * @@ -665,7 +716,8 @@ export namespace proximitybeacon_v1beta1 { } } - export interface Params$Resource$Beaconinfo$Getforobserved { + export interface Params$Resource$Beaconinfo$Getforobserved extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1282,7 +1334,7 @@ export namespace proximitybeacon_v1beta1 { } } - export interface Params$Resource$Beacons$Activate { + export interface Params$Resource$Beacons$Activate extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1304,7 +1356,8 @@ export namespace proximitybeacon_v1beta1 { */ projectId?: string; } - export interface Params$Resource$Beacons$Deactivate { + export interface Params$Resource$Beacons$Deactivate extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1326,7 +1379,8 @@ export namespace proximitybeacon_v1beta1 { */ projectId?: string; } - export interface Params$Resource$Beacons$Decommission { + export interface Params$Resource$Beacons$Decommission extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1348,7 +1402,7 @@ export namespace proximitybeacon_v1beta1 { */ projectId?: string; } - export interface Params$Resource$Beacons$Delete { + export interface Params$Resource$Beacons$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1369,7 +1423,7 @@ export namespace proximitybeacon_v1beta1 { */ projectId?: string; } - export interface Params$Resource$Beacons$Get { + export interface Params$Resource$Beacons$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1391,7 +1445,7 @@ export namespace proximitybeacon_v1beta1 { */ projectId?: string; } - export interface Params$Resource$Beacons$List { + export interface Params$Resource$Beacons$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1465,7 +1519,7 @@ export namespace proximitybeacon_v1beta1 { */ q?: string; } - export interface Params$Resource$Beacons$Register { + export interface Params$Resource$Beacons$Register extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1483,7 +1537,7 @@ export namespace proximitybeacon_v1beta1 { */ requestBody?: Schema$Beacon; } - export interface Params$Resource$Beacons$Update { + export interface Params$Resource$Beacons$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1845,7 +1899,8 @@ export namespace proximitybeacon_v1beta1 { } } - export interface Params$Resource$Beacons$Attachments$Batchdelete { + export interface Params$Resource$Beacons$Attachments$Batchdelete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1875,7 +1930,8 @@ export namespace proximitybeacon_v1beta1 { */ projectId?: string; } - export interface Params$Resource$Beacons$Attachments$Create { + export interface Params$Resource$Beacons$Attachments$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1902,7 +1958,8 @@ export namespace proximitybeacon_v1beta1 { */ requestBody?: Schema$BeaconAttachment; } - export interface Params$Resource$Beacons$Attachments$Delete { + export interface Params$Resource$Beacons$Attachments$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1922,7 +1979,8 @@ export namespace proximitybeacon_v1beta1 { */ projectId?: string; } - export interface Params$Resource$Beacons$Attachments$List { + export interface Params$Resource$Beacons$Attachments$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2045,7 +2103,8 @@ export namespace proximitybeacon_v1beta1 { } } - export interface Params$Resource$Beacons$Diagnostics$List { + export interface Params$Resource$Beacons$Diagnostics$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2235,7 +2294,7 @@ export namespace proximitybeacon_v1beta1 { } } - export interface Params$Resource$Namespaces$List { + export interface Params$Resource$Namespaces$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2246,7 +2305,8 @@ export namespace proximitybeacon_v1beta1 { */ projectId?: string; } - export interface Params$Resource$Namespaces$Update { + export interface Params$Resource$Namespaces$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2363,7 +2423,8 @@ export namespace proximitybeacon_v1beta1 { } } - export interface Params$Resource$V1beta1$Geteidparams { + export interface Params$Resource$V1beta1$Geteidparams extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/pubsub/v1.ts b/src/apis/pubsub/v1.ts index e9fd6ca5e2..61572bf850 100644 --- a/src/apis/pubsub/v1.ts +++ b/src/apis/pubsub/v1.ts @@ -29,6 +29,57 @@ export namespace pubsub_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Pub/Sub API * @@ -1480,7 +1531,8 @@ export namespace pubsub_v1 { } } - export interface Params$Resource$Projects$Snapshots$Create { + export interface Params$Resource$Projects$Snapshots$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1501,7 +1553,8 @@ export namespace pubsub_v1 { */ requestBody?: Schema$CreateSnapshotRequest; } - export interface Params$Resource$Projects$Snapshots$Delete { + export interface Params$Resource$Projects$Snapshots$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1513,7 +1566,8 @@ export namespace pubsub_v1 { */ snapshot?: string; } - export interface Params$Resource$Projects$Snapshots$Get { + export interface Params$Resource$Projects$Snapshots$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1525,7 +1579,8 @@ export namespace pubsub_v1 { */ snapshot?: string; } - export interface Params$Resource$Projects$Snapshots$Getiampolicy { + export interface Params$Resource$Projects$Snapshots$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1537,7 +1592,8 @@ export namespace pubsub_v1 { */ resource?: string; } - export interface Params$Resource$Projects$Snapshots$List { + export interface Params$Resource$Projects$Snapshots$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1559,7 +1615,8 @@ export namespace pubsub_v1 { */ project?: string; } - export interface Params$Resource$Projects$Snapshots$Patch { + export interface Params$Resource$Projects$Snapshots$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1575,7 +1632,8 @@ export namespace pubsub_v1 { */ requestBody?: Schema$UpdateSnapshotRequest; } - export interface Params$Resource$Projects$Snapshots$Setiampolicy { + export interface Params$Resource$Projects$Snapshots$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1592,7 +1650,8 @@ export namespace pubsub_v1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Snapshots$Testiampermissions { + export interface Params$Resource$Projects$Snapshots$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3188,7 +3247,8 @@ export namespace pubsub_v1 { } } - export interface Params$Resource$Projects$Subscriptions$Acknowledge { + export interface Params$Resource$Projects$Subscriptions$Acknowledge extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3205,7 +3265,8 @@ export namespace pubsub_v1 { */ requestBody?: Schema$AcknowledgeRequest; } - export interface Params$Resource$Projects$Subscriptions$Create { + export interface Params$Resource$Projects$Subscriptions$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3226,7 +3287,8 @@ export namespace pubsub_v1 { */ requestBody?: Schema$Subscription; } - export interface Params$Resource$Projects$Subscriptions$Delete { + export interface Params$Resource$Projects$Subscriptions$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3238,7 +3300,8 @@ export namespace pubsub_v1 { */ subscription?: string; } - export interface Params$Resource$Projects$Subscriptions$Get { + export interface Params$Resource$Projects$Subscriptions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3250,7 +3313,8 @@ export namespace pubsub_v1 { */ subscription?: string; } - export interface Params$Resource$Projects$Subscriptions$Getiampolicy { + export interface Params$Resource$Projects$Subscriptions$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3262,7 +3326,8 @@ export namespace pubsub_v1 { */ resource?: string; } - export interface Params$Resource$Projects$Subscriptions$List { + export interface Params$Resource$Projects$Subscriptions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3284,7 +3349,8 @@ export namespace pubsub_v1 { */ project?: string; } - export interface Params$Resource$Projects$Subscriptions$Modifyackdeadline { + export interface Params$Resource$Projects$Subscriptions$Modifyackdeadline + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3301,7 +3367,8 @@ export namespace pubsub_v1 { */ requestBody?: Schema$ModifyAckDeadlineRequest; } - export interface Params$Resource$Projects$Subscriptions$Modifypushconfig { + export interface Params$Resource$Projects$Subscriptions$Modifypushconfig + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3318,7 +3385,8 @@ export namespace pubsub_v1 { */ requestBody?: Schema$ModifyPushConfigRequest; } - export interface Params$Resource$Projects$Subscriptions$Patch { + export interface Params$Resource$Projects$Subscriptions$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3339,7 +3407,8 @@ export namespace pubsub_v1 { */ requestBody?: Schema$UpdateSubscriptionRequest; } - export interface Params$Resource$Projects$Subscriptions$Pull { + export interface Params$Resource$Projects$Subscriptions$Pull extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3356,7 +3425,8 @@ export namespace pubsub_v1 { */ requestBody?: Schema$PullRequest; } - export interface Params$Resource$Projects$Subscriptions$Seek { + export interface Params$Resource$Projects$Subscriptions$Seek extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3372,7 +3442,8 @@ export namespace pubsub_v1 { */ requestBody?: Schema$SeekRequest; } - export interface Params$Resource$Projects$Subscriptions$Setiampolicy { + export interface Params$Resource$Projects$Subscriptions$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3389,7 +3460,8 @@ export namespace pubsub_v1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Subscriptions$Testiampermissions { + export interface Params$Resource$Projects$Subscriptions$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4515,7 +4587,8 @@ export namespace pubsub_v1 { } } - export interface Params$Resource$Projects$Topics$Create { + export interface Params$Resource$Projects$Topics$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4536,7 +4609,8 @@ export namespace pubsub_v1 { */ requestBody?: Schema$Topic; } - export interface Params$Resource$Projects$Topics$Delete { + export interface Params$Resource$Projects$Topics$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4548,7 +4622,8 @@ export namespace pubsub_v1 { */ topic?: string; } - export interface Params$Resource$Projects$Topics$Get { + export interface Params$Resource$Projects$Topics$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4560,7 +4635,8 @@ export namespace pubsub_v1 { */ topic?: string; } - export interface Params$Resource$Projects$Topics$Getiampolicy { + export interface Params$Resource$Projects$Topics$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4572,7 +4648,8 @@ export namespace pubsub_v1 { */ resource?: string; } - export interface Params$Resource$Projects$Topics$List { + export interface Params$Resource$Projects$Topics$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4594,7 +4671,8 @@ export namespace pubsub_v1 { */ project?: string; } - export interface Params$Resource$Projects$Topics$Patch { + export interface Params$Resource$Projects$Topics$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4615,7 +4693,8 @@ export namespace pubsub_v1 { */ requestBody?: Schema$UpdateTopicRequest; } - export interface Params$Resource$Projects$Topics$Publish { + export interface Params$Resource$Projects$Topics$Publish extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4632,7 +4711,8 @@ export namespace pubsub_v1 { */ requestBody?: Schema$PublishRequest; } - export interface Params$Resource$Projects$Topics$Setiampolicy { + export interface Params$Resource$Projects$Topics$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4649,7 +4729,8 @@ export namespace pubsub_v1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Topics$Testiampermissions { + export interface Params$Resource$Projects$Topics$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4761,7 +4842,8 @@ export namespace pubsub_v1 { } } - export interface Params$Resource$Projects$Topics$Snapshots$List { + export interface Params$Resource$Projects$Topics$Snapshots$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4942,7 +5024,8 @@ export namespace pubsub_v1 { } } - export interface Params$Resource$Projects$Topics$Subscriptions$List { + export interface Params$Resource$Projects$Topics$Subscriptions$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/pubsub/v1beta1a.ts b/src/apis/pubsub/v1beta1a.ts index 31b27adf34..ef881e389f 100644 --- a/src/apis/pubsub/v1beta1a.ts +++ b/src/apis/pubsub/v1beta1a.ts @@ -29,6 +29,57 @@ export namespace pubsub_v1beta1a { version: 'v1beta1a'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Pub/Sub API * @@ -1034,7 +1085,8 @@ export namespace pubsub_v1beta1a { } } - export interface Params$Resource$Subscriptions$Acknowledge { + export interface Params$Resource$Subscriptions$Acknowledge extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1046,7 +1098,8 @@ export namespace pubsub_v1beta1a { */ requestBody?: Schema$AcknowledgeRequest; } - export interface Params$Resource$Subscriptions$Create { + export interface Params$Resource$Subscriptions$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1058,7 +1111,8 @@ export namespace pubsub_v1beta1a { */ requestBody?: Schema$Subscription; } - export interface Params$Resource$Subscriptions$Delete { + export interface Params$Resource$Subscriptions$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1069,7 +1123,8 @@ export namespace pubsub_v1beta1a { */ subscription?: string; } - export interface Params$Resource$Subscriptions$Get { + export interface Params$Resource$Subscriptions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1080,7 +1135,8 @@ export namespace pubsub_v1beta1a { */ subscription?: string; } - export interface Params$Resource$Subscriptions$List { + export interface Params$Resource$Subscriptions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1100,7 +1156,8 @@ export namespace pubsub_v1beta1a { */ query?: string; } - export interface Params$Resource$Subscriptions$Modifyackdeadline { + export interface Params$Resource$Subscriptions$Modifyackdeadline extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1112,7 +1169,8 @@ export namespace pubsub_v1beta1a { */ requestBody?: Schema$ModifyAckDeadlineRequest; } - export interface Params$Resource$Subscriptions$Modifypushconfig { + export interface Params$Resource$Subscriptions$Modifypushconfig extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1124,7 +1182,8 @@ export namespace pubsub_v1beta1a { */ requestBody?: Schema$ModifyPushConfigRequest; } - export interface Params$Resource$Subscriptions$Pull { + export interface Params$Resource$Subscriptions$Pull extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1136,7 +1195,8 @@ export namespace pubsub_v1beta1a { */ requestBody?: Schema$PullRequest; } - export interface Params$Resource$Subscriptions$Pullbatch { + export interface Params$Resource$Subscriptions$Pullbatch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1556,7 +1616,7 @@ export namespace pubsub_v1beta1a { } } - export interface Params$Resource$Topics$Create { + export interface Params$Resource$Topics$Create extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1568,7 +1628,7 @@ export namespace pubsub_v1beta1a { */ requestBody?: Schema$Topic; } - export interface Params$Resource$Topics$Delete { + export interface Params$Resource$Topics$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1579,7 +1639,7 @@ export namespace pubsub_v1beta1a { */ topic?: string; } - export interface Params$Resource$Topics$Get { + export interface Params$Resource$Topics$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1590,7 +1650,7 @@ export namespace pubsub_v1beta1a { */ topic?: string; } - export interface Params$Resource$Topics$List { + export interface Params$Resource$Topics$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1610,7 +1670,7 @@ export namespace pubsub_v1beta1a { */ query?: string; } - export interface Params$Resource$Topics$Publish { + export interface Params$Resource$Topics$Publish extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1622,7 +1682,8 @@ export namespace pubsub_v1beta1a { */ requestBody?: Schema$PublishRequest; } - export interface Params$Resource$Topics$Publishbatch { + export interface Params$Resource$Topics$Publishbatch extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/pubsub/v1beta2.ts b/src/apis/pubsub/v1beta2.ts index c50671a8e6..10e5c2535e 100644 --- a/src/apis/pubsub/v1beta2.ts +++ b/src/apis/pubsub/v1beta2.ts @@ -29,6 +29,57 @@ export namespace pubsub_v1beta2 { version: 'v1beta2'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Pub/Sub API * @@ -1288,7 +1339,8 @@ export namespace pubsub_v1beta2 { } } - export interface Params$Resource$Projects$Subscriptions$Acknowledge { + export interface Params$Resource$Projects$Subscriptions$Acknowledge extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1304,7 +1356,8 @@ export namespace pubsub_v1beta2 { */ requestBody?: Schema$AcknowledgeRequest; } - export interface Params$Resource$Projects$Subscriptions$Create { + export interface Params$Resource$Projects$Subscriptions$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1325,7 +1378,8 @@ export namespace pubsub_v1beta2 { */ requestBody?: Schema$Subscription; } - export interface Params$Resource$Projects$Subscriptions$Delete { + export interface Params$Resource$Projects$Subscriptions$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1336,7 +1390,8 @@ export namespace pubsub_v1beta2 { */ subscription?: string; } - export interface Params$Resource$Projects$Subscriptions$Get { + export interface Params$Resource$Projects$Subscriptions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1347,7 +1402,8 @@ export namespace pubsub_v1beta2 { */ subscription?: string; } - export interface Params$Resource$Projects$Subscriptions$Getiampolicy { + export interface Params$Resource$Projects$Subscriptions$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1359,7 +1415,8 @@ export namespace pubsub_v1beta2 { */ resource?: string; } - export interface Params$Resource$Projects$Subscriptions$List { + export interface Params$Resource$Projects$Subscriptions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1380,7 +1437,8 @@ export namespace pubsub_v1beta2 { */ project?: string; } - export interface Params$Resource$Projects$Subscriptions$Modifyackdeadline { + export interface Params$Resource$Projects$Subscriptions$Modifyackdeadline + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1396,7 +1454,8 @@ export namespace pubsub_v1beta2 { */ requestBody?: Schema$ModifyAckDeadlineRequest; } - export interface Params$Resource$Projects$Subscriptions$Modifypushconfig { + export interface Params$Resource$Projects$Subscriptions$Modifypushconfig + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1412,7 +1471,8 @@ export namespace pubsub_v1beta2 { */ requestBody?: Schema$ModifyPushConfigRequest; } - export interface Params$Resource$Projects$Subscriptions$Pull { + export interface Params$Resource$Projects$Subscriptions$Pull extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1428,7 +1488,8 @@ export namespace pubsub_v1beta2 { */ requestBody?: Schema$PullRequest; } - export interface Params$Resource$Projects$Subscriptions$Setiampolicy { + export interface Params$Resource$Projects$Subscriptions$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1445,7 +1506,8 @@ export namespace pubsub_v1beta2 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Subscriptions$Testiampermissions { + export interface Params$Resource$Projects$Subscriptions$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2030,7 +2092,8 @@ export namespace pubsub_v1beta2 { } } - export interface Params$Resource$Projects$Topics$Create { + export interface Params$Resource$Projects$Topics$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2051,7 +2114,8 @@ export namespace pubsub_v1beta2 { */ requestBody?: Schema$Topic; } - export interface Params$Resource$Projects$Topics$Delete { + export interface Params$Resource$Projects$Topics$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2062,7 +2126,8 @@ export namespace pubsub_v1beta2 { */ topic?: string; } - export interface Params$Resource$Projects$Topics$Get { + export interface Params$Resource$Projects$Topics$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2073,7 +2138,8 @@ export namespace pubsub_v1beta2 { */ topic?: string; } - export interface Params$Resource$Projects$Topics$Getiampolicy { + export interface Params$Resource$Projects$Topics$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2085,7 +2151,8 @@ export namespace pubsub_v1beta2 { */ resource?: string; } - export interface Params$Resource$Projects$Topics$List { + export interface Params$Resource$Projects$Topics$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2106,7 +2173,8 @@ export namespace pubsub_v1beta2 { */ project?: string; } - export interface Params$Resource$Projects$Topics$Publish { + export interface Params$Resource$Projects$Topics$Publish extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2122,7 +2190,8 @@ export namespace pubsub_v1beta2 { */ requestBody?: Schema$PublishRequest; } - export interface Params$Resource$Projects$Topics$Setiampolicy { + export interface Params$Resource$Projects$Topics$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2139,7 +2208,8 @@ export namespace pubsub_v1beta2 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Topics$Testiampermissions { + export interface Params$Resource$Projects$Topics$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2245,7 +2315,8 @@ export namespace pubsub_v1beta2 { } } - export interface Params$Resource$Projects$Topics$Subscriptions$List { + export interface Params$Resource$Projects$Topics$Subscriptions$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/redis/v1.ts b/src/apis/redis/v1.ts index 975b415d11..ab49eef1cc 100644 --- a/src/apis/redis/v1.ts +++ b/src/apis/redis/v1.ts @@ -29,6 +29,57 @@ export namespace redis_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Google Cloud Memorystore for Redis API * @@ -250,6 +301,10 @@ export namespace redis_v1 { * results in the list. */ nextPageToken?: string; + /** + * Locations that could not be reached. + */ + unreachable?: string[]; } /** * The response message for Locations.ListLocations. @@ -570,7 +625,8 @@ export namespace redis_v1 { } } - export interface Params$Resource$Projects$Locations$Get { + export interface Params$Resource$Projects$Locations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -581,7 +637,8 @@ export namespace redis_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$List { + export interface Params$Resource$Projects$Locations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -967,7 +1024,8 @@ export namespace redis_v1 { } } - export interface Params$Resource$Projects$Locations$Instances$Create { + export interface Params$Resource$Projects$Locations$Instances$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -993,7 +1051,8 @@ export namespace redis_v1 { */ requestBody?: Schema$Instance; } - export interface Params$Resource$Projects$Locations$Instances$Delete { + export interface Params$Resource$Projects$Locations$Instances$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1006,7 +1065,8 @@ export namespace redis_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Instances$Get { + export interface Params$Resource$Projects$Locations$Instances$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1019,7 +1079,8 @@ export namespace redis_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Instances$List { + export interface Params$Resource$Projects$Locations$Instances$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1044,7 +1105,8 @@ export namespace redis_v1 { */ parent?: string; } - export interface Params$Resource$Projects$Locations$Instances$Patch { + export interface Params$Resource$Projects$Locations$Instances$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1373,7 +1435,8 @@ export namespace redis_v1 { } } - export interface Params$Resource$Projects$Locations$Operations$Cancel { + export interface Params$Resource$Projects$Locations$Operations$Cancel extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1384,7 +1447,8 @@ export namespace redis_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$Delete { + export interface Params$Resource$Projects$Locations$Operations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1395,7 +1459,8 @@ export namespace redis_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$Get { + export interface Params$Resource$Projects$Locations$Operations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1406,7 +1471,8 @@ export namespace redis_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$List { + export interface Params$Resource$Projects$Locations$Operations$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/redis/v1beta1.ts b/src/apis/redis/v1beta1.ts index f311c799a3..e6609e1937 100644 --- a/src/apis/redis/v1beta1.ts +++ b/src/apis/redis/v1beta1.ts @@ -29,6 +29,57 @@ export namespace redis_v1beta1 { version: 'v1beta1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Google Cloud Memorystore for Redis API * @@ -262,6 +313,10 @@ export namespace redis_v1beta1 { * results in the list. */ nextPageToken?: string; + /** + * Locations that could not be reached. + */ + unreachable?: string[]; } /** * The response message for Locations.ListLocations. @@ -582,7 +637,8 @@ export namespace redis_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Get { + export interface Params$Resource$Projects$Locations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -593,7 +649,8 @@ export namespace redis_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$List { + export interface Params$Resource$Projects$Locations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -979,7 +1036,8 @@ export namespace redis_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Instances$Create { + export interface Params$Resource$Projects$Locations$Instances$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1005,7 +1063,8 @@ export namespace redis_v1beta1 { */ requestBody?: Schema$Instance; } - export interface Params$Resource$Projects$Locations$Instances$Delete { + export interface Params$Resource$Projects$Locations$Instances$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1018,7 +1077,8 @@ export namespace redis_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Instances$Get { + export interface Params$Resource$Projects$Locations$Instances$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1031,7 +1091,8 @@ export namespace redis_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Instances$List { + export interface Params$Resource$Projects$Locations$Instances$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1056,7 +1117,8 @@ export namespace redis_v1beta1 { */ parent?: string; } - export interface Params$Resource$Projects$Locations$Instances$Patch { + export interface Params$Resource$Projects$Locations$Instances$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1385,7 +1447,8 @@ export namespace redis_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Operations$Cancel { + export interface Params$Resource$Projects$Locations$Operations$Cancel extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1396,7 +1459,8 @@ export namespace redis_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$Delete { + export interface Params$Resource$Projects$Locations$Operations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1407,7 +1471,8 @@ export namespace redis_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$Get { + export interface Params$Resource$Projects$Locations$Operations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1418,7 +1483,8 @@ export namespace redis_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$List { + export interface Params$Resource$Projects$Locations$Operations$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/replicapool/v1beta1.ts b/src/apis/replicapool/v1beta1.ts index 0b0f367b48..2daf45de97 100644 --- a/src/apis/replicapool/v1beta1.ts +++ b/src/apis/replicapool/v1beta1.ts @@ -29,6 +29,40 @@ export namespace replicapool_v1beta1 { version: 'v1beta1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Replica Pool API * @@ -1002,7 +1036,7 @@ export namespace replicapool_v1beta1 { } } - export interface Params$Resource$Pools$Delete { + export interface Params$Resource$Pools$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1026,7 +1060,7 @@ export namespace replicapool_v1beta1 { */ requestBody?: Schema$PoolsDeleteRequest; } - export interface Params$Resource$Pools$Get { + export interface Params$Resource$Pools$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1045,7 +1079,7 @@ export namespace replicapool_v1beta1 { */ zone?: string; } - export interface Params$Resource$Pools$Insert { + export interface Params$Resource$Pools$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1065,7 +1099,7 @@ export namespace replicapool_v1beta1 { */ requestBody?: Schema$Pool; } - export interface Params$Resource$Pools$List { + export interface Params$Resource$Pools$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1090,7 +1124,7 @@ export namespace replicapool_v1beta1 { */ zone?: string; } - export interface Params$Resource$Pools$Resize { + export interface Params$Resource$Pools$Resize extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1115,7 +1149,8 @@ export namespace replicapool_v1beta1 { */ zone?: string; } - export interface Params$Resource$Pools$Updatetemplate { + export interface Params$Resource$Pools$Updatetemplate extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1430,7 +1465,7 @@ export namespace replicapool_v1beta1 { } } - export interface Params$Resource$Replicas$Delete { + export interface Params$Resource$Replicas$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1458,7 +1493,7 @@ export namespace replicapool_v1beta1 { */ requestBody?: Schema$ReplicasDeleteRequest; } - export interface Params$Resource$Replicas$Get { + export interface Params$Resource$Replicas$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1481,7 +1516,7 @@ export namespace replicapool_v1beta1 { */ zone?: string; } - export interface Params$Resource$Replicas$List { + export interface Params$Resource$Replicas$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1510,7 +1545,7 @@ export namespace replicapool_v1beta1 { */ zone?: string; } - export interface Params$Resource$Replicas$Restart { + export interface Params$Resource$Replicas$Restart extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/replicapoolupdater/v1beta1.ts b/src/apis/replicapoolupdater/v1beta1.ts index 7bb6b1dca8..5bc16cff48 100644 --- a/src/apis/replicapoolupdater/v1beta1.ts +++ b/src/apis/replicapoolupdater/v1beta1.ts @@ -29,6 +29,40 @@ export namespace replicapoolupdater_v1beta1 { version: 'v1beta1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Google Compute Engine Instance Group Updater API * @@ -919,7 +953,8 @@ export namespace replicapoolupdater_v1beta1 { } } - export interface Params$Resource$Rollingupdates$Cancel { + export interface Params$Resource$Rollingupdates$Cancel extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -938,7 +973,8 @@ export namespace replicapoolupdater_v1beta1 { */ zone?: string; } - export interface Params$Resource$Rollingupdates$Get { + export interface Params$Resource$Rollingupdates$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -957,7 +993,8 @@ export namespace replicapoolupdater_v1beta1 { */ zone?: string; } - export interface Params$Resource$Rollingupdates$Insert { + export interface Params$Resource$Rollingupdates$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -977,7 +1014,8 @@ export namespace replicapoolupdater_v1beta1 { */ requestBody?: Schema$RollingUpdate; } - export interface Params$Resource$Rollingupdates$List { + export interface Params$Resource$Rollingupdates$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1006,7 +1044,8 @@ export namespace replicapoolupdater_v1beta1 { */ zone?: string; } - export interface Params$Resource$Rollingupdates$Listinstanceupdates { + export interface Params$Resource$Rollingupdates$Listinstanceupdates extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1039,7 +1078,8 @@ export namespace replicapoolupdater_v1beta1 { */ zone?: string; } - export interface Params$Resource$Rollingupdates$Pause { + export interface Params$Resource$Rollingupdates$Pause extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1058,7 +1098,8 @@ export namespace replicapoolupdater_v1beta1 { */ zone?: string; } - export interface Params$Resource$Rollingupdates$Resume { + export interface Params$Resource$Rollingupdates$Resume extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1077,7 +1118,8 @@ export namespace replicapoolupdater_v1beta1 { */ zone?: string; } - export interface Params$Resource$Rollingupdates$Rollback { + export interface Params$Resource$Rollingupdates$Rollback extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1250,7 +1292,8 @@ export namespace replicapoolupdater_v1beta1 { } } - export interface Params$Resource$Zoneoperations$Get { + export interface Params$Resource$Zoneoperations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1269,7 +1312,8 @@ export namespace replicapoolupdater_v1beta1 { */ zone?: string; } - export interface Params$Resource$Zoneoperations$List { + export interface Params$Resource$Zoneoperations$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/reseller/v1.ts b/src/apis/reseller/v1.ts index 5147a72da9..157a9234a9 100644 --- a/src/apis/reseller/v1.ts +++ b/src/apis/reseller/v1.ts @@ -29,6 +29,40 @@ export namespace reseller_v1 { version: 'v1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Enterprise Apps Reseller API * @@ -708,7 +742,7 @@ export namespace reseller_v1 { } } - export interface Params$Resource$Customers$Get { + export interface Params$Resource$Customers$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -722,7 +756,7 @@ export namespace reseller_v1 { */ customerId?: string; } - export interface Params$Resource$Customers$Insert { + export interface Params$Resource$Customers$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -743,7 +777,7 @@ export namespace reseller_v1 { */ requestBody?: Schema$Customer; } - export interface Params$Resource$Customers$Patch { + export interface Params$Resource$Customers$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -762,7 +796,7 @@ export namespace reseller_v1 { */ requestBody?: Schema$Customer; } - export interface Params$Resource$Customers$Update { + export interface Params$Resource$Customers$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1012,13 +1046,15 @@ export namespace reseller_v1 { } } - export interface Params$Resource$Resellernotify$Getwatchdetails { + export interface Params$Resource$Resellernotify$Getwatchdetails extends + StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; } - export interface Params$Resource$Resellernotify$Register { + export interface Params$Resource$Resellernotify$Register extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1029,7 +1065,8 @@ export namespace reseller_v1 { */ serviceAccountEmailAddress?: string; } - export interface Params$Resource$Resellernotify$Unregister { + export interface Params$Resource$Resellernotify$Unregister extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1759,7 +1796,8 @@ export namespace reseller_v1 { } } - export interface Params$Resource$Subscriptions$Activate { + export interface Params$Resource$Subscriptions$Activate extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1781,7 +1819,8 @@ export namespace reseller_v1 { */ subscriptionId?: string; } - export interface Params$Resource$Subscriptions$Changeplan { + export interface Params$Resource$Subscriptions$Changeplan extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1808,7 +1847,8 @@ export namespace reseller_v1 { */ requestBody?: Schema$ChangePlanRequest; } - export interface Params$Resource$Subscriptions$Changerenewalsettings { + export interface Params$Resource$Subscriptions$Changerenewalsettings extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1835,7 +1875,8 @@ export namespace reseller_v1 { */ requestBody?: Schema$RenewalSettings; } - export interface Params$Resource$Subscriptions$Changeseats { + export interface Params$Resource$Subscriptions$Changeseats extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1862,7 +1903,8 @@ export namespace reseller_v1 { */ requestBody?: Schema$Seats; } - export interface Params$Resource$Subscriptions$Delete { + export interface Params$Resource$Subscriptions$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1889,7 +1931,8 @@ export namespace reseller_v1 { */ subscriptionId?: string; } - export interface Params$Resource$Subscriptions$Get { + export interface Params$Resource$Subscriptions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1911,7 +1954,8 @@ export namespace reseller_v1 { */ subscriptionId?: string; } - export interface Params$Resource$Subscriptions$Insert { + export interface Params$Resource$Subscriptions$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1939,7 +1983,8 @@ export namespace reseller_v1 { */ requestBody?: Schema$Subscription; } - export interface Params$Resource$Subscriptions$List { + export interface Params$Resource$Subscriptions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1982,7 +2027,8 @@ export namespace reseller_v1 { */ pageToken?: string; } - export interface Params$Resource$Subscriptions$Startpaidservice { + export interface Params$Resource$Subscriptions$Startpaidservice extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2004,7 +2050,8 @@ export namespace reseller_v1 { */ subscriptionId?: string; } - export interface Params$Resource$Subscriptions$Suspend { + export interface Params$Resource$Subscriptions$Suspend extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/runtimeconfig/v1.ts b/src/apis/runtimeconfig/v1.ts index 7e2b63a540..c5470f8fb4 100644 --- a/src/apis/runtimeconfig/v1.ts +++ b/src/apis/runtimeconfig/v1.ts @@ -29,6 +29,57 @@ export namespace runtimeconfig_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Runtime Configuration API * @@ -418,7 +469,8 @@ export namespace runtimeconfig_v1 { } } - export interface Params$Resource$Operations$Cancel { + export interface Params$Resource$Operations$Cancel extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -434,7 +486,8 @@ export namespace runtimeconfig_v1 { */ requestBody?: Schema$CancelOperationRequest; } - export interface Params$Resource$Operations$Delete { + export interface Params$Resource$Operations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -445,7 +498,7 @@ export namespace runtimeconfig_v1 { */ name?: string; } - export interface Params$Resource$Operations$List { + export interface Params$Resource$Operations$List extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/runtimeconfig/v1beta1.ts b/src/apis/runtimeconfig/v1beta1.ts index 11933d66ba..121cd64f30 100644 --- a/src/apis/runtimeconfig/v1beta1.ts +++ b/src/apis/runtimeconfig/v1beta1.ts @@ -29,6 +29,57 @@ export namespace runtimeconfig_v1beta1 { version: 'v1beta1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Runtime Configuration API * @@ -104,14 +155,13 @@ export namespace runtimeconfig_v1beta1 { * A Cardinality condition for the Waiter resource. A cardinality condition is * met when the number of variables under a specified path prefix reaches a * predefined number. For example, if you set a Cardinality condition where - * the `path` is set to `/foo` and the number of paths is set to 2, the + * the `path` is set to `/foo` and the number of paths is set to `2`, the * following variables would meet the condition in a RuntimeConfig resource: * + `/foo/variable1 = "value1"` + `/foo/variable2 = * "value2"` + `/bar/variable3 = "value3"` It would not - * would not satisify the same condition with the `number` set to 3, however, - * because there is only 2 paths that start with `/foo`. Cardinality - * conditions are recursive; all subtrees under the specific path prefix are - * counted. + * satisfy the same condition with the `number` set to `3`, however, because + * there is only 2 paths that start with `/foo`. Cardinality conditions are + * recursive; all subtrees under the specific path prefix are counted. */ export interface Schema$Cardinality { /** @@ -428,7 +478,7 @@ export namespace runtimeconfig_v1beta1 { * The name of the variable resource, in the format: * projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME] The * `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a - * valid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file + * valid RuntimeConfig resource and `[VARIABLE_NAME]` follows Unix file * system file path naming. The `[VARIABLE_NAME]` can contain ASCII * letters, numbers, slashes and dashes. Slashes are used as path element * separators and are not part of the `[VARIABLE_NAME]` itself, so @@ -441,7 +491,7 @@ export namespace runtimeconfig_v1beta1 { */ name?: string; /** - * [Ouput only] The current state of the variable. The variable state + * Output only. The current state of the variable. The variable state * indicates the outcome of the `variables().watch` call and is visible * through the `get` and `list` calls. */ @@ -453,7 +503,8 @@ export namespace runtimeconfig_v1beta1 { */ text?: string; /** - * Output only. The time of the last variable update. + * Output only. The time of the last variable update. Timestamp will be UTC + * timestamp. */ updateTime?: string; /** @@ -1132,7 +1183,8 @@ export namespace runtimeconfig_v1beta1 { } } - export interface Params$Resource$Projects$Configs$Create { + export interface Params$Resource$Projects$Configs$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1159,7 +1211,8 @@ export namespace runtimeconfig_v1beta1 { */ requestBody?: Schema$RuntimeConfig; } - export interface Params$Resource$Projects$Configs$Delete { + export interface Params$Resource$Projects$Configs$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1171,7 +1224,8 @@ export namespace runtimeconfig_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Configs$Get { + export interface Params$Resource$Projects$Configs$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1183,7 +1237,8 @@ export namespace runtimeconfig_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Configs$Getiampolicy { + export interface Params$Resource$Projects$Configs$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1195,7 +1250,8 @@ export namespace runtimeconfig_v1beta1 { */ resource?: string; } - export interface Params$Resource$Projects$Configs$List { + export interface Params$Resource$Projects$Configs$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1218,7 +1274,8 @@ export namespace runtimeconfig_v1beta1 { */ parent?: string; } - export interface Params$Resource$Projects$Configs$Setiampolicy { + export interface Params$Resource$Projects$Configs$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1235,7 +1292,8 @@ export namespace runtimeconfig_v1beta1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Configs$Testiampermissions { + export interface Params$Resource$Projects$Configs$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1252,7 +1310,8 @@ export namespace runtimeconfig_v1beta1 { */ requestBody?: Schema$TestIamPermissionsRequest; } - export interface Params$Resource$Projects$Configs$Update { + export interface Params$Resource$Projects$Configs$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1429,7 +1488,8 @@ export namespace runtimeconfig_v1beta1 { } } - export interface Params$Resource$Projects$Configs$Operations$Get { + export interface Params$Resource$Projects$Configs$Operations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1440,7 +1500,8 @@ export namespace runtimeconfig_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Configs$Operations$Testiampermissions { + export interface Params$Resource$Projects$Configs$Operations$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1979,7 +2040,8 @@ export namespace runtimeconfig_v1beta1 { } } - export interface Params$Resource$Projects$Configs$Variables$Create { + export interface Params$Resource$Projects$Configs$Variables$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2006,7 +2068,8 @@ export namespace runtimeconfig_v1beta1 { */ requestBody?: Schema$Variable; } - export interface Params$Resource$Projects$Configs$Variables$Delete { + export interface Params$Resource$Projects$Configs$Variables$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2023,7 +2086,8 @@ export namespace runtimeconfig_v1beta1 { */ recursive?: boolean; } - export interface Params$Resource$Projects$Configs$Variables$Get { + export interface Params$Resource$Projects$Configs$Variables$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2035,7 +2099,8 @@ export namespace runtimeconfig_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Configs$Variables$List { + export interface Params$Resource$Projects$Configs$Variables$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2069,7 +2134,8 @@ export namespace runtimeconfig_v1beta1 { */ returnValues?: boolean; } - export interface Params$Resource$Projects$Configs$Variables$Testiampermissions { + export interface Params$Resource$Projects$Configs$Variables$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2086,7 +2152,8 @@ export namespace runtimeconfig_v1beta1 { */ requestBody?: Schema$TestIamPermissionsRequest; } - export interface Params$Resource$Projects$Configs$Variables$Update { + export interface Params$Resource$Projects$Configs$Variables$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2103,7 +2170,8 @@ export namespace runtimeconfig_v1beta1 { */ requestBody?: Schema$Variable; } - export interface Params$Resource$Projects$Configs$Variables$Watch { + export interface Params$Resource$Projects$Configs$Variables$Watch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2489,7 +2557,8 @@ export namespace runtimeconfig_v1beta1 { } } - export interface Params$Resource$Projects$Configs$Waiters$Create { + export interface Params$Resource$Projects$Configs$Waiters$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2516,7 +2585,8 @@ export namespace runtimeconfig_v1beta1 { */ requestBody?: Schema$Waiter; } - export interface Params$Resource$Projects$Configs$Waiters$Delete { + export interface Params$Resource$Projects$Configs$Waiters$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2528,7 +2598,8 @@ export namespace runtimeconfig_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Configs$Waiters$Get { + export interface Params$Resource$Projects$Configs$Waiters$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2541,7 +2612,8 @@ export namespace runtimeconfig_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Configs$Waiters$List { + export interface Params$Resource$Projects$Configs$Waiters$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2564,7 +2636,8 @@ export namespace runtimeconfig_v1beta1 { */ parent?: string; } - export interface Params$Resource$Projects$Configs$Waiters$Testiampermissions { + export interface Params$Resource$Projects$Configs$Waiters$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/safebrowsing/v4.ts b/src/apis/safebrowsing/v4.ts index 40850d8f50..37d42062f9 100644 --- a/src/apis/safebrowsing/v4.ts +++ b/src/apis/safebrowsing/v4.ts @@ -29,6 +29,57 @@ export namespace safebrowsing_v4 { version: 'v4'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Safe Browsing API * @@ -652,7 +703,8 @@ export namespace safebrowsing_v4 { } } - export interface Params$Resource$Encodedfullhashes$Get { + export interface Params$Resource$Encodedfullhashes$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -756,7 +808,8 @@ export namespace safebrowsing_v4 { } } - export interface Params$Resource$Encodedupdates$Get { + export interface Params$Resource$Encodedupdates$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -856,7 +909,7 @@ export namespace safebrowsing_v4 { } } - export interface Params$Resource$Fullhashes$Find { + export interface Params$Resource$Fullhashes$Find extends StandardParameters { /** * Auth client or API Key for the request */ @@ -947,7 +1000,8 @@ export namespace safebrowsing_v4 { } } - export interface Params$Resource$Threathits$Create { + export interface Params$Resource$Threathits$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1037,7 +1091,7 @@ export namespace safebrowsing_v4 { } } - export interface Params$Resource$Threatlists$List { + export interface Params$Resource$Threatlists$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1133,7 +1187,8 @@ export namespace safebrowsing_v4 { } } - export interface Params$Resource$Threatlistupdates$Fetch { + export interface Params$Resource$Threatlistupdates$Fetch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1228,7 +1283,8 @@ export namespace safebrowsing_v4 { } } - export interface Params$Resource$Threatmatches$Find { + export interface Params$Resource$Threatmatches$Find extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/script/README.md b/src/apis/script/README.md index 2bb33ca578..e5b2b2246d 100644 --- a/src/apis/script/README.md +++ b/src/apis/script/README.md @@ -2,7 +2,7 @@ # @google/script -> An API for managing and executing Google Apps Script projects. +> Manages and executes Google Apps Script projects. ## Installation diff --git a/src/apis/script/v1.ts b/src/apis/script/v1.ts index b5b408efce..97dd638391 100644 --- a/src/apis/script/v1.ts +++ b/src/apis/script/v1.ts @@ -29,10 +29,61 @@ export namespace script_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Apps Script API * - * An API for managing and executing Google Apps Script projects. + * Manages and executes Google Apps Script projects. * * @example * const {google} = require('googleapis'); @@ -859,7 +910,7 @@ export namespace script_v1 { } } - export interface Params$Resource$Processes$List { + export interface Params$Resource$Processes$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -921,7 +972,8 @@ export namespace script_v1 { */ 'userProcessFilter.userAccessLevels'?: string; } - export interface Params$Resource$Processes$Listscriptprocesses { + export interface Params$Resource$Processes$Listscriptprocesses extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1328,7 +1380,7 @@ export namespace script_v1 { } } - export interface Params$Resource$Projects$Create { + export interface Params$Resource$Projects$Create extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1340,7 +1392,7 @@ export namespace script_v1 { */ requestBody?: Schema$CreateProjectRequest; } - export interface Params$Resource$Projects$Get { + export interface Params$Resource$Projects$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1351,7 +1403,8 @@ export namespace script_v1 { */ scriptId?: string; } - export interface Params$Resource$Projects$Getcontent { + export interface Params$Resource$Projects$Getcontent extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1367,7 +1420,8 @@ export namespace script_v1 { */ versionNumber?: number; } - export interface Params$Resource$Projects$Getmetrics { + export interface Params$Resource$Projects$Getmetrics extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1386,7 +1440,8 @@ export namespace script_v1 { */ scriptId?: string; } - export interface Params$Resource$Projects$Updatecontent { + export interface Params$Resource$Projects$Updatecontent extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1756,7 +1811,8 @@ export namespace script_v1 { } } - export interface Params$Resource$Projects$Deployments$Create { + export interface Params$Resource$Projects$Deployments$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1772,7 +1828,8 @@ export namespace script_v1 { */ requestBody?: Schema$DeploymentConfig; } - export interface Params$Resource$Projects$Deployments$Delete { + export interface Params$Resource$Projects$Deployments$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1787,7 +1844,8 @@ export namespace script_v1 { */ scriptId?: string; } - export interface Params$Resource$Projects$Deployments$Get { + export interface Params$Resource$Projects$Deployments$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1802,7 +1860,8 @@ export namespace script_v1 { */ scriptId?: string; } - export interface Params$Resource$Projects$Deployments$List { + export interface Params$Resource$Projects$Deployments$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1822,7 +1881,8 @@ export namespace script_v1 { */ scriptId?: string; } - export interface Params$Resource$Projects$Deployments$Update { + export interface Params$Resource$Projects$Deployments$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2058,7 +2118,8 @@ export namespace script_v1 { } } - export interface Params$Resource$Projects$Versions$Create { + export interface Params$Resource$Projects$Versions$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2074,7 +2135,8 @@ export namespace script_v1 { */ requestBody?: Schema$Version; } - export interface Params$Resource$Projects$Versions$Get { + export interface Params$Resource$Projects$Versions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2089,7 +2151,8 @@ export namespace script_v1 { */ versionNumber?: number; } - export interface Params$Resource$Projects$Versions$List { + export interface Params$Resource$Projects$Versions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2126,14 +2189,18 @@ export namespace script_v1 { /** * script.scripts.run - * @desc Runs a function in an Apps Script project. The project must be - * deployed for use with the Apps Script API. This method requires + * @desc Runs a function in an Apps Script project. The script project must + * be deployed for use with the Apps Script API and the calling application + * must share the same Cloud Platform project. This method requires * authorization with an OAuth 2.0 token that includes at least one of the * scopes listed in the [Authorization](#authorization) section; script * projects that do not require authorization cannot be executed through * this API. To find the correct scopes to include in the authentication * token, open the project in the script editor, then select **File > - * Project properties** and click the **Scopes** tab. + * Project properties** and click the **Scopes** tab. The error `403, + * PERMISSION_DENIED: The caller does not have permission` indicates that + * the Cloud Platform project used to authorize the request is not the same + * as the one used by the script. * @alias script.scripts.run * @memberOf! () * @@ -2194,7 +2261,7 @@ export namespace script_v1 { } } - export interface Params$Resource$Scripts$Run { + export interface Params$Resource$Scripts$Run extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/searchconsole/v1.ts b/src/apis/searchconsole/v1.ts index 31976f26f4..f1bf215969 100644 --- a/src/apis/searchconsole/v1.ts +++ b/src/apis/searchconsole/v1.ts @@ -29,6 +29,57 @@ export namespace searchconsole_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Google Search Console URL Testing Tools API * @@ -260,7 +311,8 @@ export namespace searchconsole_v1 { } } - export interface Params$Resource$Urltestingtools$Mobilefriendlytest$Run { + export interface Params$Resource$Urltestingtools$Mobilefriendlytest$Run + extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/servicebroker/v1.ts b/src/apis/servicebroker/v1.ts index cb426a1bdb..c074ce0e5b 100644 --- a/src/apis/servicebroker/v1.ts +++ b/src/apis/servicebroker/v1.ts @@ -29,6 +29,57 @@ export namespace servicebroker_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Service Broker API * @@ -439,7 +490,7 @@ export namespace servicebroker_v1 { } } - export interface Params$Resource$V1$Getiampolicy { + export interface Params$Resource$V1$Getiampolicy extends StandardParameters { /** * Auth client or API Key for the request */ @@ -451,7 +502,7 @@ export namespace servicebroker_v1 { */ resource?: string; } - export interface Params$Resource$V1$Setiampolicy { + export interface Params$Resource$V1$Setiampolicy extends StandardParameters { /** * Auth client or API Key for the request */ @@ -468,7 +519,8 @@ export namespace servicebroker_v1 { */ requestBody?: Schema$GoogleIamV1__SetIamPolicyRequest; } - export interface Params$Resource$V1$Testiampermissions { + export interface Params$Resource$V1$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/servicebroker/v1alpha1.ts b/src/apis/servicebroker/v1alpha1.ts index 58f9e18032..62b09e96b8 100644 --- a/src/apis/servicebroker/v1alpha1.ts +++ b/src/apis/servicebroker/v1alpha1.ts @@ -29,6 +29,57 @@ export namespace servicebroker_v1alpha1 { version: 'v1alpha1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Service Broker API * @@ -758,7 +809,8 @@ export namespace servicebroker_v1alpha1 { } } - export interface Params$Resource$Projects$Brokers$Instances$Get { + export interface Params$Resource$Projects$Brokers$Instances$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -872,7 +924,8 @@ export namespace servicebroker_v1alpha1 { } } - export interface Params$Resource$Projects$Brokers$Instances$Service_bindings$List { + export interface Params$Resource$Projects$Brokers$Instances$Service_bindings$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -998,7 +1051,8 @@ export namespace servicebroker_v1alpha1 { } } - export interface Params$Resource$Projects$Brokers$Service_instances$List { + export interface Params$Resource$Projects$Brokers$Service_instances$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1139,7 +1193,8 @@ export namespace servicebroker_v1alpha1 { } } - export interface Params$Resource$Projects$Brokers$V2$Catalog$List { + export interface Params$Resource$Projects$Brokers$V2$Catalog$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1633,7 +1688,8 @@ export namespace servicebroker_v1alpha1 { } } - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Create { + export interface Params$Resource$Projects$Brokers$V2$Service_instances$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1663,7 +1719,8 @@ export namespace servicebroker_v1alpha1 { */ requestBody?: Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance; } - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Delete { + export interface Params$Resource$Projects$Brokers$V2$Service_instances$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1690,7 +1747,8 @@ export namespace servicebroker_v1alpha1 { */ serviceId?: string; } - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Get { + export interface Params$Resource$Projects$Brokers$V2$Service_instances$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1701,7 +1759,8 @@ export namespace servicebroker_v1alpha1 { */ name?: string; } - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Getlast_operation { + export interface Params$Resource$Projects$Brokers$V2$Service_instances$Getlast_operation + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1729,7 +1788,8 @@ export namespace servicebroker_v1alpha1 { */ serviceId?: string; } - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Patch { + export interface Params$Resource$Projects$Brokers$V2$Service_instances$Patch + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2144,7 +2204,8 @@ export namespace servicebroker_v1alpha1 { } } - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Create { + export interface Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2174,7 +2235,8 @@ export namespace servicebroker_v1alpha1 { */ requestBody?: Schema$GoogleCloudServicebrokerV1alpha1__Binding; } - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Delete { + export interface Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2205,7 +2267,8 @@ export namespace servicebroker_v1alpha1 { */ serviceId?: string; } - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Get { + export interface Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2232,7 +2295,8 @@ export namespace servicebroker_v1alpha1 { */ serviceId?: string; } - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Getlast_operation { + export interface Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Getlast_operation + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2501,7 +2565,8 @@ export namespace servicebroker_v1alpha1 { } } - export interface Params$Resource$V1alpha1$Getiampolicy { + export interface Params$Resource$V1alpha1$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2513,7 +2578,8 @@ export namespace servicebroker_v1alpha1 { */ resource?: string; } - export interface Params$Resource$V1alpha1$Setiampolicy { + export interface Params$Resource$V1alpha1$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2530,7 +2596,8 @@ export namespace servicebroker_v1alpha1 { */ requestBody?: Schema$GoogleIamV1__SetIamPolicyRequest; } - export interface Params$Resource$V1alpha1$Testiampermissions { + export interface Params$Resource$V1alpha1$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/servicebroker/v1beta1.ts b/src/apis/servicebroker/v1beta1.ts index 98f198cdbb..13424e6b86 100644 --- a/src/apis/servicebroker/v1beta1.ts +++ b/src/apis/servicebroker/v1beta1.ts @@ -29,6 +29,57 @@ export namespace servicebroker_v1beta1 { version: 'v1beta1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Service Broker API * @@ -971,7 +1022,8 @@ export namespace servicebroker_v1beta1 { } } - export interface Params$Resource$Projects$Brokers$Create { + export interface Params$Resource$Projects$Brokers$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -987,7 +1039,8 @@ export namespace servicebroker_v1beta1 { */ requestBody?: Schema$GoogleCloudServicebrokerV1beta1__Broker; } - export interface Params$Resource$Projects$Brokers$Delete { + export interface Params$Resource$Projects$Brokers$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -998,7 +1051,8 @@ export namespace servicebroker_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Brokers$List { + export interface Params$Resource$Projects$Brokers$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1281,7 +1335,8 @@ export namespace servicebroker_v1beta1 { } } - export interface Params$Resource$Projects$Brokers$Instances$Get { + export interface Params$Resource$Projects$Brokers$Instances$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1295,7 +1350,8 @@ export namespace servicebroker_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Brokers$Instances$Getlast_operation { + export interface Params$Resource$Projects$Brokers$Instances$Getlast_operation + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1320,7 +1376,8 @@ export namespace servicebroker_v1beta1 { */ serviceId?: string; } - export interface Params$Resource$Projects$Brokers$Instances$List { + export interface Params$Resource$Projects$Brokers$Instances$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1527,7 +1584,8 @@ export namespace servicebroker_v1beta1 { } } - export interface Params$Resource$Projects$Brokers$Instances$Bindings$Getlast_operation { + export interface Params$Resource$Projects$Brokers$Instances$Bindings$Getlast_operation + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1552,7 +1610,8 @@ export namespace servicebroker_v1beta1 { */ serviceId?: string; } - export interface Params$Resource$Projects$Brokers$Instances$Bindings$List { + export interface Params$Resource$Projects$Brokers$Instances$Bindings$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1694,7 +1753,8 @@ export namespace servicebroker_v1beta1 { } } - export interface Params$Resource$Projects$Brokers$V2$Catalog$List { + export interface Params$Resource$Projects$Brokers$V2$Catalog$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2177,7 +2237,8 @@ export namespace servicebroker_v1beta1 { } } - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Create { + export interface Params$Resource$Projects$Brokers$V2$Service_instances$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2207,7 +2268,8 @@ export namespace servicebroker_v1beta1 { */ requestBody?: Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance; } - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Delete { + export interface Params$Resource$Projects$Brokers$V2$Service_instances$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2232,7 +2294,8 @@ export namespace servicebroker_v1beta1 { */ serviceId?: string; } - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Get { + export interface Params$Resource$Projects$Brokers$V2$Service_instances$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2246,7 +2309,8 @@ export namespace servicebroker_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Getlast_operation { + export interface Params$Resource$Projects$Brokers$V2$Service_instances$Getlast_operation + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2271,7 +2335,8 @@ export namespace servicebroker_v1beta1 { */ serviceId?: string; } - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Patch { + export interface Params$Resource$Projects$Brokers$V2$Service_instances$Patch + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2664,7 +2729,8 @@ export namespace servicebroker_v1beta1 { } } - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Create { + export interface Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2690,7 +2756,8 @@ export namespace servicebroker_v1beta1 { */ requestBody?: Schema$GoogleCloudServicebrokerV1beta1__Binding; } - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Delete { + export interface Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2716,7 +2783,8 @@ export namespace servicebroker_v1beta1 { */ serviceId?: string; } - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Get { + export interface Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2736,7 +2804,8 @@ export namespace servicebroker_v1beta1 { */ serviceId?: string; } - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Getlast_operation { + export interface Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Getlast_operation + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2998,7 +3067,8 @@ export namespace servicebroker_v1beta1 { } } - export interface Params$Resource$V1beta1$Getiampolicy { + export interface Params$Resource$V1beta1$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3010,7 +3080,8 @@ export namespace servicebroker_v1beta1 { */ resource?: string; } - export interface Params$Resource$V1beta1$Setiampolicy { + export interface Params$Resource$V1beta1$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3027,7 +3098,8 @@ export namespace servicebroker_v1beta1 { */ requestBody?: Schema$GoogleIamV1__SetIamPolicyRequest; } - export interface Params$Resource$V1beta1$Testiampermissions { + export interface Params$Resource$V1beta1$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/serviceconsumermanagement/v1.ts b/src/apis/serviceconsumermanagement/v1.ts index 57124f14b6..56983cc4d7 100644 --- a/src/apis/serviceconsumermanagement/v1.ts +++ b/src/apis/serviceconsumermanagement/v1.ts @@ -29,6 +29,57 @@ export namespace serviceconsumermanagement_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Service Consumer Management API * @@ -302,6 +353,11 @@ export namespace serviceconsumermanagement_v1 { * value lower than this will be rejected. */ minDeadline?: number; + /** + * The number of seconds to wait for the completion of a long running + * operation. The default is no deadline. + */ + operationDeadline?: number; /** * Selects the methods to which this rule applies. Refer to selector for * syntax details. @@ -2460,7 +2516,8 @@ export namespace serviceconsumermanagement_v1 { } } - export interface Params$Resource$Operations$Cancel { + export interface Params$Resource$Operations$Cancel extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2476,7 +2533,8 @@ export namespace serviceconsumermanagement_v1 { */ requestBody?: Schema$CancelOperationRequest; } - export interface Params$Resource$Operations$Delete { + export interface Params$Resource$Operations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2487,7 +2545,7 @@ export namespace serviceconsumermanagement_v1 { */ name?: string; } - export interface Params$Resource$Operations$Get { + export interface Params$Resource$Operations$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2498,7 +2556,7 @@ export namespace serviceconsumermanagement_v1 { */ name?: string; } - export interface Params$Resource$Operations$List { + export interface Params$Resource$Operations$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2611,7 +2669,7 @@ export namespace serviceconsumermanagement_v1 { } } - export interface Params$Resource$Services$Search { + export interface Params$Resource$Services$Search extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3021,7 +3079,8 @@ export namespace serviceconsumermanagement_v1 { } } - export interface Params$Resource$Services$Tenancyunits$Addproject { + export interface Params$Resource$Services$Tenancyunits$Addproject extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3037,7 +3096,8 @@ export namespace serviceconsumermanagement_v1 { */ requestBody?: Schema$AddTenantProjectRequest; } - export interface Params$Resource$Services$Tenancyunits$Create { + export interface Params$Resource$Services$Tenancyunits$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3058,7 +3118,8 @@ export namespace serviceconsumermanagement_v1 { */ requestBody?: Schema$CreateTenancyUnitRequest; } - export interface Params$Resource$Services$Tenancyunits$Delete { + export interface Params$Resource$Services$Tenancyunits$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3069,7 +3130,8 @@ export namespace serviceconsumermanagement_v1 { */ name?: string; } - export interface Params$Resource$Services$Tenancyunits$List { + export interface Params$Resource$Services$Tenancyunits$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3099,7 +3161,8 @@ export namespace serviceconsumermanagement_v1 { */ parent?: string; } - export interface Params$Resource$Services$Tenancyunits$Removeproject { + export interface Params$Resource$Services$Tenancyunits$Removeproject extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/servicecontrol/v1.ts b/src/apis/servicecontrol/v1.ts index 3500b1a728..712a035ae1 100644 --- a/src/apis/servicecontrol/v1.ts +++ b/src/apis/servicecontrol/v1.ts @@ -29,11 +29,62 @@ export namespace servicecontrol_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Service Control API * - * Google Service Control provides control plane functionality to managed - * services, such as logging, monitoring, and status checks. + * Provides control plane functionality to managed services, such as logging, + * monitoring, and status checks. * * @example * const {google} = require('googleapis'); @@ -404,14 +455,23 @@ export namespace servicecontrol_v1 { serviceConfigId?: string; } /** - * `ConsumerInfo` provides information about the consumer project. + * `ConsumerInfo` provides information about the consumer. */ export interface Schema$ConsumerInfo { + /** + * The consumer identity number, can be Google cloud project number, folder + * number or organization number e.g. 1234567890. A value of 0 indicates no + * consumer number is found. + */ + consumerNumber?: string; /** * The Google cloud project number, e.g. 1234567890. A value of 0 indicates - * no project number is found. + * no project number is found. NOTE: This field is deprecated after Chemist + * support flexible consumer id. New code should not depend on this field + * anymore. */ projectNumber?: string; + type?: string; } /** * Distribution represents a frequency distribution of double-valued sample @@ -469,57 +529,6 @@ export namespace servicecontrol_v1 { */ sumOfSquaredDeviation?: number; } - /** - * Request message for QuotaController.EndReconciliation. - */ - export interface Schema$EndReconciliationRequest { - /** - * Operation that describes the quota reconciliation. - */ - reconciliationOperation?: Schema$QuotaOperation; - /** - * Specifies which version of service configuration should be used to - * process the request. If unspecified or no matching version can be found, - * the latest one will be used. - */ - serviceConfigId?: string; - } - /** - * Response message for QuotaController.EndReconciliation. - */ - export interface Schema$EndReconciliationResponse { - /** - * The same operation_id value used in the EndReconciliationRequest. Used - * for logging and diagnostics purposes. - */ - operationId?: string; - /** - * Metric values as tracked by One Platform before the adjustment was made. - * The following metrics will be included: 1. Per quota metric total usage - * will be specified using the following gauge metric: - * "serviceruntime.googleapis.com/allocation/consumer/quota_used_count" - * 2. Value for each quota limit associated with the metrics will be - * specified using the following gauge metric: - * "serviceruntime.googleapis.com/quota/limit" 3. Delta value of - * the usage after the reconciliation for limits associated with the metrics - * will be specified using the following metric: - * "serviceruntime.googleapis.com/allocation/reconciliation_delta" - * The delta value is defined as: new_usage_from_client - - * existing_value_in_spanner. This metric is not defined in - * serviceruntime.yaml or in Cloud Monarch. This metric is meant for - * callers' use only. Since this metric is not defined in the monitoring - * backend, reporting on this metric will result in an error. - */ - quotaMetrics?: Schema$MetricValueSet[]; - /** - * Indicates the decision of the reconciliation end. - */ - reconciliationErrors?: Schema$QuotaError[]; - /** - * ID of the actual config used to process the request. - */ - serviceConfigId?: string; - } /** * Describing buckets with arbitrary user-provided width. */ @@ -1093,53 +1102,6 @@ export namespace servicecontrol_v1 { */ quotaMode?: string; } - /** - * Request message for the ReleaseQuota method. - */ - export interface Schema$ReleaseQuotaRequest { - /** - * Operation that describes the quota release. - */ - releaseOperation?: Schema$QuotaOperation; - /** - * Specifies which version of service configuration should be used to - * process the request. If unspecified or no matching version can be found, - * the latest one will be used. - */ - serviceConfigId?: string; - } - /** - * Response message for the ReleaseQuota method. - */ - export interface Schema$ReleaseQuotaResponse { - /** - * The same operation_id value used in the ReleaseQuotaRequest. Used for - * logging and diagnostics purposes. - */ - operationId?: string; - /** - * Quota metrics to indicate the result of release. Depending on the - * request, one or more of the following metrics will be included: 1. For - * rate quota, per quota group or per quota metric released amount will be - * specified using the following delta metric: - * "serviceruntime.googleapis.com/api/consumer/quota_refund_count" - * 2. For allocation quota, per quota metric total usage will be specified - * using the following gauge metric: - * "serviceruntime.googleapis.com/allocation/consumer/quota_used_count" - * 3. For allocation quota, value for each quota limit associated with the - * metrics will be specified using the following gauge metric: - * "serviceruntime.googleapis.com/quota/limit" - */ - quotaMetrics?: Schema$MetricValueSet[]; - /** - * Indicates the decision of the release. - */ - releaseErrors?: Schema$QuotaError[]; - /** - * ID of the actual config used to process the request. - */ - serviceConfigId?: string; - } /** * Represents the processing error of one Operation in the request. */ @@ -1335,7 +1297,7 @@ export namespace servicecontrol_v1 { /** * Request attributes used in IAM condition evaluation. This field contains * request attributes like request time and access levels associated with - * the request. To get the whole view of the attributes used in IAM + * the request. To get the whole view of the attributes used in IAM * condition evaluation, the user must also look into * `AuditLog.authentication_info.resource_attributes`. */ @@ -1417,49 +1379,6 @@ export namespace servicecontrol_v1 { */ originalLocations?: string[]; } - /** - * Request message for QuotaController.StartReconciliation. - */ - export interface Schema$StartReconciliationRequest { - /** - * Operation that describes the quota reconciliation. - */ - reconciliationOperation?: Schema$QuotaOperation; - /** - * Specifies which version of service configuration should be used to - * process the request. If unspecified or no matching version can be found, - * the latest one will be used. - */ - serviceConfigId?: string; - } - /** - * Response message for QuotaController.StartReconciliation. - */ - export interface Schema$StartReconciliationResponse { - /** - * The same operation_id value used in the StartReconciliationRequest. Used - * for logging and diagnostics purposes. - */ - operationId?: string; - /** - * Metric values as tracked by One Platform before the start of - * reconciliation. The following metrics will be included: 1. Per quota - * metric total usage will be specified using the following gauge metric: - * "serviceruntime.googleapis.com/allocation/consumer/quota_used_count" - * 2. Value for each quota limit associated with the metrics will be - * specified using the following gauge metric: - * "serviceruntime.googleapis.com/quota/limit" - */ - quotaMetrics?: Schema$MetricValueSet[]; - /** - * Indicates the decision of the reconciliation start. - */ - reconciliationErrors?: Schema$QuotaError[]; - /** - * ID of the actual config used to process the request. - */ - serviceConfigId?: string; - } /** * The `Status` type defines a logical error model that is suitable for * different programming environments, including REST APIs and RPC APIs. It is @@ -1682,160 +1601,6 @@ export namespace servicecontrol_v1 { } - /** - * servicecontrol.services.endReconciliation - * @desc Signals the quota controller that service ends the ongoing usage - * reconciliation. This method requires the - * `servicemanagement.services.quota` permission on the specified service. - * For more information, see [Google Cloud - * IAM](https://cloud.google.com/iam). - * @alias servicecontrol.services.endReconciliation - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.serviceName Name of the service as specified in the service configuration. For example, `"pubsub.googleapis.com"`. See google.api.Service for the definition of a service name. - * @param {().EndReconciliationRequest} 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 - */ - endReconciliation( - params?: Params$Resource$Services$Endreconciliation, - options?: MethodOptions): - AxiosPromise; - endReconciliation( - params: Params$Resource$Services$Endreconciliation, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - endReconciliation( - params: Params$Resource$Services$Endreconciliation, - callback: BodyResponseCallback): void; - endReconciliation( - callback: BodyResponseCallback): void; - endReconciliation( - paramsOrCallback?: Params$Resource$Services$Endreconciliation| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Services$Endreconciliation; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Services$Endreconciliation; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicecontrol.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/services/{serviceName}:endReconciliation') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['serviceName'], - pathParams: ['serviceName'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * servicecontrol.services.releaseQuota - * @desc Releases previously allocated quota done through AllocateQuota - * method. This method requires the `servicemanagement.services.quota` - * permission on the specified service. For more information, see [Cloud - * IAM](https://cloud.google.com/iam). **NOTE:** The client **must** - * fail-open on server errors `INTERNAL`, `UNKNOWN`, `DEADLINE_EXCEEDED`, - * and `UNAVAILABLE`. To ensure system reliability, the server may inject - * these errors to prohibit any hard dependency on the quota functionality. - * @alias servicecontrol.services.releaseQuota - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.serviceName Name of the service as specified in the service configuration. For example, `"pubsub.googleapis.com"`. See google.api.Service for the definition of a service name. - * @param {().ReleaseQuotaRequest} 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 - */ - releaseQuota( - params?: Params$Resource$Services$Releasequota, - options?: MethodOptions): AxiosPromise; - releaseQuota( - params: Params$Resource$Services$Releasequota, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - releaseQuota( - params: Params$Resource$Services$Releasequota, - callback: BodyResponseCallback): void; - releaseQuota(callback: BodyResponseCallback): - void; - releaseQuota( - paramsOrCallback?: Params$Resource$Services$Releasequota| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Services$Releasequota; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Services$Releasequota; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicecontrol.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/services/{serviceName}:releaseQuota') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['serviceName'], - pathParams: ['serviceName'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** * servicecontrol.services.report * @desc Reports operation results to Google Service Control, such as logs @@ -1911,105 +1676,10 @@ export namespace servicecontrol_v1 { return createAPIRequest(parameters); } } - - - /** - * servicecontrol.services.startReconciliation - * @desc Unlike rate quota, allocation quota does not get refilled - * periodically. So, it is possible that the quota usage as seen by the - * service differs from what the One Platform considers the usage is. This - * is expected to happen only rarely, but over time this can accumulate. - * Services can invoke StartReconciliation and EndReconciliation to correct - * this usage drift, as described below: 1. Service sends - * StartReconciliation with a timestamp in future for each metric that - * needs to be reconciled. The timestamp being in future allows to - * account for in-flight AllocateQuota and ReleaseQuota requests for the - * same metric. 2. One Platform records this timestamp and starts tracking - * subsequent AllocateQuota and ReleaseQuota requests until - * EndReconciliation is called. 3. At or after the time specified in the - * StartReconciliation, service sends EndReconciliation with the usage - * that needs to be reconciled to. 4. One Platform adjusts its own record of - * usage for that metric to the value specified in EndReconciliation by - * taking in to account any allocation or release between - * StartReconciliation and EndReconciliation. Signals the quota controller - * that the service wants to perform a usage reconciliation as specified in - * the request. This method requires the `servicemanagement.services.quota` - * permission on the specified service. For more information, see [Google - * Cloud IAM](https://cloud.google.com/iam). - * @alias servicecontrol.services.startReconciliation - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.serviceName Name of the service as specified in the service configuration. For example, `"pubsub.googleapis.com"`. See google.api.Service for the definition of a service name. - * @param {().StartReconciliationRequest} 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 - */ - startReconciliation( - params?: Params$Resource$Services$Startreconciliation, - options?: MethodOptions): - AxiosPromise; - startReconciliation( - params: Params$Resource$Services$Startreconciliation, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - startReconciliation( - params: Params$Resource$Services$Startreconciliation, - callback: BodyResponseCallback): - void; - startReconciliation( - callback: BodyResponseCallback): - void; - startReconciliation( - paramsOrCallback?: Params$Resource$Services$Startreconciliation| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Services$Startreconciliation; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Services$Startreconciliation; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicecontrol.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/services/{serviceName}:startReconciliation') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['serviceName'], - pathParams: ['serviceName'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest(parameters); - } - } } - export interface Params$Resource$Services$Allocatequota { + export interface Params$Resource$Services$Allocatequota extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2027,7 +1697,7 @@ export namespace servicecontrol_v1 { */ requestBody?: Schema$AllocateQuotaRequest; } - export interface Params$Resource$Services$Check { + export interface Params$Resource$Services$Check extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2046,43 +1716,7 @@ export namespace servicecontrol_v1 { */ requestBody?: Schema$CheckRequest; } - export interface Params$Resource$Services$Endreconciliation { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Name of the service as specified in the service configuration. For - * example, `"pubsub.googleapis.com"`. See google.api.Service for the - * definition of a service name. - */ - serviceName?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$EndReconciliationRequest; - } - export interface Params$Resource$Services$Releasequota { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Name of the service as specified in the service configuration. For - * example, `"pubsub.googleapis.com"`. See google.api.Service for the - * definition of a service name. - */ - serviceName?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ReleaseQuotaRequest; - } - export interface Params$Resource$Services$Report { + export interface Params$Resource$Services$Report extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2101,22 +1735,4 @@ export namespace servicecontrol_v1 { */ requestBody?: Schema$ReportRequest; } - export interface Params$Resource$Services$Startreconciliation { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Name of the service as specified in the service configuration. For - * example, `"pubsub.googleapis.com"`. See google.api.Service for the - * definition of a service name. - */ - serviceName?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$StartReconciliationRequest; - } } diff --git a/src/apis/servicemanagement/v1.ts b/src/apis/servicemanagement/v1.ts index 0b6b2e688a..3b8b384381 100644 --- a/src/apis/servicemanagement/v1.ts +++ b/src/apis/servicemanagement/v1.ts @@ -29,6 +29,57 @@ export namespace servicemanagement_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Service Management API * @@ -355,6 +406,11 @@ export namespace servicemanagement_v1 { * value lower than this will be rejected. */ minDeadline?: number; + /** + * The number of seconds to wait for the completion of a long running + * operation. The default is no deadline. + */ + operationDeadline?: number; /** * Selects the methods to which this rule applies. Refer to selector for * syntax details. @@ -2685,7 +2741,7 @@ export namespace servicemanagement_v1 { } } - export interface Params$Resource$Operations$Get { + export interface Params$Resource$Operations$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2696,7 +2752,7 @@ export namespace servicemanagement_v1 { */ name?: string; } - export interface Params$Resource$Operations$List { + export interface Params$Resource$Operations$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3609,7 +3665,7 @@ export namespace servicemanagement_v1 { } } - export interface Params$Resource$Services$Create { + export interface Params$Resource$Services$Create extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3621,7 +3677,7 @@ export namespace servicemanagement_v1 { */ requestBody?: Schema$ManagedService; } - export interface Params$Resource$Services$Delete { + export interface Params$Resource$Services$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3634,7 +3690,7 @@ export namespace servicemanagement_v1 { */ serviceName?: string; } - export interface Params$Resource$Services$Disable { + export interface Params$Resource$Services$Disable extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3651,7 +3707,7 @@ export namespace servicemanagement_v1 { */ requestBody?: Schema$DisableServiceRequest; } - export interface Params$Resource$Services$Enable { + export interface Params$Resource$Services$Enable extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3668,7 +3724,8 @@ export namespace servicemanagement_v1 { */ requestBody?: Schema$EnableServiceRequest; } - export interface Params$Resource$Services$Generateconfigreport { + export interface Params$Resource$Services$Generateconfigreport extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3680,7 +3737,7 @@ export namespace servicemanagement_v1 { */ requestBody?: Schema$GenerateConfigReportRequest; } - export interface Params$Resource$Services$Get { + export interface Params$Resource$Services$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3692,7 +3749,8 @@ export namespace servicemanagement_v1 { */ serviceName?: string; } - export interface Params$Resource$Services$Getconfig { + export interface Params$Resource$Services$Getconfig extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3715,7 +3773,8 @@ export namespace servicemanagement_v1 { */ view?: string; } - export interface Params$Resource$Services$Getiampolicy { + export interface Params$Resource$Services$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3732,7 +3791,7 @@ export namespace servicemanagement_v1 { */ requestBody?: Schema$GetIamPolicyRequest; } - export interface Params$Resource$Services$List { + export interface Params$Resource$Services$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3758,7 +3817,8 @@ export namespace servicemanagement_v1 { */ producerProjectId?: string; } - export interface Params$Resource$Services$Setiampolicy { + export interface Params$Resource$Services$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3775,7 +3835,8 @@ export namespace servicemanagement_v1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Services$Testiampermissions { + export interface Params$Resource$Services$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3792,7 +3853,8 @@ export namespace servicemanagement_v1 { */ requestBody?: Schema$TestIamPermissionsRequest; } - export interface Params$Resource$Services$Undelete { + export interface Params$Resource$Services$Undelete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4108,7 +4170,8 @@ export namespace servicemanagement_v1 { } } - export interface Params$Resource$Services$Configs$Create { + export interface Params$Resource$Services$Configs$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4126,7 +4189,8 @@ export namespace servicemanagement_v1 { */ requestBody?: Schema$Service; } - export interface Params$Resource$Services$Configs$Get { + export interface Params$Resource$Services$Configs$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4149,7 +4213,8 @@ export namespace servicemanagement_v1 { */ view?: string; } - export interface Params$Resource$Services$Configs$List { + export interface Params$Resource$Services$Configs$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4170,7 +4235,8 @@ export namespace servicemanagement_v1 { */ serviceName?: string; } - export interface Params$Resource$Services$Configs$Submit { + export interface Params$Resource$Services$Configs$Submit extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4421,7 +4487,8 @@ export namespace servicemanagement_v1 { } } - export interface Params$Resource$Services$Consumers$Getiampolicy { + export interface Params$Resource$Services$Consumers$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4438,7 +4505,8 @@ export namespace servicemanagement_v1 { */ requestBody?: Schema$GetIamPolicyRequest; } - export interface Params$Resource$Services$Consumers$Setiampolicy { + export interface Params$Resource$Services$Consumers$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4455,7 +4523,8 @@ export namespace servicemanagement_v1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Services$Consumers$Testiampermissions { + export interface Params$Resource$Services$Consumers$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4706,7 +4775,8 @@ export namespace servicemanagement_v1 { } } - export interface Params$Resource$Services$Rollouts$Create { + export interface Params$Resource$Services$Rollouts$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4724,7 +4794,8 @@ export namespace servicemanagement_v1 { */ requestBody?: Schema$Rollout; } - export interface Params$Resource$Services$Rollouts$Get { + export interface Params$Resource$Services$Rollouts$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4741,7 +4812,8 @@ export namespace servicemanagement_v1 { */ serviceName?: string; } - export interface Params$Resource$Services$Rollouts$List { + export interface Params$Resource$Services$Rollouts$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/servicenetworking/v1beta.ts b/src/apis/servicenetworking/v1beta.ts index 78504bcab3..dbbe35c2f2 100644 --- a/src/apis/servicenetworking/v1beta.ts +++ b/src/apis/servicenetworking/v1beta.ts @@ -29,6 +29,57 @@ export namespace servicenetworking_v1beta { version: 'v1beta'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Service Networking API * @@ -103,6 +154,14 @@ export namespace servicenetworking_v1beta { * new subnetwork. */ region?: string; + /** + * Optional. The starting address of a range. The address must be a valid + * IPv4 address in the x.x.x.x format. This value combined with the IP + * prefix range is the CIDR range for the subnet. The range must be within + * the allocated range that is assigned to the private connection. If the + * CIDR range isn't available, the call fails. + */ + requestedAddress?: string; /** * Required. Name for the new subnetwork. Must be a legal * [subnetwork](compute/docs/reference/rest/v1/subnetworks) name. @@ -335,6 +394,11 @@ export namespace servicenetworking_v1beta { * value lower than this will be rejected. */ minDeadline?: number; + /** + * The number of seconds to wait for the completion of a long running + * operation. The default is no deadline. + */ + operationDeadline?: number; /** * Selects the methods to which this rule applies. Refer to selector for * syntax details. @@ -1867,6 +1931,11 @@ export namespace servicenetworking_v1beta { * Subnetwork name. See https://cloud.google.com/compute/docs/vpc/ */ name?: string; + /** + * Shared VPC host project network peered with consumer network. For + * example: projects/1234321/global/networks/host-network + */ + network?: string; } /** * Define a parameter's name and location. The parameter may be passed as @@ -2098,7 +2167,7 @@ export namespace servicenetworking_v1beta { } } - export interface Params$Resource$Operations$Get { + export interface Params$Resource$Operations$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2201,7 +2270,8 @@ export namespace servicenetworking_v1beta { } } - export interface Params$Resource$Services$Addsubnetwork { + export interface Params$Resource$Services$Addsubnetwork extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2383,7 +2453,8 @@ export namespace servicenetworking_v1beta { } } - export interface Params$Resource$Services$Connections$Create { + export interface Params$Resource$Services$Connections$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2401,7 +2472,8 @@ export namespace servicenetworking_v1beta { */ requestBody?: Schema$Connection; } - export interface Params$Resource$Services$Connections$List { + export interface Params$Resource$Services$Connections$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/serviceusage/v1.ts b/src/apis/serviceusage/v1.ts index 3a84c89dbb..2859369f61 100644 --- a/src/apis/serviceusage/v1.ts +++ b/src/apis/serviceusage/v1.ts @@ -29,6 +29,57 @@ export namespace serviceusage_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Service Usage API * @@ -289,6 +340,11 @@ export namespace serviceusage_v1 { * value lower than this will be rejected. */ minDeadline?: number; + /** + * The number of seconds to wait for the completion of a long running + * operation. The default is no deadline. + */ + operationDeadline?: number; /** * Selects the methods to which this rule applies. Refer to selector for * syntax details. @@ -2429,7 +2485,8 @@ export namespace serviceusage_v1 { } } - export interface Params$Resource$Operations$Cancel { + export interface Params$Resource$Operations$Cancel extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2445,7 +2502,8 @@ export namespace serviceusage_v1 { */ requestBody?: Schema$CancelOperationRequest; } - export interface Params$Resource$Operations$Delete { + export interface Params$Resource$Operations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2456,7 +2514,7 @@ export namespace serviceusage_v1 { */ name?: string; } - export interface Params$Resource$Operations$Get { + export interface Params$Resource$Operations$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2467,7 +2525,7 @@ export namespace serviceusage_v1 { */ name?: string; } - export interface Params$Resource$Operations$List { + export interface Params$Resource$Operations$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2855,7 +2913,8 @@ export namespace serviceusage_v1 { } } - export interface Params$Resource$Services$Batchenable { + export interface Params$Resource$Services$Batchenable extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2873,7 +2932,7 @@ export namespace serviceusage_v1 { */ requestBody?: Schema$BatchEnableServicesRequest; } - export interface Params$Resource$Services$Disable { + export interface Params$Resource$Services$Disable extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2892,7 +2951,7 @@ export namespace serviceusage_v1 { */ requestBody?: Schema$DisableServiceRequest; } - export interface Params$Resource$Services$Enable { + export interface Params$Resource$Services$Enable extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2913,7 +2972,7 @@ export namespace serviceusage_v1 { */ requestBody?: Schema$EnableServiceRequest; } - export interface Params$Resource$Services$Get { + export interface Params$Resource$Services$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2927,7 +2986,7 @@ export namespace serviceusage_v1 { */ name?: string; } - export interface Params$Resource$Services$List { + export interface Params$Resource$Services$List extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/serviceusage/v1beta1.ts b/src/apis/serviceusage/v1beta1.ts index 711e207527..08ed60e4a7 100644 --- a/src/apis/serviceusage/v1beta1.ts +++ b/src/apis/serviceusage/v1beta1.ts @@ -29,6 +29,57 @@ export namespace serviceusage_v1beta1 { version: 'v1beta1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Service Usage API * @@ -289,6 +340,11 @@ export namespace serviceusage_v1beta1 { * value lower than this will be rejected. */ minDeadline?: number; + /** + * The number of seconds to wait for the completion of a long running + * operation. The default is no deadline. + */ + operationDeadline?: number; /** * Selects the methods to which this rule applies. Refer to selector for * syntax details. @@ -2342,7 +2398,7 @@ export namespace serviceusage_v1beta1 { } } - export interface Params$Resource$Operations$Get { + export interface Params$Resource$Operations$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2353,7 +2409,7 @@ export namespace serviceusage_v1beta1 { */ name?: string; } - export interface Params$Resource$Operations$List { + export interface Params$Resource$Operations$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2734,7 +2790,8 @@ export namespace serviceusage_v1beta1 { } } - export interface Params$Resource$Services$Batchenable { + export interface Params$Resource$Services$Batchenable extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2752,7 +2809,7 @@ export namespace serviceusage_v1beta1 { */ requestBody?: Schema$BatchEnableServicesRequest; } - export interface Params$Resource$Services$Disable { + export interface Params$Resource$Services$Disable extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2771,7 +2828,7 @@ export namespace serviceusage_v1beta1 { */ requestBody?: Schema$DisableServiceRequest; } - export interface Params$Resource$Services$Enable { + export interface Params$Resource$Services$Enable extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2792,7 +2849,7 @@ export namespace serviceusage_v1beta1 { */ requestBody?: Schema$EnableServiceRequest; } - export interface Params$Resource$Services$Get { + export interface Params$Resource$Services$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2806,7 +2863,7 @@ export namespace serviceusage_v1beta1 { */ name?: string; } - export interface Params$Resource$Services$List { + export interface Params$Resource$Services$List extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/serviceuser/v1.ts b/src/apis/serviceuser/v1.ts deleted file mode 100644 index 40025116bb..0000000000 --- a/src/apis/serviceuser/v1.ts +++ /dev/null @@ -1,2420 +0,0 @@ -/** - * 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 serviceuser_v1 { - export interface Options extends GlobalOptions { - version: 'v1'; - } - - /** - * Service User API - * - * Enables services that service consumers want to use on Google Cloud - * Platform, lists the available or enabled services, or disables services - * that service consumers no longer use. - * - * @example - * const {google} = require('googleapis'); - * const serviceuser = google.serviceuser('v1'); - * - * @namespace serviceuser - * @type {Function} - * @version v1 - * @variation v1 - * @param {object=} options Options for Serviceuser - */ - export class Serviceuser { - _options: GlobalOptions; - google?: GoogleConfigurable; - root = this; - - projects: Resource$Projects; - services: Resource$Services; - - constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this._options = options || {}; - this.google = google; - this.getRoot.bind(this); - - this.projects = new Resource$Projects(this); - this.services = new Resource$Services(this); - } - - getRoot() { - return this.root; - } - } - - /** - * Api is a light-weight descriptor for an API Interface. Interfaces are also - * described as "protocol buffer services" in some contexts, such as - * by the "service" keyword in a .proto file, but they are different - * from API Services, which represent a concrete implementation of an - * interface as opposed to simply a description of methods and bindings. They - * are also sometimes simply referred to as "APIs" in other - * contexts, such as the name of this message itself. See - * https://cloud.google.com/apis/design/glossary for detailed terminology. - */ - export interface Schema$Api { - /** - * The methods of this interface, in unspecified order. - */ - methods?: Schema$Method[]; - /** - * Included interfaces. See Mixin. - */ - mixins?: Schema$Mixin[]; - /** - * The fully qualified name of this interface, including package name - * followed by the interface's simple name. - */ - name?: string; - /** - * Any metadata attached to the interface. - */ - options?: Schema$Option[]; - /** - * Source context for the protocol buffer service represented by this - * message. - */ - sourceContext?: Schema$SourceContext; - /** - * The source syntax of the service. - */ - syntax?: string; - /** - * A version string for this interface. If specified, must have the form - * `major-version.minor-version`, as in `1.10`. If the minor version is - * omitted, it defaults to zero. If the entire version field is empty, the - * major version is derived from the package name, as outlined below. If the - * field is not empty, the version in the package name will be verified to - * be consistent with what is provided here. The versioning schema uses - * [semantic versioning](http://semver.org) where the major version number - * indicates a breaking change and the minor version an additive, - * non-breaking change. Both version numbers are signals to users what to - * expect from different versions, and should be carefully chosen based on - * the product plan. The major version is also reflected in the package - * name of the interface, which must end in `v<major-version>`, as in - * `google.feature.v1`. For major versions 0 and 1, the suffix can be - * omitted. Zero major versions must only be used for experimental, non-GA - * interfaces. - */ - version?: string; - } - /** - * `Authentication` defines the authentication configuration for an API. - * Example for an API targeted for external use: name: - * calendar.googleapis.com authentication: providers: - id: - * google_calendar_auth jwks_uri: - * https://www.googleapis.com/oauth2/v1/certs issuer: - * https://securetoken.google.com rules: - selector: "*" - * requirements: provider_id: google_calendar_auth - */ - export interface Schema$Authentication { - /** - * Defines a set of authentication providers that a service supports. - */ - providers?: Schema$AuthProvider[]; - /** - * A list of authentication rules that apply to individual API methods. - * **NOTE:** All service configuration rules follow "last one - * wins" order. - */ - rules?: Schema$AuthenticationRule[]; - } - /** - * Authentication rules for the service. By default, if a method has any - * authentication requirements, every request must include a valid credential - * matching one of the requirements. It's an error to include more than - * one kind of credential in a single request. If a method doesn't have - * any auth requirements, request credentials will be ignored. - */ - export interface Schema$AuthenticationRule { - /** - * If true, the service accepts API keys without any other credential. - */ - allowWithoutCredential?: boolean; - /** - * The requirements for OAuth credentials. - */ - oauth?: Schema$OAuthRequirements; - /** - * Requirements for additional authentication providers. - */ - requirements?: Schema$AuthRequirement[]; - /** - * Selects the methods to which this rule applies. Refer to selector for - * syntax details. - */ - selector?: string; - } - /** - * Configuration of authorization. This section determines the authorization - * provider, if unspecified, then no authorization check will be done. - * Example: experimental: authorization: provider: - * firebaserules.googleapis.com - */ - export interface Schema$AuthorizationConfig { - /** - * The name of the authorization provider, such as - * firebaserules.googleapis.com. - */ - provider?: string; - } - /** - * Configuration for an anthentication provider, including support for [JSON - * Web Token - * (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). - */ - export interface Schema$AuthProvider { - /** - * The list of JWT - * [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - * that are allowed to access. A JWT containing any of these audiences will - * be accepted. When this setting is absent, only JWTs with audience - * "https://Service_name/API_name" will be accepted. For example, - * if no audiences are in the setting, LibraryService API will only accept - * JWTs with the following audience - * "https://library-example.googleapis.com/google.example.library.v1.LibraryService". - * Example: audiences: bookstore_android.apps.googleusercontent.com, - * bookstore_web.apps.googleusercontent.com - */ - audiences?: string; - /** - * Redirect URL if JWT token is required but no present or is expired. - * Implement authorizationUrl of securityDefinitions in OpenAPI spec. - */ - authorizationUrl?: string; - /** - * The unique identifier of the auth provider. It will be referred to by - * `AuthRequirement.provider_id`. Example: "bookstore_auth". - */ - id?: string; - /** - * Identifies the principal that issued the JWT. See - * https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 - * Usually a URL or an email address. Example: - * https://securetoken.google.com Example: - * 1234567-compute@developer.gserviceaccount.com - */ - issuer?: string; - /** - * URL of the provider's public key set to validate signature of the - * JWT. See [OpenID - * Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). - * Optional if the key set document: - can be retrieved from [OpenID - * Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of - * the issuer. - can be inferred from the email domain of the issuer (e.g. - * a Google service account). Example: - * https://www.googleapis.com/oauth2/v1/certs - */ - jwksUri?: string; - } - /** - * User-defined authentication requirements, including support for [JSON Web - * Token - * (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). - */ - export interface Schema$AuthRequirement { - /** - * NOTE: This will be deprecated soon, once AuthProvider.audiences is - * implemented and accepted in all the runtime components. The list of JWT - * [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - * that are allowed to access. A JWT containing any of these audiences will - * be accepted. When this setting is absent, only JWTs with audience - * "https://Service_name/API_name" will be accepted. For example, - * if no audiences are in the setting, LibraryService API will only accept - * JWTs with the following audience - * "https://library-example.googleapis.com/google.example.library.v1.LibraryService". - * Example: audiences: bookstore_android.apps.googleusercontent.com, - * bookstore_web.apps.googleusercontent.com - */ - audiences?: string; - /** - * id from authentication provider. Example: provider_id: - * bookstore_auth - */ - providerId?: string; - } - /** - * `Backend` defines the backend configuration for a service. - */ - export interface Schema$Backend { - /** - * A list of API backend rules that apply to individual API methods. - * **NOTE:** All service configuration rules follow "last one - * wins" order. - */ - rules?: Schema$BackendRule[]; - } - /** - * A backend rule provides configuration for an individual API element. - */ - export interface Schema$BackendRule { - /** - * The address of the API backend. - */ - address?: string; - /** - * The number of seconds to wait for a response from a request. The default - * deadline for gRPC is infinite (no deadline) and HTTP requests is 5 - * seconds. - */ - deadline?: number; - /** - * Minimum deadline in seconds needed for this method. Calls having deadline - * value lower than this will be rejected. - */ - minDeadline?: number; - /** - * Selects the methods to which this rule applies. Refer to selector for - * syntax details. - */ - selector?: string; - } - /** - * Billing related configuration of the service. The following example shows - * how to configure monitored resources and metrics for billing: - * monitored_resources: - type: library.googleapis.com/branch labels: - - * key: /city description: The city where the library branch is - * located in. - key: /name description: The name of the branch. - * metrics: - name: library.googleapis.com/book/borrowed_count - * metric_kind: DELTA value_type: INT64 billing: - * consumer_destinations: - monitored_resource: - * library.googleapis.com/branch metrics: - - * library.googleapis.com/book/borrowed_count - */ - export interface Schema$Billing { - /** - * Billing configurations for sending metrics to the consumer project. There - * can be multiple consumer destinations per service, each one must have a - * different monitored resource type. A metric can be used in at most one - * consumer destination. - */ - consumerDestinations?: Schema$BillingDestination[]; - } - /** - * Configuration of a specific billing destination (Currently only support - * bill against consumer project). - */ - export interface Schema$BillingDestination { - /** - * Names of the metrics to report to this billing destination. Each name - * must be defined in Service.metrics section. - */ - metrics?: string[]; - /** - * The monitored resource type. The type must be defined in - * Service.monitored_resources section. - */ - monitoredResource?: string; - } - /** - * `Context` defines which contexts an API requests. Example: context: - * rules: - selector: "*" requested: - - * google.rpc.context.ProjectContext - - * google.rpc.context.OriginContext The above specifies that all methods in - * the API request `google.rpc.context.ProjectContext` and - * `google.rpc.context.OriginContext`. Available context types are defined in - * package `google.rpc.context`. This also provides mechanism to whitelist - * any protobuf message extension that can be sent in grpc metadata using - * “x-goog-ext-<extension_id>-bin” and - * “x-goog-ext-<extension_id>-jspb” format. For example, list any - * service specific protobuf types that can appear in grpc metadata as follows - * in your yaml file: Example: context: rules: - selector: - * "google.example.library.v1.LibraryService.CreateBook" - * allowed_request_extensions: - google.foo.v1.NewExtension - * allowed_response_extensions: - google.foo.v1.NewExtension You can - * also specify extension ID instead of fully qualified extension name here. - */ - export interface Schema$Context { - /** - * A list of RPC context rules that apply to individual API methods. - * **NOTE:** All service configuration rules follow "last one - * wins" order. - */ - rules?: Schema$ContextRule[]; - } - /** - * A context rule provides information about the context for an individual API - * element. - */ - export interface Schema$ContextRule { - /** - * A list of full type names or extension IDs of extensions allowed in grpc - * side channel from client to backend. - */ - allowedRequestExtensions?: string[]; - /** - * A list of full type names or extension IDs of extensions allowed in grpc - * side channel from backend to client. - */ - allowedResponseExtensions?: string[]; - /** - * A list of full type names of provided contexts. - */ - provided?: string[]; - /** - * A list of full type names of requested contexts. - */ - requested?: string[]; - /** - * Selects the methods to which this rule applies. Refer to selector for - * syntax details. - */ - selector?: string; - } - /** - * Selects and configures the service controller used by the service. The - * service controller handles features like abuse, quota, billing, logging, - * monitoring, etc. - */ - export interface Schema$Control { - /** - * The service control environment to use. If empty, no control plane - * feature (like quota and billing) will be enabled. - */ - environment?: string; - } - /** - * Customize service error responses. For example, list any service specific - * protobuf types that can appear in error detail lists of error responses. - * Example: custom_error: types: - google.foo.v1.CustomError - * - google.foo.v1.AnotherError - */ - export interface Schema$CustomError { - /** - * The list of custom error rules that apply to individual API messages. - * **NOTE:** All service configuration rules follow "last one - * wins" order. - */ - rules?: Schema$CustomErrorRule[]; - /** - * The list of custom error detail types, e.g. - * 'google.foo.v1.CustomError'. - */ - types?: string[]; - } - /** - * A custom error rule. - */ - export interface Schema$CustomErrorRule { - /** - * Mark this message as possible payload in error response. Otherwise, - * objects of this type will be filtered when they appear in error payload. - */ - isErrorType?: boolean; - /** - * Selects messages to which this rule applies. Refer to selector for - * syntax details. - */ - selector?: string; - } - /** - * A custom pattern is used for defining custom HTTP verb. - */ - export interface Schema$CustomHttpPattern { - /** - * The name of this custom HTTP verb. - */ - kind?: string; - /** - * The path matched by this custom verb. - */ - path?: string; - } - /** - * Request message for DisableService method. - */ - export interface Schema$DisableServiceRequest {} - /** - * `Documentation` provides the information for describing a service. Example: - * <pre><code>documentation: summary: > The Google - * Calendar API gives access to most calendar features. pages: - name: - * Overview content: &#40;== include google/foo/overview.md - * ==&#41; - name: Tutorial content: &#40;== include - * google/foo/tutorial.md ==&#41; subpages; - name: Java content: - * &#40;== include google/foo/tutorial_java.md ==&#41; rules: - - * selector: google.calendar.Calendar.Get description: > ... - - * selector: google.calendar.Calendar.Put description: > ... - * </code></pre> Documentation is provided in markdown syntax. In - * addition to standard markdown features, definition lists, tables and fenced - * code blocks are supported. Section headers can be provided and are - * interpreted relative to the section nesting of the context where a - * documentation fragment is embedded. Documentation from the IDL is merged - * with documentation defined via the config at normalization time, where - * documentation provided by config rules overrides IDL provided. A number of - * constructs specific to the API platform are supported in documentation - * text. In order to reference a proto element, the following notation can be - * used: - * <pre><code>&#91;fully.qualified.proto.name]&#91;]</code></pre> - * To override the display text used for the link, this can be used: - * <pre><code>&#91;display - * text]&#91;fully.qualified.proto.name]</code></pre> Text can - * be excluded from doc using the following notation: - * <pre><code>&#40;-- internal comment - * --&#41;</code></pre> A few directives are available in - * documentation. Note that directives must appear on a single line to be - * properly identified. The `include` directive includes a markdown file from - * an external source: <pre><code>&#40;== include path/to/file - * ==&#41;</code></pre> The `resource_for` directive marks a - * message to be the resource of a collection in REST view. If it is not - * specified, tools attempt to infer the resource from the operations in a - * collection: <pre><code>&#40;== resource_for - * v1.shelves.books ==&#41;</code></pre> The directive - * `suppress_warning` does not directly affect documentation and is documented - * together with service config validation. - */ - export interface Schema$Documentation { - /** - * The URL to the root of documentation. - */ - documentationRootUrl?: string; - /** - * Declares a single overview page. For example: - * <pre><code>documentation: summary: ... overview: - * &#40;== include overview.md ==&#41; </code></pre> - * This is a shortcut for the following declaration (using pages style): - * <pre><code>documentation: summary: ... pages: - name: - * Overview content: &#40;== include overview.md ==&#41; - * </code></pre> Note: you cannot specify both `overview` field - * and `pages` field. - */ - overview?: string; - /** - * The top level pages for the documentation set. - */ - pages?: Schema$Page[]; - /** - * A list of documentation rules that apply to individual API elements. - * **NOTE:** All service configuration rules follow "last one - * wins" order. - */ - rules?: Schema$DocumentationRule[]; - /** - * A short summary of what the service does. Can only be provided by plain - * text. - */ - summary?: string; - } - /** - * A documentation rule provides information about individual API elements. - */ - export interface Schema$DocumentationRule { - /** - * Deprecation description of the selected element(s). It can be provided if - * an element is marked as `deprecated`. - */ - deprecationDescription?: string; - /** - * Description of the selected API(s). - */ - description?: string; - /** - * The selector is a comma-separated list of patterns. Each pattern is a - * qualified name of the element which may end in "*", indicating - * a wildcard. Wildcards are only allowed at the end and for a whole - * component of the qualified name, i.e. "foo.*" is ok, but not - * "foo.b*" or "foo.*.bar". To specify a default for all - * applicable elements, the whole pattern "*" is used. - */ - selector?: string; - } - /** - * Request message for EnableService method. - */ - export interface Schema$EnableServiceRequest {} - /** - * `Endpoint` describes a network endpoint that serves a set of APIs. A - * service may expose any number of endpoints, and all endpoints share the - * same service configuration, such as quota configuration and monitoring - * configuration. Example service configuration: name: - * library-example.googleapis.com endpoints: # Below entry makes - * 'google.example.library.v1.Library' # API be served from - * endpoint address library-example.googleapis.com. # It also allows - * HTTP OPTIONS calls to be passed to the backend, for # it to decide - * whether the subsequent cross-origin request is # allowed to proceed. - * - name: library-example.googleapis.com allow_cors: true - */ - export interface Schema$Endpoint { - /** - * DEPRECATED: This field is no longer supported. Instead of using aliases, - * please specify multiple google.api.Endpoint for each of the intended - * aliases. Additional names that this endpoint will be hosted on. - */ - aliases?: string[]; - /** - * Allowing - * [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka - * cross-domain traffic, would allow the backends served from this endpoint - * to receive and respond to HTTP OPTIONS requests. The response will be - * used by the browser to determine whether the subsequent cross-origin - * request is allowed to proceed. - */ - allowCors?: boolean; - /** - * The list of features enabled on this endpoint. - */ - features?: string[]; - /** - * The canonical name of this endpoint. - */ - name?: string; - /** - * The specification of an Internet routable address of API frontend that - * will handle requests to this [API - * Endpoint](https://cloud.google.com/apis/design/glossary). It should be - * either a valid IPv4 address or a fully-qualified domain name. For - * example, "8.8.8.8" or "myservice.appspot.com". - */ - target?: string; - } - /** - * Enum type definition. - */ - export interface Schema$Enum { - /** - * Enum value definitions. - */ - enumvalue?: Schema$EnumValue[]; - /** - * Enum type name. - */ - name?: string; - /** - * Protocol buffer options. - */ - options?: Schema$Option[]; - /** - * The source context. - */ - sourceContext?: Schema$SourceContext; - /** - * The source syntax. - */ - syntax?: string; - } - /** - * Enum value definition. - */ - export interface Schema$EnumValue { - /** - * Enum value name. - */ - name?: string; - /** - * Enum value number. - */ - number?: number; - /** - * Protocol buffer options. - */ - options?: Schema$Option[]; - } - /** - * Experimental service configuration. These configuration options can only be - * used by whitelisted users. - */ - export interface Schema$Experimental { - /** - * Authorization configuration. - */ - authorization?: Schema$AuthorizationConfig; - } - /** - * A single field of a message type. - */ - export interface Schema$Field { - /** - * The field cardinality. - */ - cardinality?: string; - /** - * The string value of the default value of this field. Proto2 syntax only. - */ - defaultValue?: string; - /** - * The field JSON name. - */ - jsonName?: string; - /** - * The field type. - */ - kind?: string; - /** - * The field name. - */ - name?: string; - /** - * The field number. - */ - number?: number; - /** - * The index of the field type in `Type.oneofs`, for message or enumeration - * types. The first type has index 1; zero means the type is not in the - * list. - */ - oneofIndex?: number; - /** - * The protocol buffer options. - */ - options?: Schema$Option[]; - /** - * Whether to use alternative packed wire representation. - */ - packed?: boolean; - /** - * The field type URL, without the scheme, for message or enumeration types. - * Example: `"type.googleapis.com/google.protobuf.Timestamp"`. - */ - typeUrl?: string; - } - /** - * Defines the HTTP configuration for an API service. It contains a list of - * HttpRule, each specifying the mapping of an RPC method to one or more HTTP - * REST API methods. - */ - export interface Schema$Http { - /** - * When set to true, URL path parmeters will be fully URI-decoded except in - * cases of single segment matches in reserved expansion, where - * "%2F" will be left encoded. The default behavior is to not - * decode RFC 6570 reserved characters in multi segment matches. - */ - fullyDecodeReservedExpansion?: boolean; - /** - * A list of HTTP configuration rules that apply to individual API methods. - * **NOTE:** All service configuration rules follow "last one - * wins" order. - */ - rules?: Schema$HttpRule[]; - } - /** - * # gRPC Transcoding gRPC Transcoding is a feature for mapping between a - * gRPC method and one or more HTTP REST endpoints. It allows developers to - * build a single API service that supports both gRPC APIs and REST APIs. Many - * systems, including [Google APIs](https://github.com/googleapis/googleapis), - * [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC - * Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and - * [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and - * use it for large scale production services. `HttpRule` defines the schema - * of the gRPC/REST mapping. The mapping specifies how different portions of - * the gRPC request message are mapped to the URL path, URL query parameters, - * and HTTP request body. It also controls how the gRPC response message is - * mapped to the HTTP response body. `HttpRule` is typically specified as an - * `google.api.http` annotation on the gRPC method. Each mapping specifies a - * URL path template and an HTTP method. The path template may refer to one or - * more fields in the gRPC request message, as long as each field is a - * non-repeated field with a primitive (non-message) type. The path template - * controls how fields of the request message are mapped to the URL path. - * Example: service Messaging { rpc GetMessage(GetMessageRequest) - * returns (Message) { option (google.api.http) = { get: - * "/v1/{name=messages/*}" }; } } message - * GetMessageRequest { string name = 1; // Mapped to URL path. } - * message Message { string text = 1; // The resource content. } - * This enables an HTTP REST to gRPC mapping as below: HTTP | gRPC - * -----|----- `GET /v1/messages/123456` | `GetMessage(name: - * "messages/123456")` Any fields in the request message which are - * not bound by the path template automatically become HTTP query parameters - * if there is no HTTP request body. For example: service Messaging { rpc - * GetMessage(GetMessageRequest) returns (Message) { option - * (google.api.http) = { get:"/v1/messages/{message_id}" - * }; } } message GetMessageRequest { message SubMessage { - * string subfield = 1; } string message_id = 1; // Mapped to URL - * path. int64 revision = 2; // Mapped to URL query parameter - * `revision`. SubMessage sub = 3; // Mapped to URL query parameter - * `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - * HTTP | gRPC -----|----- `GET - * /v1/messages/123456?revision=2&sub.subfield=foo` | - * `GetMessage(message_id: "123456" revision: 2 sub: - * SubMessage(subfield: "foo"))` Note that fields which are mapped - * to URL query parameters must have a primitive type or a repeated primitive - * type or a non-repeated message type. In the case of a repeated type, the - * parameter can be repeated in the URL as `...?param=A&param=B`. In the - * case of a message type, each field of the message is mapped to a separate - * parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods - * that allow a request body, the `body` field specifies the mapping. Consider - * a REST update method on the message resource collection: service - * Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) - * { option (google.api.http) = { patch: - * "/v1/messages/{message_id}" body: "message" - * }; } } message UpdateMessageRequest { string message_id - * = 1; // mapped to the URL Message message = 2; // mapped to the - * body } The following HTTP JSON to RPC mapping is enabled, where the - * representation of the JSON in the request body is determined by protos JSON - * encoding: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { - * "text": "Hi!" }` | `UpdateMessage(message_id: - * "123456" message { text: "Hi!" })` The special name - * `*` can be used in the body mapping to define that every field not bound by - * the path template should be mapped to the request body. This enables the - * following alternative definition of the update method: service - * Messaging { rpc UpdateMessage(Message) returns (Message) { option - * (google.api.http) = { patch: - * "/v1/messages/{message_id}" body: "*" }; } } - * message Message { string message_id = 1; string text = 2; } - * The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- - * `PATCH /v1/messages/123456 { "text": "Hi!" }` | - * `UpdateMessage(message_id: "123456" text: "Hi!")` Note - * that when using `*` in the body mapping, it is not possible to have HTTP - * parameters, as all fields not bound by the path end in the body. This makes - * this option more rarely used in practice when defining REST APIs. The - * common usage of `*` is in custom methods which don't use the URL at all - * for transferring data. It is possible to define multiple HTTP methods for - * one RPC by using the `additional_bindings` option. Example: service - * Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { - * option (google.api.http) = { get: - * "/v1/messages/{message_id}" additional_bindings { get: - * "/v1/users/{user_id}/messages/{message_id}" } }; } } - * message GetMessageRequest { string message_id = 1; string - * user_id = 2; } This enables the following two alternative HTTP JSON to - * RPC mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | - * `GetMessage(message_id: "123456")` `GET - * /v1/users/me/messages/123456` | `GetMessage(user_id: "me" - * message_id: "123456")` ## Rules for HTTP mapping 1. Leaf - * request fields (recursive expansion nested messages in the request message) - * are classified into three categories: - Fields referred by the path - * template. They are passed via the URL path. - Fields referred by the - * HttpRule.body. They are passed via the HTTP request body. - All - * other fields are passed via the URL query parameters, and the parameter - * name is the field path in the request message. A repeated field can be - * represented as multiple query parameters under the same name. 2. If - * HttpRule.body is "*", there is no URL query parameter, all fields - * are passed via URL path and HTTP request body. 3. If HttpRule.body is - * omitted, there is no HTTP request body, all fields are passed via URL - * path and URL query parameters. ### Path template syntax Template = - * "/" Segments [ Verb ] ; Segments = Segment { "/" - * Segment } ; Segment = "*" | "**" | LITERAL | - * Variable ; Variable = "{" FieldPath [ "=" Segments - * ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb - * = ":" LITERAL ; The syntax `*` matches a single URL path - * segment. The syntax `**` matches zero or more URL path segments, which must - * be the last part of the URL path except the `Verb`. The syntax `Variable` - * matches part of the URL path as specified by its template. A variable - * template must not contain other variables. If a variable matches a single - * path segment, its template may be omitted, e.g. `{var}` is equivalent to - * `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If - * the `LITERAL` contains any reserved character, such characters should be - * percent-encoded before the matching. If a variable contains exactly one - * path segment, such as `"{var}"` or `"{var=*}"`, when - * such a variable is expanded into a URL path on the client side, all - * characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side - * does the reverse decoding. Such variables show up in the [Discovery - * Document](https://developers.google.com/discovery/v1/reference/apis) as - * `{var}`. If a variable contains multiple path segments, such as - * `"{var=foo/*}"` or `"{var=**}"`, when such a variable - * is expanded into a URL path on the client side, all characters except - * `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse - * decoding, except "%2F" and "%2f" are left unchanged. - * Such variables show up in the [Discovery - * Document](https://developers.google.com/discovery/v1/reference/apis) as - * `{+var}`. ## Using gRPC API Service Configuration gRPC API Service - * Configuration (service config) is a configuration language for configuring - * a gRPC service to become a user-facing product. The service config is - * simply the YAML representation of the `google.api.Service` proto message. - * As an alternative to annotating your proto file, you can configure gRPC - * transcoding in your service config YAML files. You do this by specifying a - * `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same - * effect as the proto annotation. This can be particularly useful if you have - * a proto that is reused in multiple services. Note that any transcoding - * specified in the service config will override any matching transcoding - * configuration in the proto. Example: http: rules: # - * Selects a gRPC method and applies HttpRule to it. - selector: - * example.v1.Messaging.GetMessage get: - * /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC - * Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON - * conversion must follow the [proto3 - * specification](https://developers.google.com/protocol-buffers/docs/proto3#json). - * While the single segment variable follows the semantics of [RFC - * 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String - * Expansion, the multi segment variable **does not** follow RFC 6570 - * Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion - * does not expand special characters like `?` and `#`, which would lead to - * invalid URLs. As the result, gRPC Transcoding uses a custom encoding for - * multi segment variables. The path variables **must not** refer to any - * repeated or mapped field, because client libraries are not capable of - * handling such variable expansion. The path variables **must not** capture - * the leading "/" character. The reason is that the most common use - * case "{var}" does not capture the leading "/" - * character. For consistency, all path variables must share the same - * behavior. Repeated message fields must not be mapped to URL query - * parameters, because no client library can support such complicated mapping. - * If an API needs to use a JSON array for request or response body, it can - * map the request or response body to a repeated field. However, some gRPC - * Transcoding implementations may not support this feature. - */ - export interface Schema$HttpRule { - /** - * Additional HTTP bindings for the selector. Nested bindings must not - * contain an `additional_bindings` field themselves (that is, the nesting - * may only be one level deep). - */ - additionalBindings?: Schema$HttpRule[]; - /** - * The name of the request field whose value is mapped to the HTTP request - * body, or `*` for mapping all request fields not captured by the path - * pattern to the HTTP body, or omitted for not having any HTTP request - * body. NOTE: the referred field must be present at the top-level of the - * request message type. - */ - body?: string; - /** - * The custom pattern is used for specifying an HTTP method that is not - * included in the `pattern` field, such as HEAD, or "*" to leave - * the HTTP method unspecified for this rule. The wild-card rule is useful - * for services that provide content to Web (HTML) clients. - */ - custom?: Schema$CustomHttpPattern; - /** - * Maps to HTTP DELETE. Used for deleting a resource. - */ - delete?: string; - /** - * Maps to HTTP GET. Used for listing and getting information about - * resources. - */ - get?: string; - /** - * Maps to HTTP PATCH. Used for updating a resource. - */ - patch?: string; - /** - * Maps to HTTP POST. Used for creating a resource or performing an action. - */ - post?: string; - /** - * Maps to HTTP PUT. Used for replacing a resource. - */ - put?: string; - /** - * Optional. The name of the response field whose value is mapped to the - * HTTP response body. When omitted, the entire response message will be - * used as the HTTP response body. NOTE: The referred field must be present - * at the top-level of the response message type. - */ - responseBody?: string; - /** - * Selects a method to which this rule applies. Refer to selector for - * syntax details. - */ - selector?: string; - } - /** - * A description of a label. - */ - export interface Schema$LabelDescriptor { - /** - * A human-readable description for the label. - */ - description?: string; - /** - * The label key. - */ - key?: string; - /** - * The type of data that can be assigned to the label. - */ - valueType?: string; - } - /** - * Response message for `ListEnabledServices` method. - */ - export interface Schema$ListEnabledServicesResponse { - /** - * Token that can be passed to `ListEnabledServices` to resume a paginated - * query. - */ - nextPageToken?: string; - /** - * Services enabled for the specified parent. - */ - services?: Schema$PublishedService[]; - } - /** - * A description of a log type. Example in YAML format: - name: - * library.googleapis.com/activity_history description: The history of - * borrowing and returning library items. display_name: Activity labels: - * - key: /customer_id description: Identifier of a library customer - */ - export interface Schema$LogDescriptor { - /** - * A human-readable description of this log. This information appears in the - * documentation and can contain details. - */ - description?: string; - /** - * The human-readable name for this log. This information appears on the - * user interface and should be concise. - */ - displayName?: string; - /** - * The set of labels that are available to describe a specific log entry. - * Runtime requests that contain labels not specified here are considered - * invalid. - */ - labels?: Schema$LabelDescriptor[]; - /** - * The name of the log. It must be less than 512 characters long and can - * include the following characters: upper- and lower-case alphanumeric - * characters [A-Za-z0-9], and punctuation characters including slash, - * underscore, hyphen, period [/_-.]. - */ - name?: string; - } - /** - * Logging configuration of the service. The following example shows how to - * configure logs to be sent to the producer and consumer projects. In the - * example, the `activity_history` log is sent to both the producer and - * consumer projects, whereas the `purchase_history` log is only sent to the - * producer project. monitored_resources: - type: - * library.googleapis.com/branch labels: - key: /city description: - * The city where the library branch is located in. - key: /name - * description: The name of the branch. logs: - name: activity_history - * labels: - key: /customer_id - name: purchase_history logging: - * producer_destinations: - monitored_resource: - * library.googleapis.com/branch logs: - activity_history - - * purchase_history consumer_destinations: - monitored_resource: - * library.googleapis.com/branch logs: - activity_history - */ - export interface Schema$Logging { - /** - * Logging configurations for sending logs to the consumer project. There - * can be multiple consumer destinations, each one must have a different - * monitored resource type. A log can be used in at most one consumer - * destination. - */ - consumerDestinations?: Schema$LoggingDestination[]; - /** - * Logging configurations for sending logs to the producer project. There - * can be multiple producer destinations, each one must have a different - * monitored resource type. A log can be used in at most one producer - * destination. - */ - producerDestinations?: Schema$LoggingDestination[]; - } - /** - * Configuration of a specific logging destination (the producer project or - * the consumer project). - */ - export interface Schema$LoggingDestination { - /** - * Names of the logs to be sent to this destination. Each name must be - * defined in the Service.logs section. If the log name is not a domain - * scoped name, it will be automatically prefixed with the service name - * followed by "/". - */ - logs?: string[]; - /** - * The monitored resource type. The type must be defined in the - * Service.monitored_resources section. - */ - monitoredResource?: string; - } - /** - * Method represents a method of an API interface. - */ - export interface Schema$Method { - /** - * The simple name of this method. - */ - name?: string; - /** - * Any metadata attached to the method. - */ - options?: Schema$Option[]; - /** - * If true, the request is streamed. - */ - requestStreaming?: boolean; - /** - * A URL of the input message type. - */ - requestTypeUrl?: string; - /** - * If true, the response is streamed. - */ - responseStreaming?: boolean; - /** - * The URL of the output message type. - */ - responseTypeUrl?: string; - /** - * The source syntax of this method. - */ - syntax?: string; - } - /** - * Defines a metric type and its schema. Once a metric descriptor is created, - * deleting or altering it stops data collection and makes the metric - * type's existing data unusable. - */ - export interface Schema$MetricDescriptor { - /** - * A detailed description of the metric, which can be used in documentation. - */ - description?: string; - /** - * A concise name for the metric, which can be displayed in user interfaces. - * Use sentence case without an ending period, for example "Request - * count". This field is optional but it is recommended to be set for - * any metrics associated with user-visible concepts, such as Quota. - */ - displayName?: string; - /** - * The set of labels that can be used to describe a specific instance of - * this metric type. For example, the - * `appengine.googleapis.com/http/server/response_latencies` metric type has - * a label for the HTTP response code, `response_code`, so you can look at - * latencies for successful responses or just for responses that failed. - */ - labels?: Schema$LabelDescriptor[]; - /** - * Optional. Metadata which can be used to guide usage of the metric. - */ - metadata?: Schema$MetricDescriptorMetadata; - /** - * Whether the metric records instantaneous values, changes to a value, etc. - * Some combinations of `metric_kind` and `value_type` might not be - * supported. - */ - metricKind?: string; - /** - * The resource name of the metric descriptor. - */ - name?: string; - /** - * The metric type, including its DNS name prefix. The type is not - * URL-encoded. All user-defined metric types have the DNS name - * `custom.googleapis.com` or `external.googleapis.com`. Metric types - * should use a natural hierarchical grouping. For example: - * "custom.googleapis.com/invoice/paid/amount" - * "external.googleapis.com/prometheus/up" - * "appengine.googleapis.com/http/server/response_latencies" - */ - type?: string; - /** - * The unit in which the metric value is reported. It is only applicable if - * the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The supported - * units are a subset of [The Unified Code for Units of - * Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units - * (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute - * * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo - * (10**3) * `M` mega (10**6) * `G` giga (10**9) * `T` tera - * (10**12) * `P` peta (10**15) * `E` exa (10**18) * `Z` - * zetta (10**21) * `Y` yotta (10**24) * `m` milli (10**-3) * - * `u` micro (10**-6) * `n` nano (10**-9) * `p` pico - * (10**-12) * `f` femto (10**-15) * `a` atto (10**-18) * `z` - * zepto (10**-21) * `y` yocto (10**-24) * `Ki` kibi (2**10) * - * `Mi` mebi (2**20) * `Gi` gibi (2**30) * `Ti` tebi (2**40) - * **Grammar** The grammar also includes these connectors: * `/` division - * (as an infix operator, e.g. `1/s`). * `.` multiplication (as an infix - * operator, e.g. `GBy.d`) The grammar for a unit is as follows: Expression - * = Component { "." Component } { "/" Component } ; - * Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | - * Annotation | "1" ; Annotation - * = "{" NAME "}" ; Notes: * `Annotation` is just a - * comment if it follows a `UNIT` and is equivalent to `1` if it is used - * alone. For examples, `{requests}/s == 1/s`, `By{transmitted}/s == - * By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not - * containing '{' or '}'. * `1` represents dimensionless - * value 1, such as in `1/s`. * `%` represents dimensionless value 1/100, - * and annotates values giving a percentage. - */ - unit?: string; - /** - * Whether the measurement is an integer, a floating-point number, etc. Some - * combinations of `metric_kind` and `value_type` might not be supported. - */ - valueType?: string; - } - /** - * Additional annotations that can be used to guide the usage of a metric. - */ - export interface Schema$MetricDescriptorMetadata { - /** - * The delay of data points caused by ingestion. Data points older than this - * age are guaranteed to be ingested and available to be read, excluding - * data loss due to errors. - */ - ingestDelay?: string; - /** - * The launch stage of the metric definition. - */ - launchStage?: string; - /** - * The sampling period of metric data points. For metrics which are written - * periodically, consecutive data points are stored at this time interval, - * excluding data loss due to errors. Metrics with a higher granularity have - * a smaller sampling period. - */ - samplePeriod?: string; - } - /** - * Bind API methods to metrics. Binding a method to a metric causes that - * metric's configured quota behaviors to apply to the method call. - */ - export interface Schema$MetricRule { - /** - * Metrics to update when the selected methods are called, and the - * associated cost applied to each metric. The key of the map is the metric - * name, and the values are the amount increased for the metric against - * which the quota limits are defined. The value must not be negative. - */ - metricCosts?: any; - /** - * Selects the methods to which this rule applies. Refer to selector for - * syntax details. - */ - selector?: string; - } - /** - * Declares an API Interface to be included in this interface. The including - * interface must redeclare all the methods from the included interface, but - * documentation and options are inherited as follows: - If after comment and - * whitespace stripping, the documentation string of the redeclared method - * is empty, it will be inherited from the original method. - Each - * annotation belonging to the service config (http, visibility) which is - * not set in the redeclared method will be inherited. - If an http - * annotation is inherited, the path pattern will be modified as follows. - * Any version prefix will be replaced by the version of the including - * interface plus the root path if specified. Example of a simple mixin: - * package google.acl.v1; service AccessControl { // Get the - * underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { - * option (google.api.http).get = "/v1/{resource=**}:getAcl"; } } - * package google.storage.v2; service Storage { // rpc - * GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc - * GetData(GetDataRequest) returns (Data) { option - * (google.api.http).get = "/v2/{resource=**}"; } } - * Example of a mixin configuration: apis: - name: - * google.storage.v2.Storage mixins: - name: - * google.acl.v1.AccessControl The mixin construct implies that all methods - * in `AccessControl` are also declared with same name and request/response - * types in `Storage`. A documentation generator or annotation processor will - * see the effective `Storage.GetAcl` method after inherting documentation and - * annotations as follows: service Storage { // Get the underlying - * ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option - * (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... - * } Note how the version in the path pattern changed from `v1` to `v2`. If - * the `root` field in the mixin is specified, it should be a relative path - * under which inherited HTTP paths are placed. Example: apis: - - * name: google.storage.v2.Storage mixins: - name: - * google.acl.v1.AccessControl root: acls This implies the following - * inherited HTTP annotation: service Storage { // Get the - * underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { - * option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; - * } ... } - */ - export interface Schema$Mixin { - /** - * The fully qualified name of the interface which is included. - */ - name?: string; - /** - * If non-empty specifies a path under which inherited HTTP paths are - * rooted. - */ - root?: string; - } - /** - * An object that describes the schema of a MonitoredResource object using a - * type name and a set of labels. For example, the monitored resource - * descriptor for Google Compute Engine VM instances has a type of - * `"gce_instance"` and specifies the use of the labels - * `"instance_id"` and `"zone"` to identify particular VM - * instances. Different APIs can support different monitored resource types. - * APIs generally provide a `list` method that returns the monitored resource - * descriptors used by the API. - */ - export interface Schema$MonitoredResourceDescriptor { - /** - * Optional. A detailed description of the monitored resource type that - * might be used in documentation. - */ - description?: string; - /** - * Optional. A concise name for the monitored resource type that might be - * displayed in user interfaces. It should be a Title Cased Noun Phrase, - * without any article or other determiners. For example, `"Google - * Cloud SQL Database"`. - */ - displayName?: string; - /** - * Required. A set of labels used to describe instances of this monitored - * resource type. For example, an individual Google Cloud SQL database is - * identified by values for the labels `"database_id"` and - * `"zone"`. - */ - labels?: Schema$LabelDescriptor[]; - /** - * Optional. The resource name of the monitored resource descriptor: - * `"projects/{project_id}/monitoredResourceDescriptors/{type}"` - * where {type} is the value of the `type` field in this object and - * {project_id} is a project ID that provides API-specific context for - * accessing the type. APIs that do not use project information can use the - * resource name format `"monitoredResourceDescriptors/{type}"`. - */ - name?: string; - /** - * Required. The monitored resource type. For example, the type - * `"cloudsql_database"` represents databases in Google Cloud SQL. - * The maximum length of this value is 256 characters. - */ - type?: string; - } - /** - * Monitoring configuration of the service. The example below shows how to - * configure monitored resources and metrics for monitoring. In the example, a - * monitored resource and two metrics are defined. The - * `library.googleapis.com/book/returned_count` metric is sent to both - * producer and consumer projects, whereas the - * `library.googleapis.com/book/overdue_count` metric is only sent to the - * consumer project. monitored_resources: - type: - * library.googleapis.com/branch labels: - key: /city description: - * The city where the library branch is located in. - key: /name - * description: The name of the branch. metrics: - name: - * library.googleapis.com/book/returned_count metric_kind: DELTA - * value_type: INT64 labels: - key: /customer_id - name: - * library.googleapis.com/book/overdue_count metric_kind: GAUGE - * value_type: INT64 labels: - key: /customer_id monitoring: - * producer_destinations: - monitored_resource: - * library.googleapis.com/branch metrics: - - * library.googleapis.com/book/returned_count consumer_destinations: - - * monitored_resource: library.googleapis.com/branch metrics: - - * library.googleapis.com/book/returned_count - - * library.googleapis.com/book/overdue_count - */ - export interface Schema$Monitoring { - /** - * Monitoring configurations for sending metrics to the consumer project. - * There can be multiple consumer destinations, each one must have a - * different monitored resource type. A metric can be used in at most one - * consumer destination. - */ - consumerDestinations?: Schema$MonitoringDestination[]; - /** - * Monitoring configurations for sending metrics to the producer project. - * There can be multiple producer destinations, each one must have a - * different monitored resource type. A metric can be used in at most one - * producer destination. - */ - producerDestinations?: Schema$MonitoringDestination[]; - } - /** - * Configuration of a specific monitoring destination (the producer project or - * the consumer project). - */ - export interface Schema$MonitoringDestination { - /** - * Names of the metrics to report to this monitoring destination. Each name - * must be defined in Service.metrics section. - */ - metrics?: string[]; - /** - * The monitored resource type. The type must be defined in - * Service.monitored_resources section. - */ - monitoredResource?: string; - } - /** - * OAuth scopes are a way to define data and permissions on data. For example, - * there are scopes defined for "Read-only access to Google - * Calendar" and "Access to Cloud Platform". Users can consent - * to a scope for an application, giving it permission to access that data on - * their behalf. OAuth scope specifications should be fairly coarse grained; - * a user will need to see and understand the text description of what your - * scope means. In most cases: use one or at most two OAuth scopes for an - * entire family of products. If your product has multiple APIs, you should - * probably be sharing the OAuth scope across all of those APIs. When you - * need finer grained OAuth consent screens: talk with your product management - * about how developers will use them in practice. Please note that even - * though each of the canonical scopes is enough for a request to be accepted - * and passed to the backend, a request can still fail due to the backend - * requiring additional scopes or permissions. - */ - export interface Schema$OAuthRequirements { - /** - * The list of publicly documented OAuth scopes that are allowed access. An - * OAuth token containing any of these scopes will be accepted. Example: - * canonical_scopes: https://www.googleapis.com/auth/calendar, - * https://www.googleapis.com/auth/calendar.read - */ - canonicalScopes?: string; - } - /** - * This resource represents a long-running operation that is the result of a - * network API call. - */ - export interface Schema$Operation { - /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. - */ - done?: boolean; - /** - * The error result of the operation in case of failure or cancellation. - */ - error?: Schema$Status; - /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. - */ - metadata?: any; - /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. - */ - name?: string; - /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. - */ - response?: any; - } - /** - * The metadata associated with a long running operation resource. - */ - export interface Schema$OperationMetadata { - /** - * Percentage of completion of this operation, ranging from 0 to 100. - */ - progressPercentage?: number; - /** - * The full name of the resources that this operation is directly associated - * with. - */ - resourceNames?: string[]; - /** - * The start time of the operation. - */ - startTime?: string; - /** - * Detailed status information for each step. The order is undetermined. - */ - steps?: Schema$Step[]; - } - /** - * A protocol buffer option, which can be attached to a message, field, - * enumeration, etc. - */ - export interface Schema$Option { - /** - * The option's name. For protobuf built-in options (options defined in - * descriptor.proto), this is the short name. For example, - * `"map_entry"`. For custom options, it should be the - * fully-qualified name. For example, `"google.api.http"`. - */ - name?: string; - /** - * The option's value packed in an Any message. If the value is a - * primitive, the corresponding wrapper type defined in - * google/protobuf/wrappers.proto should be used. If the value is an enum, - * it should be stored as an int32 value using the - * google.protobuf.Int32Value type. - */ - value?: any; - } - /** - * Represents a documentation page. A page can contain subpages to represent - * nested documentation set structure. - */ - export interface Schema$Page { - /** - * The Markdown content of the page. You can use <code>&#40;== - * include {path} ==&#41;</code> to include content from a - * Markdown file. - */ - content?: string; - /** - * The name of the page. It will be used as an identity of the page to - * generate URI of the page, text of the link to this page in navigation, - * etc. The full page name (start from the root page name to this page - * concatenated with `.`) can be used as reference to the page in your - * documentation. For example: <pre><code>pages: - name: - * Tutorial content: &#40;== include tutorial.md ==&#41; subpages: - * - name: Java content: &#40;== include tutorial_java.md - * ==&#41; </code></pre> You can reference `Java` page using - * Markdown reference link syntax: `Java`. - */ - name?: string; - /** - * Subpages of this page. The order of subpages specified here will be - * honored in the generated docset. - */ - subpages?: Schema$Page[]; - } - /** - * The published version of a Service that is managed by Google Service - * Management. - */ - export interface Schema$PublishedService { - /** - * The resource name of the service. A valid name would be: - - * services/serviceuser.googleapis.com - */ - name?: string; - /** - * The service's published configuration. - */ - service?: Schema$Service; - } - /** - * Quota configuration helps to achieve fairness and budgeting in service - * usage. The quota configuration works this way: - The service configuration - * defines a set of metrics. - For API calls, the quota.metric_rules maps - * methods to metrics with corresponding costs. - The quota.limits defines - * limits on the metrics, which will be used for quota checks at runtime. An - * example quota configuration in yaml format: quota: limits: - - * name: apiWriteQpsPerProject metric: - * library.googleapis.com/write_calls unit: "1/min/{project}" - * # rate limit for consumer projects values: STANDARD: 10000 - * # The metric rules bind all methods to the read_calls metric, # except - * for the UpdateBook and DeleteBook methods. These two methods # are - * mapped to the write_calls metric, with the UpdateBook method # - * consuming at twice rate as the DeleteBook method. metric_rules: - - * selector: "*" metric_costs: - * library.googleapis.com/read_calls: 1 - selector: - * google.example.library.v1.LibraryService.UpdateBook metric_costs: - * library.googleapis.com/write_calls: 2 - selector: - * google.example.library.v1.LibraryService.DeleteBook metric_costs: - * library.googleapis.com/write_calls: 1 Corresponding Metric definition: - * metrics: - name: library.googleapis.com/read_calls display_name: Read - * requests metric_kind: DELTA value_type: INT64 - name: - * library.googleapis.com/write_calls display_name: Write requests - * metric_kind: DELTA value_type: INT64 - */ - export interface Schema$Quota { - /** - * List of `QuotaLimit` definitions for the service. - */ - limits?: Schema$QuotaLimit[]; - /** - * List of `MetricRule` definitions, each one mapping a selected method to - * one or more metrics. - */ - metricRules?: Schema$MetricRule[]; - } - /** - * `QuotaLimit` defines a specific limit that applies over a specified - * duration for a limit type. There can be at most one limit for a duration - * and limit type combination defined within a `QuotaGroup`. - */ - export interface Schema$QuotaLimit { - /** - * Default number of tokens that can be consumed during the specified - * duration. This is the number of tokens assigned when a client application - * developer activates the service for his/her project. Specifying a value - * of 0 will block all requests. This can be used if you are provisioning - * quota to selected consumers and blocking others. Similarly, a value of -1 - * will indicate an unlimited quota. No other negative values are allowed. - * Used by group-based quotas only. - */ - defaultLimit?: string; - /** - * Optional. User-visible, extended description for this quota limit. Should - * be used only when more context is needed to understand this limit than - * provided by the limit's display name (see: `display_name`). - */ - description?: string; - /** - * User-visible display name for this limit. Optional. If not set, the UI - * will provide a default display name based on the quota configuration. - * This field can be used to override the default display name generated - * from the configuration. - */ - displayName?: string; - /** - * Duration of this limit in textual notation. Example: "100s", - * "24h", "1d". For duration longer than a day, only - * multiple of days is supported. We support only "100s" and - * "1d" for now. Additional support will be added in the future. - * "0" indicates indefinite duration. Used by group-based quotas - * only. - */ - duration?: string; - /** - * Free tier value displayed in the Developers Console for this limit. The - * free tier is the number of tokens that will be subtracted from the billed - * amount when billing is enabled. This field can only be set on a limit - * with duration "1d", in a billable group; it is invalid on any - * other limit. If this field is not set, it defaults to 0, indicating that - * there is no free tier for this service. Used by group-based quotas only. - */ - freeTier?: string; - /** - * Maximum number of tokens that can be consumed during the specified - * duration. Client application developers can override the default limit up - * to this maximum. If specified, this value cannot be set to a value less - * than the default limit. If not specified, it is set to the default limit. - * To allow clients to apply overrides with no upper bound, set this to -1, - * indicating unlimited maximum quota. Used by group-based quotas only. - */ - maxLimit?: string; - /** - * The name of the metric this quota limit applies to. The quota limits with - * the same metric will be checked together during runtime. The metric must - * be defined within the service config. - */ - metric?: string; - /** - * Name of the quota limit. The name must be provided, and it must be - * unique within the service. The name can only include alphanumeric - * characters as well as '-'. The maximum length of the limit name - * is 64 characters. - */ - name?: string; - /** - * Specify the unit of the quota limit. It uses the same syntax as - * Metric.unit. The supported unit kinds are determined by the quota backend - * system. Here are some examples: * "1/min/{project}" for quota - * per minute per project. Note: the order of unit components is - * insignificant. The "1" at the beginning is required to follow - * the metric unit syntax. - */ - unit?: string; - /** - * Tiered limit values. You must specify this as a key:value pair, with an - * integer value that is the maximum number of requests allowed for the - * specified unit. Currently only STANDARD is supported. - */ - values?: any; - } - /** - * Response message for SearchServices method. - */ - export interface Schema$SearchServicesResponse { - /** - * Token that can be passed to `ListAvailableServices` to resume a paginated - * query. - */ - nextPageToken?: string; - /** - * Services available publicly or available to the authenticated caller. - */ - services?: Schema$PublishedService[]; - } - /** - * `Service` is the root object of Google service configuration schema. It - * describes basic information about a service, such as the name and the - * title, and delegates other aspects to sub-sections. Each sub-section is - * either a proto message or a repeated proto message that configures a - * specific aspect, such as auth. See each proto message definition for - * details. Example: type: google.api.Service config_version: 3 - * name: calendar.googleapis.com title: Google Calendar API apis: - - * name: google.calendar.v3.Calendar authentication: providers: - - * id: google_calendar_auth jwks_uri: - * https://www.googleapis.com/oauth2/v1/certs issuer: - * https://securetoken.google.com rules: - selector: "*" - * requirements: provider_id: google_calendar_auth - */ - export interface Schema$Service { - /** - * A list of API interfaces exported by this service. Only the `name` field - * of the google.protobuf.Api needs to be provided by the configuration - * author, as the remaining fields will be derived from the IDL during the - * normalization process. It is an error to specify an API interface here - * which cannot be resolved against the associated IDL files. - */ - apis?: Schema$Api[]; - /** - * Auth configuration. - */ - authentication?: Schema$Authentication; - /** - * API backend configuration. - */ - backend?: Schema$Backend; - /** - * Billing configuration. - */ - billing?: Schema$Billing; - /** - * The semantic version of the service configuration. The config version - * affects the interpretation of the service configuration. For example, - * certain features are enabled by default for certain config versions. The - * latest config version is `3`. - */ - configVersion?: number; - /** - * Context configuration. - */ - context?: Schema$Context; - /** - * Configuration for the service control plane. - */ - control?: Schema$Control; - /** - * Custom error configuration. - */ - customError?: Schema$CustomError; - /** - * Additional API documentation. - */ - documentation?: Schema$Documentation; - /** - * Configuration for network endpoints. If this is empty, then an endpoint - * with the same name as the service is automatically generated to service - * all defined APIs. - */ - endpoints?: Schema$Endpoint[]; - /** - * A list of all enum types included in this API service. Enums referenced - * directly or indirectly by the `apis` are automatically included. Enums - * which are not referenced but shall be included should be listed here by - * name. Example: enums: - name: google.someapi.v1.SomeEnum - */ - enums?: Schema$Enum[]; - /** - * Experimental configuration. - */ - experimental?: Schema$Experimental; - /** - * HTTP configuration. - */ - http?: Schema$Http; - /** - * A unique ID for a specific instance of this message, typically assigned - * by the client for tracking purpose. If empty, the server may choose to - * generate one instead. Must be no longer than 60 characters. - */ - id?: string; - /** - * Logging configuration. - */ - logging?: Schema$Logging; - /** - * Defines the logs used by this service. - */ - logs?: Schema$LogDescriptor[]; - /** - * Defines the metrics used by this service. - */ - metrics?: Schema$MetricDescriptor[]; - /** - * Defines the monitored resources used by this service. This is required by - * the Service.monitoring and Service.logging configurations. - */ - monitoredResources?: Schema$MonitoredResourceDescriptor[]; - /** - * Monitoring configuration. - */ - monitoring?: Schema$Monitoring; - /** - * The DNS address at which this service is available, e.g. - * `calendar.googleapis.com`. - */ - name?: string; - /** - * The Google project that owns this service. - */ - producerProjectId?: string; - /** - * Quota configuration. - */ - quota?: Schema$Quota; - /** - * Output only. The source information for this configuration if available. - */ - sourceInfo?: Schema$SourceInfo; - /** - * System parameter configuration. - */ - systemParameters?: Schema$SystemParameters; - /** - * A list of all proto message types included in this API service. It serves - * similar purpose as [google.api.Service.types], except that these types - * are not needed by user-defined APIs. Therefore, they will not show up in - * the generated discovery doc. This field should only be used to define - * system APIs in ESF. - */ - systemTypes?: Schema$Type[]; - /** - * The product title for this service. - */ - title?: string; - /** - * A list of all proto message types included in this API service. Types - * referenced directly or indirectly by the `apis` are automatically - * included. Messages which are not referenced but shall be included, such - * as types used by the `google.protobuf.Any` type, should be listed here by - * name. Example: types: - name: google.protobuf.Int32 - */ - types?: Schema$Type[]; - /** - * Configuration controlling usage of this service. - */ - usage?: Schema$Usage; - } - /** - * `SourceContext` represents information about the source of a protobuf - * element, like the file in which it is defined. - */ - export interface Schema$SourceContext { - /** - * The path-qualified name of the .proto file that contained the associated - * protobuf element. For example: - * `"google/protobuf/source_context.proto"`. - */ - fileName?: string; - } - /** - * Source information used to create a Service Config - */ - export interface Schema$SourceInfo { - /** - * All files used during config generation. - */ - sourceFiles?: any[]; - } - /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. - */ - export interface Schema$Status { - /** - * The status code, which should be an enum value of google.rpc.Code. - */ - code?: number; - /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. - */ - details?: any[]; - /** - * A developer-facing error message, which should be in English. Any - * user-facing error message should be localized and sent in the - * google.rpc.Status.details field, or localized by the client. - */ - message?: string; - } - /** - * Represents the status of one operation step. - */ - export interface Schema$Step { - /** - * The short description of the step. - */ - description?: string; - /** - * The status code. - */ - status?: string; - } - /** - * Define a parameter's name and location. The parameter may be passed as - * either an HTTP header or a URL query parameter, and if both are passed the - * behavior is implementation-dependent. - */ - export interface Schema$SystemParameter { - /** - * Define the HTTP header name to use for the parameter. It is case - * insensitive. - */ - httpHeader?: string; - /** - * Define the name of the parameter, such as "api_key" . It is - * case sensitive. - */ - name?: string; - /** - * Define the URL query parameter name to use for the parameter. It is case - * sensitive. - */ - urlQueryParameter?: string; - } - /** - * Define a system parameter rule mapping system parameter definitions to - * methods. - */ - export interface Schema$SystemParameterRule { - /** - * Define parameters. Multiple names may be defined for a parameter. For a - * given method call, only one of them should be used. If multiple names are - * used the behavior is implementation-dependent. If none of the specified - * names are present the behavior is parameter-dependent. - */ - parameters?: Schema$SystemParameter[]; - /** - * Selects the methods to which this rule applies. Use '*' to - * indicate all methods in all APIs. Refer to selector for syntax details. - */ - selector?: string; - } - /** - * ### System parameter configuration A system parameter is a special kind of - * parameter defined by the API system, not by an individual API. It is - * typically mapped to an HTTP header and/or a URL query parameter. This - * configuration specifies which methods change the names of the system - * parameters. - */ - export interface Schema$SystemParameters { - /** - * Define system parameters. The parameters defined here will override the - * default parameters implemented by the system. If this field is missing - * from the service config, default system parameters will be used. Default - * system parameters and names is implementation-dependent. Example: define - * api key for all methods system_parameters rules: - - * selector: "*" parameters: - name: api_key - * url_query_parameter: api_key Example: define 2 api key names for a - * specific method. system_parameters rules: - selector: - * "/ListShelves" parameters: - name: - * api_key http_header: Api-Key1 - name: api_key - * http_header: Api-Key2 **NOTE:** All service configuration rules follow - * "last one wins" order. - */ - rules?: Schema$SystemParameterRule[]; - } - /** - * A protocol buffer message type. - */ - export interface Schema$Type { - /** - * The list of fields. - */ - fields?: Schema$Field[]; - /** - * The fully qualified message name. - */ - name?: string; - /** - * The list of types appearing in `oneof` definitions in this type. - */ - oneofs?: string[]; - /** - * The protocol buffer options. - */ - options?: Schema$Option[]; - /** - * The source context. - */ - sourceContext?: Schema$SourceContext; - /** - * The source syntax. - */ - syntax?: string; - } - /** - * Configuration controlling usage of a service. - */ - export interface Schema$Usage { - /** - * The full resource name of a channel used for sending notifications to the - * service producer. Google Service Management currently only supports - * [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification - * channel. To use Google Cloud Pub/Sub as the channel, this must be the - * name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name - * format documented in https://cloud.google.com/pubsub/docs/overview. - */ - producerNotificationChannel?: string; - /** - * Requirements that must be satisfied before a consumer project can use the - * service. Each requirement is of the form - * <service.name>/<requirement-id>; for example - * 'serviceusage.googleapis.com/billing-enabled'. - */ - requirements?: string[]; - /** - * A list of usage rules that apply to individual API methods. **NOTE:** - * All service configuration rules follow "last one wins" order. - */ - rules?: Schema$UsageRule[]; - } - /** - * Usage configuration rules for the service. NOTE: Under development. Use - * this rule to configure unregistered calls for the service. Unregistered - * calls are calls that do not contain consumer project identity. (Example: - * calls that do not contain an API key). By default, API methods do not allow - * unregistered calls, and each method call must be identified by a consumer - * project identity. Use this rule to allow/disallow unregistered calls. - * Example of an API that wants to allow unregistered calls for entire - * service. usage: rules: - selector: "*" - * allow_unregistered_calls: true Example of a method that wants to allow - * unregistered calls. usage: rules: - selector: - * "google.example.library.v1.LibraryService.CreateBook" - * allow_unregistered_calls: true - */ - export interface Schema$UsageRule { - /** - * If true, the selected method allows unregistered calls, e.g. calls that - * don't identify any user or application. - */ - allowUnregisteredCalls?: boolean; - /** - * Selects the methods to which this rule applies. Use '*' to - * indicate all methods in all APIs. Refer to selector for syntax details. - */ - selector?: string; - /** - * If true, the selected method should skip service control and the control - * plane features, such as quota and billing, will not be available. This - * flag is used by Google Cloud Endpoints to bypass checks for internal - * methods, such as service health check methods. - */ - skipServiceControl?: boolean; - } - - - export class Resource$Projects { - root: Serviceuser; - services: Resource$Projects$Services; - constructor(root: Serviceuser) { - this.root = root; - this.getRoot.bind(this); - this.services = new Resource$Projects$Services(root); - } - - getRoot() { - return this.root; - } - } - - - export class Resource$Projects$Services { - root: Serviceuser; - constructor(root: Serviceuser) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * serviceuser.projects.services.disable - * @desc Disable a service so it can no longer be used with a project. This - * prevents unintended usage that may cause unexpected billing charges or - * security leaks. Operation - * @alias serviceuser.projects.services.disable - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Name of the consumer and the service to disable for that consumer. The Service User implementation accepts the following forms for consumer: - "project:" A valid path would be: - projects/my-project/services/servicemanagement.googleapis.com - * @param {().DisableServiceRequest} 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 - */ - disable( - params?: Params$Resource$Projects$Services$Disable, - options?: MethodOptions): AxiosPromise; - disable( - params: Params$Resource$Projects$Services$Disable, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - disable( - params: Params$Resource$Projects$Services$Disable, - callback: BodyResponseCallback): void; - disable(callback: BodyResponseCallback): void; - disable( - paramsOrCallback?: Params$Resource$Projects$Services$Disable| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Projects$Services$Disable; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Services$Disable; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://serviceuser.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:disable') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * serviceuser.projects.services.enable - * @desc Enable a service so it can be used with a project. See [Cloud Auth - * Guide](https://cloud.google.com/docs/authentication) for more - * information. Operation - * @alias serviceuser.projects.services.enable - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Name of the consumer and the service to enable for that consumer. A valid path would be: - projects/my-project/services/servicemanagement.googleapis.com - * @param {().EnableServiceRequest} 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 - */ - enable( - params?: Params$Resource$Projects$Services$Enable, - options?: MethodOptions): AxiosPromise; - enable( - params: Params$Resource$Projects$Services$Enable, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - enable( - params: Params$Resource$Projects$Services$Enable, - callback: BodyResponseCallback): void; - enable(callback: BodyResponseCallback): void; - enable( - paramsOrCallback?: Params$Resource$Projects$Services$Enable| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Projects$Services$Enable; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Services$Enable; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://serviceuser.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:enable') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * serviceuser.projects.services.list - * @desc List enabled services for the specified consumer. - * @alias serviceuser.projects.services.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.pageSize Requested size of the next page of data. - * @param {string=} params.pageToken Token identifying which result to start with; returned by a previous list call. - * @param {string} params.parent List enabled services for the specified parent. An example valid parent would be: - projects/my-project - * @param {object} [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$Services$List, - options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Projects$Services$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - list( - params: Params$Resource$Projects$Services$List, - callback: BodyResponseCallback): - void; - list(callback: BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Projects$Services$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Projects$Services$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Services$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://serviceuser.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/services') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Services$Disable { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Name of the consumer and the service to disable for that consumer. The - * Service User implementation accepts the following forms for consumer: - - * "project:" A valid path would be: - - * projects/my-project/services/servicemanagement.googleapis.com - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$DisableServiceRequest; - } - export interface Params$Resource$Projects$Services$Enable { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Name of the consumer and the service to enable for that consumer. A - * valid path would be: - - * projects/my-project/services/servicemanagement.googleapis.com - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$EnableServiceRequest; - } - export interface Params$Resource$Projects$Services$List { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Requested size of the next page of data. - */ - pageSize?: number; - /** - * Token identifying which result to start with; returned by a previous list - * call. - */ - pageToken?: string; - /** - * List enabled services for the specified parent. An example valid parent - * would be: - projects/my-project - */ - parent?: string; - } - - - - export class Resource$Services { - root: Serviceuser; - constructor(root: Serviceuser) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * serviceuser.services.search - * @desc Search available services. When no filter is specified, returns - * all accessible services. For authenticated users, also returns all - * services the calling user has "servicemanagement.services.bind" - * permission for. - * @alias serviceuser.services.search - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.pageSize Requested size of the next page of data. - * @param {string=} params.pageToken Token identifying which result to start with; returned by a previous list call. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - search(params?: Params$Resource$Services$Search, options?: MethodOptions): - AxiosPromise; - search( - params: Params$Resource$Services$Search, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - search( - params: Params$Resource$Services$Search, - callback: BodyResponseCallback): void; - search(callback: BodyResponseCallback): void; - search( - paramsOrCallback?: Params$Resource$Services$Search| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Services$Search; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Services$Search; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://serviceuser.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/services:search') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: [], - pathParams: [], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Services$Search { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Requested size of the next page of data. - */ - pageSize?: number; - /** - * Token identifying which result to start with; returned by a previous list - * call. - */ - pageToken?: string; - } -} diff --git a/src/apis/sheets/v4.ts b/src/apis/sheets/v4.ts index 622926d9be..0d3713b1db 100644 --- a/src/apis/sheets/v4.ts +++ b/src/apis/sheets/v4.ts @@ -29,6 +29,57 @@ export namespace sheets_v4 { version: 'v4'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Google Sheets API * @@ -4938,7 +4989,8 @@ export namespace sheets_v4 { } } - export interface Params$Resource$Spreadsheets$Batchupdate { + export interface Params$Resource$Spreadsheets$Batchupdate extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4954,7 +5006,8 @@ export namespace sheets_v4 { */ requestBody?: Schema$BatchUpdateSpreadsheetRequest; } - export interface Params$Resource$Spreadsheets$Create { + export interface Params$Resource$Spreadsheets$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4966,7 +5019,7 @@ export namespace sheets_v4 { */ requestBody?: Schema$Spreadsheet; } - export interface Params$Resource$Spreadsheets$Get { + export interface Params$Resource$Spreadsheets$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4986,7 +5039,8 @@ export namespace sheets_v4 { */ spreadsheetId?: string; } - export interface Params$Resource$Spreadsheets$Getbydatafilter { + export interface Params$Resource$Spreadsheets$Getbydatafilter extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5269,7 +5323,8 @@ export namespace sheets_v4 { } } - export interface Params$Resource$Spreadsheets$Developermetadata$Get { + export interface Params$Resource$Spreadsheets$Developermetadata$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5284,7 +5339,8 @@ export namespace sheets_v4 { */ spreadsheetId?: string; } - export interface Params$Resource$Spreadsheets$Developermetadata$Search { + export interface Params$Resource$Spreadsheets$Developermetadata$Search extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5445,7 +5501,8 @@ export namespace sheets_v4 { } } - export interface Params$Resource$Spreadsheets$Sheets$Copyto { + export interface Params$Resource$Spreadsheets$Sheets$Copyto extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6880,7 +6937,8 @@ export namespace sheets_v4 { } } - export interface Params$Resource$Spreadsheets$Values$Append { + export interface Params$Resource$Spreadsheets$Values$Append extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6927,7 +6985,8 @@ export namespace sheets_v4 { */ requestBody?: Schema$ValueRange; } - export interface Params$Resource$Spreadsheets$Values$Batchclear { + export interface Params$Resource$Spreadsheets$Values$Batchclear extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6943,7 +7002,8 @@ export namespace sheets_v4 { */ requestBody?: Schema$BatchClearValuesRequest; } - export interface Params$Resource$Spreadsheets$Values$Batchclearbydatafilter { + export interface Params$Resource$Spreadsheets$Values$Batchclearbydatafilter + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6959,7 +7019,8 @@ export namespace sheets_v4 { */ requestBody?: Schema$BatchClearValuesByDataFilterRequest; } - export interface Params$Resource$Spreadsheets$Values$Batchget { + export interface Params$Resource$Spreadsheets$Values$Batchget extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6993,7 +7054,8 @@ export namespace sheets_v4 { */ valueRenderOption?: string; } - export interface Params$Resource$Spreadsheets$Values$Batchgetbydatafilter { + export interface Params$Resource$Spreadsheets$Values$Batchgetbydatafilter + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7009,7 +7071,8 @@ export namespace sheets_v4 { */ requestBody?: Schema$BatchGetValuesByDataFilterRequest; } - export interface Params$Resource$Spreadsheets$Values$Batchupdate { + export interface Params$Resource$Spreadsheets$Values$Batchupdate extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7025,7 +7088,8 @@ export namespace sheets_v4 { */ requestBody?: Schema$BatchUpdateValuesRequest; } - export interface Params$Resource$Spreadsheets$Values$Batchupdatebydatafilter { + export interface Params$Resource$Spreadsheets$Values$Batchupdatebydatafilter + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7041,7 +7105,8 @@ export namespace sheets_v4 { */ requestBody?: Schema$BatchUpdateValuesByDataFilterRequest; } - export interface Params$Resource$Spreadsheets$Values$Clear { + export interface Params$Resource$Spreadsheets$Values$Clear extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7061,7 +7126,8 @@ export namespace sheets_v4 { */ requestBody?: Schema$ClearValuesRequest; } - export interface Params$Resource$Spreadsheets$Values$Get { + export interface Params$Resource$Spreadsheets$Values$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7095,7 +7161,8 @@ export namespace sheets_v4 { */ valueRenderOption?: string; } - export interface Params$Resource$Spreadsheets$Values$Update { + export interface Params$Resource$Spreadsheets$Values$Update extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/siteVerification/v1.ts b/src/apis/siteVerification/v1.ts index 58f78bc9dc..b3e1af3948 100644 --- a/src/apis/siteVerification/v1.ts +++ b/src/apis/siteVerification/v1.ts @@ -29,6 +29,40 @@ export namespace siteVerification_v1 { version: 'v1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Google Site Verification API * @@ -646,7 +680,8 @@ export namespace siteVerification_v1 { } } - export interface Params$Resource$Webresource$Delete { + export interface Params$Resource$Webresource$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -657,7 +692,7 @@ export namespace siteVerification_v1 { */ id?: string; } - export interface Params$Resource$Webresource$Get { + export interface Params$Resource$Webresource$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -668,7 +703,8 @@ export namespace siteVerification_v1 { */ id?: string; } - export interface Params$Resource$Webresource$Gettoken { + export interface Params$Resource$Webresource$Gettoken extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -680,7 +716,8 @@ export namespace siteVerification_v1 { */ requestBody?: Schema$SiteVerificationWebResourceGettokenRequest; } - export interface Params$Resource$Webresource$Insert { + export interface Params$Resource$Webresource$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -696,13 +733,14 @@ export namespace siteVerification_v1 { */ requestBody?: Schema$SiteVerificationWebResourceResource; } - export interface Params$Resource$Webresource$List { + export interface Params$Resource$Webresource$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; } - export interface Params$Resource$Webresource$Patch { + export interface Params$Resource$Webresource$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -718,7 +756,8 @@ export namespace siteVerification_v1 { */ requestBody?: Schema$SiteVerificationWebResourceResource; } - export interface Params$Resource$Webresource$Update { + export interface Params$Resource$Webresource$Update extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/slides/v1.ts b/src/apis/slides/v1.ts index 21cf103d53..6e15d6e391 100644 --- a/src/apis/slides/v1.ts +++ b/src/apis/slides/v1.ts @@ -29,10 +29,61 @@ export namespace slides_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Google Slides API * - * An API for creating and editing Google Slides presentations. + * Reads and writes Google Slides presentations. * * @example * const {google} = require('googleapis'); @@ -1956,7 +2007,7 @@ export namespace slides_v1 { export interface Schema$Shadow { /** * The alignment point of the shadow, that sets the origin for translate, - * scale and skew of the shadow. + * scale and skew of the shadow. This property is read-only. */ alignment?: string; /** @@ -1981,7 +2032,8 @@ export namespace slides_v1 { */ propertyState?: string; /** - * Whether the shadow should rotate with the shape. + * Whether the shadow should rotate with the shape. This property is + * read-only. */ rotateWithShape?: boolean; /** @@ -1990,7 +2042,7 @@ export namespace slides_v1 { */ transform?: Schema$AffineTransform; /** - * The type of the shadow. + * The type of the shadow. This property is read-only. */ type?: string; } @@ -3378,7 +3430,8 @@ export namespace slides_v1 { } } - export interface Params$Resource$Presentations$Batchupdate { + export interface Params$Resource$Presentations$Batchupdate extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3394,7 +3447,8 @@ export namespace slides_v1 { */ requestBody?: Schema$BatchUpdatePresentationRequest; } - export interface Params$Resource$Presentations$Create { + export interface Params$Resource$Presentations$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3406,7 +3460,8 @@ export namespace slides_v1 { */ requestBody?: Schema$Presentation; } - export interface Params$Resource$Presentations$Get { + export interface Params$Resource$Presentations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3569,7 +3624,8 @@ export namespace slides_v1 { } } - export interface Params$Resource$Presentations$Pages$Get { + export interface Params$Resource$Presentations$Pages$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3584,7 +3640,8 @@ export namespace slides_v1 { */ presentationId?: string; } - export interface Params$Resource$Presentations$Pages$Getthumbnail { + export interface Params$Resource$Presentations$Pages$Getthumbnail extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/sourcerepo/README.md b/src/apis/sourcerepo/README.md index 0b21298006..547f4938da 100644 --- a/src/apis/sourcerepo/README.md +++ b/src/apis/sourcerepo/README.md @@ -2,7 +2,7 @@ # @google/sourcerepo -> Access source code repositories hosted by Google. +> Accesses source code repositories hosted by Google. ## Installation diff --git a/src/apis/sourcerepo/v1.ts b/src/apis/sourcerepo/v1.ts index 75ee887ace..efa58f55cf 100644 --- a/src/apis/sourcerepo/v1.ts +++ b/src/apis/sourcerepo/v1.ts @@ -29,6 +29,57 @@ export namespace sourcerepo_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Source Repositories API * @@ -570,7 +621,8 @@ export namespace sourcerepo_v1 { } } - export interface Params$Resource$Projects$Getconfig { + export interface Params$Resource$Projects$Getconfig extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -582,7 +634,8 @@ export namespace sourcerepo_v1 { */ name?: string; } - export interface Params$Resource$Projects$Updateconfig { + export interface Params$Resource$Projects$Updateconfig extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1153,7 +1206,8 @@ export namespace sourcerepo_v1 { } } - export interface Params$Resource$Projects$Repos$Create { + export interface Params$Resource$Projects$Repos$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1170,7 +1224,8 @@ export namespace sourcerepo_v1 { */ requestBody?: Schema$Repo; } - export interface Params$Resource$Projects$Repos$Delete { + export interface Params$Resource$Projects$Repos$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1182,7 +1237,8 @@ export namespace sourcerepo_v1 { */ name?: string; } - export interface Params$Resource$Projects$Repos$Get { + export interface Params$Resource$Projects$Repos$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1194,7 +1250,8 @@ export namespace sourcerepo_v1 { */ name?: string; } - export interface Params$Resource$Projects$Repos$Getiampolicy { + export interface Params$Resource$Projects$Repos$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1206,7 +1263,8 @@ export namespace sourcerepo_v1 { */ resource?: string; } - export interface Params$Resource$Projects$Repos$List { + export interface Params$Resource$Projects$Repos$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1229,7 +1287,8 @@ export namespace sourcerepo_v1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Repos$Patch { + export interface Params$Resource$Projects$Repos$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1246,7 +1305,8 @@ export namespace sourcerepo_v1 { */ requestBody?: Schema$UpdateRepoRequest; } - export interface Params$Resource$Projects$Repos$Setiampolicy { + export interface Params$Resource$Projects$Repos$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1263,7 +1323,8 @@ export namespace sourcerepo_v1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Repos$Testiampermissions { + export interface Params$Resource$Projects$Repos$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/spanner/v1.ts b/src/apis/spanner/v1.ts index a0667202d2..b28b95eabe 100644 --- a/src/apis/spanner/v1.ts +++ b/src/apis/spanner/v1.ts @@ -29,6 +29,57 @@ export namespace spanner_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Spanner API * @@ -1927,7 +1978,8 @@ export namespace spanner_v1 { } } - export interface Params$Resource$Projects$Instanceconfigs$Get { + export interface Params$Resource$Projects$Instanceconfigs$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1939,7 +1991,8 @@ export namespace spanner_v1 { */ name?: string; } - export interface Params$Resource$Projects$Instanceconfigs$List { + export interface Params$Resource$Projects$Instanceconfigs$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2574,7 +2627,8 @@ export namespace spanner_v1 { } } - export interface Params$Resource$Projects$Instances$Create { + export interface Params$Resource$Projects$Instances$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2591,7 +2645,8 @@ export namespace spanner_v1 { */ requestBody?: Schema$CreateInstanceRequest; } - export interface Params$Resource$Projects$Instances$Delete { + export interface Params$Resource$Projects$Instances$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2603,7 +2658,8 @@ export namespace spanner_v1 { */ name?: string; } - export interface Params$Resource$Projects$Instances$Get { + export interface Params$Resource$Projects$Instances$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2615,7 +2671,8 @@ export namespace spanner_v1 { */ name?: string; } - export interface Params$Resource$Projects$Instances$Getiampolicy { + export interface Params$Resource$Projects$Instances$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2634,7 +2691,8 @@ export namespace spanner_v1 { */ requestBody?: Schema$GetIamPolicyRequest; } - export interface Params$Resource$Projects$Instances$List { + export interface Params$Resource$Projects$Instances$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2670,7 +2728,8 @@ export namespace spanner_v1 { */ parent?: string; } - export interface Params$Resource$Projects$Instances$Patch { + export interface Params$Resource$Projects$Instances$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2689,7 +2748,8 @@ export namespace spanner_v1 { */ requestBody?: Schema$UpdateInstanceRequest; } - export interface Params$Resource$Projects$Instances$Setiampolicy { + export interface Params$Resource$Projects$Instances$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2708,7 +2768,8 @@ export namespace spanner_v1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Instances$Testiampermissions { + export interface Params$Resource$Projects$Instances$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3385,7 +3446,8 @@ export namespace spanner_v1 { } } - export interface Params$Resource$Projects$Instances$Databases$Create { + export interface Params$Resource$Projects$Instances$Databases$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3402,7 +3464,8 @@ export namespace spanner_v1 { */ requestBody?: Schema$CreateDatabaseRequest; } - export interface Params$Resource$Projects$Instances$Databases$Dropdatabase { + export interface Params$Resource$Projects$Instances$Databases$Dropdatabase + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3413,7 +3476,8 @@ export namespace spanner_v1 { */ database?: string; } - export interface Params$Resource$Projects$Instances$Databases$Get { + export interface Params$Resource$Projects$Instances$Databases$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3425,7 +3489,8 @@ export namespace spanner_v1 { */ name?: string; } - export interface Params$Resource$Projects$Instances$Databases$Getddl { + export interface Params$Resource$Projects$Instances$Databases$Getddl extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3436,7 +3501,8 @@ export namespace spanner_v1 { */ database?: string; } - export interface Params$Resource$Projects$Instances$Databases$Getiampolicy { + export interface Params$Resource$Projects$Instances$Databases$Getiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3455,7 +3521,8 @@ export namespace spanner_v1 { */ requestBody?: Schema$GetIamPolicyRequest; } - export interface Params$Resource$Projects$Instances$Databases$List { + export interface Params$Resource$Projects$Instances$Databases$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3477,7 +3544,8 @@ export namespace spanner_v1 { */ parent?: string; } - export interface Params$Resource$Projects$Instances$Databases$Setiampolicy { + export interface Params$Resource$Projects$Instances$Databases$Setiampolicy + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3496,7 +3564,8 @@ export namespace spanner_v1 { */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Instances$Databases$Testiampermissions { + export interface Params$Resource$Projects$Instances$Databases$Testiampermissions + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3515,7 +3584,8 @@ export namespace spanner_v1 { */ requestBody?: Schema$TestIamPermissionsRequest; } - export interface Params$Resource$Projects$Instances$Databases$Updateddl { + export interface Params$Resource$Projects$Instances$Databases$Updateddl + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3836,7 +3906,8 @@ export namespace spanner_v1 { } } - export interface Params$Resource$Projects$Instances$Databases$Operations$Cancel { + export interface Params$Resource$Projects$Instances$Databases$Operations$Cancel + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3847,7 +3918,8 @@ export namespace spanner_v1 { */ name?: string; } - export interface Params$Resource$Projects$Instances$Databases$Operations$Delete { + export interface Params$Resource$Projects$Instances$Databases$Operations$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3858,7 +3930,8 @@ export namespace spanner_v1 { */ name?: string; } - export interface Params$Resource$Projects$Instances$Databases$Operations$Get { + export interface Params$Resource$Projects$Instances$Databases$Operations$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3869,7 +3942,8 @@ export namespace spanner_v1 { */ name?: string; } - export interface Params$Resource$Projects$Instances$Databases$Operations$List { + export interface Params$Resource$Projects$Instances$Databases$Operations$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4893,7 +4967,8 @@ export namespace spanner_v1 { } } - export interface Params$Resource$Projects$Instances$Databases$Sessions$Begintransaction { + export interface Params$Resource$Projects$Instances$Databases$Sessions$Begintransaction + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4909,7 +4984,8 @@ export namespace spanner_v1 { */ requestBody?: Schema$BeginTransactionRequest; } - export interface Params$Resource$Projects$Instances$Databases$Sessions$Commit { + export interface Params$Resource$Projects$Instances$Databases$Sessions$Commit + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4926,7 +5002,8 @@ export namespace spanner_v1 { */ requestBody?: Schema$CommitRequest; } - export interface Params$Resource$Projects$Instances$Databases$Sessions$Create { + export interface Params$Resource$Projects$Instances$Databases$Sessions$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4942,7 +5019,8 @@ export namespace spanner_v1 { */ requestBody?: Schema$CreateSessionRequest; } - export interface Params$Resource$Projects$Instances$Databases$Sessions$Delete { + export interface Params$Resource$Projects$Instances$Databases$Sessions$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4953,7 +5031,8 @@ export namespace spanner_v1 { */ name?: string; } - export interface Params$Resource$Projects$Instances$Databases$Sessions$Executesql { + export interface Params$Resource$Projects$Instances$Databases$Sessions$Executesql + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4969,7 +5048,8 @@ export namespace spanner_v1 { */ requestBody?: Schema$ExecuteSqlRequest; } - export interface Params$Resource$Projects$Instances$Databases$Sessions$Executestreamingsql { + export interface Params$Resource$Projects$Instances$Databases$Sessions$Executestreamingsql + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4985,7 +5065,8 @@ export namespace spanner_v1 { */ requestBody?: Schema$ExecuteSqlRequest; } - export interface Params$Resource$Projects$Instances$Databases$Sessions$Get { + export interface Params$Resource$Projects$Instances$Databases$Sessions$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4996,7 +5077,8 @@ export namespace spanner_v1 { */ name?: string; } - export interface Params$Resource$Projects$Instances$Databases$Sessions$List { + export interface Params$Resource$Projects$Instances$Databases$Sessions$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5026,7 +5108,8 @@ export namespace spanner_v1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Instances$Databases$Sessions$Partitionquery { + export interface Params$Resource$Projects$Instances$Databases$Sessions$Partitionquery + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5042,7 +5125,8 @@ export namespace spanner_v1 { */ requestBody?: Schema$PartitionQueryRequest; } - export interface Params$Resource$Projects$Instances$Databases$Sessions$Partitionread { + export interface Params$Resource$Projects$Instances$Databases$Sessions$Partitionread + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5058,7 +5142,8 @@ export namespace spanner_v1 { */ requestBody?: Schema$PartitionReadRequest; } - export interface Params$Resource$Projects$Instances$Databases$Sessions$Read { + export interface Params$Resource$Projects$Instances$Databases$Sessions$Read + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5074,7 +5159,8 @@ export namespace spanner_v1 { */ requestBody?: Schema$ReadRequest; } - export interface Params$Resource$Projects$Instances$Databases$Sessions$Rollback { + export interface Params$Resource$Projects$Instances$Databases$Sessions$Rollback + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5090,7 +5176,8 @@ export namespace spanner_v1 { */ requestBody?: Schema$RollbackRequest; } - export interface Params$Resource$Projects$Instances$Databases$Sessions$Streamingread { + export interface Params$Resource$Projects$Instances$Databases$Sessions$Streamingread + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5405,7 +5492,8 @@ export namespace spanner_v1 { } } - export interface Params$Resource$Projects$Instances$Operations$Cancel { + export interface Params$Resource$Projects$Instances$Operations$Cancel extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5416,7 +5504,8 @@ export namespace spanner_v1 { */ name?: string; } - export interface Params$Resource$Projects$Instances$Operations$Delete { + export interface Params$Resource$Projects$Instances$Operations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5427,7 +5516,8 @@ export namespace spanner_v1 { */ name?: string; } - export interface Params$Resource$Projects$Instances$Operations$Get { + export interface Params$Resource$Projects$Instances$Operations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5438,7 +5528,8 @@ export namespace spanner_v1 { */ name?: string; } - export interface Params$Resource$Projects$Instances$Operations$List { + export interface Params$Resource$Projects$Instances$Operations$List extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/speech/v1.ts b/src/apis/speech/v1.ts index ecaf46ce24..07f396cb65 100644 --- a/src/apis/speech/v1.ts +++ b/src/apis/speech/v1.ts @@ -29,6 +29,57 @@ export namespace speech_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Speech API * @@ -582,7 +633,7 @@ export namespace speech_v1 { } } - export interface Params$Resource$Operations$Get { + export interface Params$Resource$Operations$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -593,7 +644,7 @@ export namespace speech_v1 { */ name?: string; } - export interface Params$Resource$Operations$List { + export interface Params$Resource$Operations$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -768,7 +819,8 @@ export namespace speech_v1 { } } - export interface Params$Resource$Speech$Longrunningrecognize { + export interface Params$Resource$Speech$Longrunningrecognize extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -780,7 +832,7 @@ export namespace speech_v1 { */ requestBody?: Schema$LongRunningRecognizeRequest; } - export interface Params$Resource$Speech$Recognize { + export interface Params$Resource$Speech$Recognize extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/speech/v1beta1.ts b/src/apis/speech/v1beta1.ts index 853e85605e..851cd19df6 100644 --- a/src/apis/speech/v1beta1.ts +++ b/src/apis/speech/v1beta1.ts @@ -29,6 +29,57 @@ export namespace speech_v1beta1 { version: 'v1beta1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Speech API * @@ -481,7 +532,7 @@ export namespace speech_v1beta1 { } } - export interface Params$Resource$Operations$Get { + export interface Params$Resource$Operations$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -492,7 +543,7 @@ export namespace speech_v1beta1 { */ name?: string; } - export interface Params$Resource$Operations$List { + export interface Params$Resource$Operations$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -670,7 +721,8 @@ export namespace speech_v1beta1 { } } - export interface Params$Resource$Speech$Asyncrecognize { + export interface Params$Resource$Speech$Asyncrecognize extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -682,7 +734,8 @@ export namespace speech_v1beta1 { */ requestBody?: Schema$AsyncRecognizeRequest; } - export interface Params$Resource$Speech$Syncrecognize { + export interface Params$Resource$Speech$Syncrecognize extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/sqladmin/v1beta4.ts b/src/apis/sqladmin/v1beta4.ts index e93f23f010..7c86d52631 100644 --- a/src/apis/sqladmin/v1beta4.ts +++ b/src/apis/sqladmin/v1beta4.ts @@ -29,6 +29,40 @@ export namespace sqladmin_v1beta4 { version: 'v1beta4'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Cloud SQL Admin API * @@ -101,6 +135,19 @@ export namespace sqladmin_v1beta4 { */ value?: string; } + /** + * An Admin API warning message. + */ + export interface Schema$ApiWarning { + /** + * Code to uniquely identify the warning type. + */ + code?: string; + /** + * The warning message. + */ + message?: string; + } /** * Database instance backup configuration. */ @@ -744,6 +791,10 @@ export namespace sqladmin_v1beta4 { * this value in a subsequent request to return the next page of results. */ nextPageToken?: string; + /** + * List of warnings that ocurred while handling the request. + */ + warnings?: Schema$ApiWarning[]; } /** * Instances ListServerCas response. @@ -801,7 +852,10 @@ export namespace sqladmin_v1beta4 { */ ipv4Enabled?: boolean; /** - * Reserved for future use. + * The resource link for the VPC network from which the Cloud SQL instance + * is accessible for private IP. For example, + * /projects/myProject/global/networks/default. This setting can be updated, + * but it cannot be removed after it is set. */ privateNetwork?: string; /** @@ -855,7 +909,7 @@ export namespace sqladmin_v1beta4 { } /** * Maintenance window. This specifies when a v2 Cloud SQL instance should - * preferably be restarted for system maintenance puruposes. + * preferably be restarted for system maintenance purposes. */ export interface Schema$MaintenanceWindow { /** @@ -1771,7 +1825,8 @@ export namespace sqladmin_v1beta4 { } } - export interface Params$Resource$Backupruns$Delete { + export interface Params$Resource$Backupruns$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1791,7 +1846,7 @@ export namespace sqladmin_v1beta4 { */ project?: string; } - export interface Params$Resource$Backupruns$Get { + export interface Params$Resource$Backupruns$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1810,7 +1865,8 @@ export namespace sqladmin_v1beta4 { */ project?: string; } - export interface Params$Resource$Backupruns$Insert { + export interface Params$Resource$Backupruns$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1830,7 +1886,7 @@ export namespace sqladmin_v1beta4 { */ requestBody?: Schema$BackupRun; } - export interface Params$Resource$Backupruns$List { + export interface Params$Resource$Backupruns$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2284,7 +2340,7 @@ export namespace sqladmin_v1beta4 { } } - export interface Params$Resource$Databases$Delete { + export interface Params$Resource$Databases$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2303,7 +2359,7 @@ export namespace sqladmin_v1beta4 { */ project?: string; } - export interface Params$Resource$Databases$Get { + export interface Params$Resource$Databases$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2322,7 +2378,7 @@ export namespace sqladmin_v1beta4 { */ project?: string; } - export interface Params$Resource$Databases$Insert { + export interface Params$Resource$Databases$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2342,7 +2398,7 @@ export namespace sqladmin_v1beta4 { */ requestBody?: Schema$Database; } - export interface Params$Resource$Databases$List { + export interface Params$Resource$Databases$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2357,7 +2413,7 @@ export namespace sqladmin_v1beta4 { */ project?: string; } - export interface Params$Resource$Databases$Patch { + export interface Params$Resource$Databases$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2381,7 +2437,7 @@ export namespace sqladmin_v1beta4 { */ requestBody?: Schema$Database; } - export interface Params$Resource$Databases$Update { + export interface Params$Resource$Databases$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2484,7 +2540,7 @@ export namespace sqladmin_v1beta4 { } } - export interface Params$Resource$Flags$List { + export interface Params$Resource$Flags$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3961,7 +4017,8 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< } } - export interface Params$Resource$Instances$Addserverca { + export interface Params$Resource$Instances$Addserverca extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3976,7 +4033,7 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< */ project?: string; } - export interface Params$Resource$Instances$Clone { + export interface Params$Resource$Instances$Clone extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3997,7 +4054,7 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< */ requestBody?: Schema$InstancesCloneRequest; } - export interface Params$Resource$Instances$Delete { + export interface Params$Resource$Instances$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4012,7 +4069,8 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< */ project?: string; } - export interface Params$Resource$Instances$Demotemaster { + export interface Params$Resource$Instances$Demotemaster extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4032,7 +4090,7 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< */ requestBody?: Schema$InstancesDemoteMasterRequest; } - export interface Params$Resource$Instances$Export { + export interface Params$Resource$Instances$Export extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4052,7 +4110,8 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< */ requestBody?: Schema$InstancesExportRequest; } - export interface Params$Resource$Instances$Failover { + export interface Params$Resource$Instances$Failover extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4072,7 +4131,7 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< */ requestBody?: Schema$InstancesFailoverRequest; } - export interface Params$Resource$Instances$Get { + export interface Params$Resource$Instances$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4087,7 +4146,7 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< */ project?: string; } - export interface Params$Resource$Instances$Import { + export interface Params$Resource$Instances$Import extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4107,7 +4166,7 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< */ requestBody?: Schema$InstancesImportRequest; } - export interface Params$Resource$Instances$Insert { + export interface Params$Resource$Instances$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4124,7 +4183,7 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< */ requestBody?: Schema$DatabaseInstance; } - export interface Params$Resource$Instances$List { + export interface Params$Resource$Instances$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4149,7 +4208,8 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< */ project?: string; } - export interface Params$Resource$Instances$Listservercas { + export interface Params$Resource$Instances$Listservercas extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4164,7 +4224,7 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< */ project?: string; } - export interface Params$Resource$Instances$Patch { + export interface Params$Resource$Instances$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4184,7 +4244,8 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< */ requestBody?: Schema$DatabaseInstance; } - export interface Params$Resource$Instances$Promotereplica { + export interface Params$Resource$Instances$Promotereplica extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4199,7 +4260,8 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< */ project?: string; } - export interface Params$Resource$Instances$Resetsslconfig { + export interface Params$Resource$Instances$Resetsslconfig extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4214,7 +4276,8 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< */ project?: string; } - export interface Params$Resource$Instances$Restart { + export interface Params$Resource$Instances$Restart extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4229,7 +4292,8 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< */ project?: string; } - export interface Params$Resource$Instances$Restorebackup { + export interface Params$Resource$Instances$Restorebackup extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4249,7 +4313,8 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< */ requestBody?: Schema$InstancesRestoreBackupRequest; } - export interface Params$Resource$Instances$Rotateserverca { + export interface Params$Resource$Instances$Rotateserverca extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4269,7 +4334,8 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< */ requestBody?: Schema$InstancesRotateServerCaRequest; } - export interface Params$Resource$Instances$Startreplica { + export interface Params$Resource$Instances$Startreplica extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4284,7 +4350,8 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< */ project?: string; } - export interface Params$Resource$Instances$Stopreplica { + export interface Params$Resource$Instances$Stopreplica extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4299,7 +4366,8 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< */ project?: string; } - export interface Params$Resource$Instances$Truncatelog { + export interface Params$Resource$Instances$Truncatelog extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4319,7 +4387,7 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< */ requestBody?: Schema$InstancesTruncateLogRequest; } - export interface Params$Resource$Instances$Update { + export interface Params$Resource$Instances$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4488,7 +4556,7 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< } } - export interface Params$Resource$Operations$Get { + export interface Params$Resource$Operations$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4503,7 +4571,7 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< */ project?: string; } - export interface Params$Resource$Operations$List { + export interface Params$Resource$Operations$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4892,7 +4960,8 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< } } - export interface Params$Resource$Sslcerts$Createephemeral { + export interface Params$Resource$Sslcerts$Createephemeral extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4912,7 +4981,7 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< */ requestBody?: Schema$SslCertsCreateEphemeralRequest; } - export interface Params$Resource$Sslcerts$Delete { + export interface Params$Resource$Sslcerts$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4931,7 +5000,7 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< */ sha1Fingerprint?: string; } - export interface Params$Resource$Sslcerts$Get { + export interface Params$Resource$Sslcerts$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4950,7 +5019,7 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< */ sha1Fingerprint?: string; } - export interface Params$Resource$Sslcerts$Insert { + export interface Params$Resource$Sslcerts$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4970,7 +5039,7 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< */ requestBody?: Schema$SslCertsInsertRequest; } - export interface Params$Resource$Sslcerts$List { + export interface Params$Resource$Sslcerts$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5065,7 +5134,7 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< } } - export interface Params$Resource$Tiers$List { + export interface Params$Resource$Tiers$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5368,7 +5437,7 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< } } - export interface Params$Resource$Users$Delete { + export interface Params$Resource$Users$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5391,7 +5460,7 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< */ project?: string; } - export interface Params$Resource$Users$Insert { + export interface Params$Resource$Users$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5411,7 +5480,7 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< */ requestBody?: Schema$User; } - export interface Params$Resource$Users$List { + export interface Params$Resource$Users$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5426,7 +5495,7 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< */ project?: string; } - export interface Params$Resource$Users$Update { + export interface Params$Resource$Users$Update extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/storage/v1.ts b/src/apis/storage/v1.ts index 60b5ae3523..3d158d4545 100644 --- a/src/apis/storage/v1.ts +++ b/src/apis/storage/v1.ts @@ -29,6 +29,40 @@ export namespace storage_v1 { version: 'v1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Cloud Storage JSON API * @@ -1582,7 +1616,8 @@ export namespace storage_v1 { } } - export interface Params$Resource$Bucketaccesscontrols$Delete { + export interface Params$Resource$Bucketaccesscontrols$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1603,7 +1638,8 @@ export namespace storage_v1 { */ userProject?: string; } - export interface Params$Resource$Bucketaccesscontrols$Get { + export interface Params$Resource$Bucketaccesscontrols$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1624,7 +1660,8 @@ export namespace storage_v1 { */ userProject?: string; } - export interface Params$Resource$Bucketaccesscontrols$Insert { + export interface Params$Resource$Bucketaccesscontrols$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1645,7 +1682,8 @@ export namespace storage_v1 { */ requestBody?: Schema$BucketAccessControl; } - export interface Params$Resource$Bucketaccesscontrols$List { + export interface Params$Resource$Bucketaccesscontrols$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1661,7 +1699,8 @@ export namespace storage_v1 { */ userProject?: string; } - export interface Params$Resource$Bucketaccesscontrols$Patch { + export interface Params$Resource$Bucketaccesscontrols$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1687,7 +1726,8 @@ export namespace storage_v1 { */ requestBody?: Schema$BucketAccessControl; } - export interface Params$Resource$Bucketaccesscontrols$Update { + export interface Params$Resource$Bucketaccesscontrols$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2410,9 +2450,9 @@ export namespace storage_v1 { /** * storage.buckets.patch - * @desc Updates a bucket. Changes to the bucket will be readable + * @desc Patches a bucket. Changes to the bucket will be readable * immediately after writing, but configuration changes may take time to - * propagate. This method supports patch semantics. + * propagate. * @example * * // BEFORE RUNNING: * // --------------- @@ -2932,7 +2972,7 @@ export namespace storage_v1 { } } - export interface Params$Resource$Buckets$Delete { + export interface Params$Resource$Buckets$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2957,7 +2997,7 @@ export namespace storage_v1 { */ userProject?: string; } - export interface Params$Resource$Buckets$Get { + export interface Params$Resource$Buckets$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2987,7 +3027,8 @@ export namespace storage_v1 { */ userProject?: string; } - export interface Params$Resource$Buckets$Getiampolicy { + export interface Params$Resource$Buckets$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3003,7 +3044,7 @@ export namespace storage_v1 { */ userProject?: string; } - export interface Params$Resource$Buckets$Insert { + export interface Params$Resource$Buckets$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3037,7 +3078,7 @@ export namespace storage_v1 { */ requestBody?: Schema$Bucket; } - export interface Params$Resource$Buckets$List { + export interface Params$Resource$Buckets$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3070,7 +3111,8 @@ export namespace storage_v1 { */ userProject?: string; } - export interface Params$Resource$Buckets$Lockretentionpolicy { + export interface Params$Resource$Buckets$Lockretentionpolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3091,7 +3133,7 @@ export namespace storage_v1 { */ userProject?: string; } - export interface Params$Resource$Buckets$Patch { + export interface Params$Resource$Buckets$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3134,7 +3176,8 @@ export namespace storage_v1 { */ requestBody?: Schema$Bucket; } - export interface Params$Resource$Buckets$Setiampolicy { + export interface Params$Resource$Buckets$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3155,7 +3198,8 @@ export namespace storage_v1 { */ requestBody?: Schema$Policy; } - export interface Params$Resource$Buckets$Testiampermissions { + export interface Params$Resource$Buckets$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3175,7 +3219,7 @@ export namespace storage_v1 { */ userProject?: string; } - export interface Params$Resource$Buckets$Update { + export interface Params$Resource$Buckets$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3346,7 +3390,7 @@ export namespace storage_v1 { } } - export interface Params$Resource$Channels$Stop { + export interface Params$Resource$Channels$Stop extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4131,7 +4175,8 @@ export namespace storage_v1 { } } - export interface Params$Resource$Defaultobjectaccesscontrols$Delete { + export interface Params$Resource$Defaultobjectaccesscontrols$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4152,7 +4197,8 @@ export namespace storage_v1 { */ userProject?: string; } - export interface Params$Resource$Defaultobjectaccesscontrols$Get { + export interface Params$Resource$Defaultobjectaccesscontrols$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4173,7 +4219,8 @@ export namespace storage_v1 { */ userProject?: string; } - export interface Params$Resource$Defaultobjectaccesscontrols$Insert { + export interface Params$Resource$Defaultobjectaccesscontrols$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4194,7 +4241,8 @@ export namespace storage_v1 { */ requestBody?: Schema$ObjectAccessControl; } - export interface Params$Resource$Defaultobjectaccesscontrols$List { + export interface Params$Resource$Defaultobjectaccesscontrols$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4220,7 +4268,8 @@ export namespace storage_v1 { */ userProject?: string; } - export interface Params$Resource$Defaultobjectaccesscontrols$Patch { + export interface Params$Resource$Defaultobjectaccesscontrols$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4246,7 +4295,8 @@ export namespace storage_v1 { */ requestBody?: Schema$ObjectAccessControl; } - export interface Params$Resource$Defaultobjectaccesscontrols$Update { + export interface Params$Resource$Defaultobjectaccesscontrols$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4775,7 +4825,8 @@ export namespace storage_v1 { } } - export interface Params$Resource$Notifications$Delete { + export interface Params$Resource$Notifications$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4795,7 +4846,8 @@ export namespace storage_v1 { */ userProject?: string; } - export interface Params$Resource$Notifications$Get { + export interface Params$Resource$Notifications$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4815,7 +4867,8 @@ export namespace storage_v1 { */ userProject?: string; } - export interface Params$Resource$Notifications$Insert { + export interface Params$Resource$Notifications$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4836,7 +4889,8 @@ export namespace storage_v1 { */ requestBody?: Schema$Notification; } - export interface Params$Resource$Notifications$List { + export interface Params$Resource$Notifications$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5671,7 +5725,8 @@ export namespace storage_v1 { } } - export interface Params$Resource$Objectaccesscontrols$Delete { + export interface Params$Resource$Objectaccesscontrols$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5702,7 +5757,8 @@ export namespace storage_v1 { */ userProject?: string; } - export interface Params$Resource$Objectaccesscontrols$Get { + export interface Params$Resource$Objectaccesscontrols$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5733,7 +5789,8 @@ export namespace storage_v1 { */ userProject?: string; } - export interface Params$Resource$Objectaccesscontrols$Insert { + export interface Params$Resource$Objectaccesscontrols$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5764,7 +5821,8 @@ export namespace storage_v1 { */ requestBody?: Schema$ObjectAccessControl; } - export interface Params$Resource$Objectaccesscontrols$List { + export interface Params$Resource$Objectaccesscontrols$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5790,7 +5848,8 @@ export namespace storage_v1 { */ userProject?: string; } - export interface Params$Resource$Objectaccesscontrols$Patch { + export interface Params$Resource$Objectaccesscontrols$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5826,7 +5885,8 @@ export namespace storage_v1 { */ requestBody?: Schema$ObjectAccessControl; } - export interface Params$Resource$Objectaccesscontrols$Update { + export interface Params$Resource$Objectaccesscontrols$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7699,7 +7759,7 @@ export namespace storage_v1 { } } - export interface Params$Resource$Objects$Compose { + export interface Params$Resource$Objects$Compose extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7748,7 +7808,7 @@ export namespace storage_v1 { */ requestBody?: Schema$ComposeRequest; } - export interface Params$Resource$Objects$Copy { + export interface Params$Resource$Objects$Copy extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7842,7 +7902,7 @@ export namespace storage_v1 { */ requestBody?: Schema$Object; } - export interface Params$Resource$Objects$Delete { + export interface Params$Resource$Objects$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7891,7 +7951,7 @@ export namespace storage_v1 { */ userProject?: string; } - export interface Params$Resource$Objects$Get { + export interface Params$Resource$Objects$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7944,7 +8004,8 @@ export namespace storage_v1 { */ userProject?: string; } - export interface Params$Resource$Objects$Getiampolicy { + export interface Params$Resource$Objects$Getiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7970,7 +8031,7 @@ export namespace storage_v1 { */ userProject?: string; } - export interface Params$Resource$Objects$Insert { + export interface Params$Resource$Objects$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8061,7 +8122,7 @@ export namespace storage_v1 { body?: any; }; } - export interface Params$Resource$Objects$List { + export interface Params$Resource$Objects$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8115,7 +8176,7 @@ export namespace storage_v1 { */ versions?: boolean; } - export interface Params$Resource$Objects$Patch { + export interface Params$Resource$Objects$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8176,7 +8237,7 @@ export namespace storage_v1 { */ requestBody?: Schema$Object; } - export interface Params$Resource$Objects$Rewrite { + export interface Params$Resource$Objects$Rewrite extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8296,7 +8357,8 @@ export namespace storage_v1 { */ requestBody?: Schema$Object; } - export interface Params$Resource$Objects$Setiampolicy { + export interface Params$Resource$Objects$Setiampolicy extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8327,7 +8389,8 @@ export namespace storage_v1 { */ requestBody?: Schema$Policy; } - export interface Params$Resource$Objects$Testiampermissions { + export interface Params$Resource$Objects$Testiampermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8357,7 +8420,7 @@ export namespace storage_v1 { */ userProject?: string; } - export interface Params$Resource$Objects$Update { + export interface Params$Resource$Objects$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8419,7 +8482,7 @@ export namespace storage_v1 { */ requestBody?: Schema$Object; } - export interface Params$Resource$Objects$Watchall { + export interface Params$Resource$Objects$Watchall extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8625,7 +8688,8 @@ export namespace storage_v1 { } } - export interface Params$Resource$Projects$Serviceaccount$Get { + export interface Params$Resource$Projects$Serviceaccount$Get extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/storage/v1beta1.ts b/src/apis/storage/v1beta1.ts index c11321ad42..479dfa50f9 100644 --- a/src/apis/storage/v1beta1.ts +++ b/src/apis/storage/v1beta1.ts @@ -29,6 +29,40 @@ export namespace storage_v1beta1 { version: 'v1beta1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Cloud Storage JSON API * @@ -767,7 +801,8 @@ export namespace storage_v1beta1 { } } - export interface Params$Resource$Bucketaccesscontrols$Delete { + export interface Params$Resource$Bucketaccesscontrols$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -783,7 +818,8 @@ export namespace storage_v1beta1 { */ entity?: string; } - export interface Params$Resource$Bucketaccesscontrols$Get { + export interface Params$Resource$Bucketaccesscontrols$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -799,7 +835,8 @@ export namespace storage_v1beta1 { */ entity?: string; } - export interface Params$Resource$Bucketaccesscontrols$Insert { + export interface Params$Resource$Bucketaccesscontrols$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -815,7 +852,8 @@ export namespace storage_v1beta1 { */ requestBody?: Schema$BucketAccessControl; } - export interface Params$Resource$Bucketaccesscontrols$List { + export interface Params$Resource$Bucketaccesscontrols$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -826,7 +864,8 @@ export namespace storage_v1beta1 { */ bucket?: string; } - export interface Params$Resource$Bucketaccesscontrols$Patch { + export interface Params$Resource$Bucketaccesscontrols$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -847,7 +886,8 @@ export namespace storage_v1beta1 { */ requestBody?: Schema$BucketAccessControl; } - export interface Params$Resource$Bucketaccesscontrols$Update { + export interface Params$Resource$Bucketaccesscontrols$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1271,7 +1311,7 @@ export namespace storage_v1beta1 { } } - export interface Params$Resource$Buckets$Delete { + export interface Params$Resource$Buckets$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1282,7 +1322,7 @@ export namespace storage_v1beta1 { */ bucket?: string; } - export interface Params$Resource$Buckets$Get { + export interface Params$Resource$Buckets$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1297,7 +1337,7 @@ export namespace storage_v1beta1 { */ projection?: string; } - export interface Params$Resource$Buckets$Insert { + export interface Params$Resource$Buckets$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1315,7 +1355,7 @@ export namespace storage_v1beta1 { */ requestBody?: Schema$Bucket; } - export interface Params$Resource$Buckets$List { + export interface Params$Resource$Buckets$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1339,7 +1379,7 @@ export namespace storage_v1beta1 { */ projection?: string; } - export interface Params$Resource$Buckets$Patch { + export interface Params$Resource$Buckets$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1359,7 +1399,7 @@ export namespace storage_v1beta1 { */ requestBody?: Schema$Bucket; } - export interface Params$Resource$Buckets$Update { + export interface Params$Resource$Buckets$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1810,7 +1850,8 @@ export namespace storage_v1beta1 { } } - export interface Params$Resource$Objectaccesscontrols$Delete { + export interface Params$Resource$Objectaccesscontrols$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1830,7 +1871,8 @@ export namespace storage_v1beta1 { */ object?: string; } - export interface Params$Resource$Objectaccesscontrols$Get { + export interface Params$Resource$Objectaccesscontrols$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1850,7 +1892,8 @@ export namespace storage_v1beta1 { */ object?: string; } - export interface Params$Resource$Objectaccesscontrols$Insert { + export interface Params$Resource$Objectaccesscontrols$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1870,7 +1913,8 @@ export namespace storage_v1beta1 { */ requestBody?: Schema$ObjectAccessControl; } - export interface Params$Resource$Objectaccesscontrols$List { + export interface Params$Resource$Objectaccesscontrols$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1885,7 +1929,8 @@ export namespace storage_v1beta1 { */ object?: string; } - export interface Params$Resource$Objectaccesscontrols$Patch { + export interface Params$Resource$Objectaccesscontrols$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1910,7 +1955,8 @@ export namespace storage_v1beta1 { */ requestBody?: Schema$ObjectAccessControl; } - export interface Params$Resource$Objectaccesscontrols$Update { + export interface Params$Resource$Objectaccesscontrols$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2352,7 +2398,7 @@ export namespace storage_v1beta1 { } } - export interface Params$Resource$Objects$Delete { + export interface Params$Resource$Objects$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2367,7 +2413,7 @@ export namespace storage_v1beta1 { */ object?: string; } - export interface Params$Resource$Objects$Get { + export interface Params$Resource$Objects$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2386,7 +2432,7 @@ export namespace storage_v1beta1 { */ projection?: string; } - export interface Params$Resource$Objects$Insert { + export interface Params$Resource$Objects$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2428,7 +2474,7 @@ export namespace storage_v1beta1 { body?: any; }; } - export interface Params$Resource$Objects$List { + export interface Params$Resource$Objects$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2465,7 +2511,7 @@ export namespace storage_v1beta1 { */ projection?: string; } - export interface Params$Resource$Objects$Patch { + export interface Params$Resource$Objects$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2489,7 +2535,7 @@ export namespace storage_v1beta1 { */ requestBody?: Schema$Object; } - export interface Params$Resource$Objects$Update { + export interface Params$Resource$Objects$Update extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/storage/v1beta2.ts b/src/apis/storage/v1beta2.ts index 0fa4fb0b1e..03a7690302 100644 --- a/src/apis/storage/v1beta2.ts +++ b/src/apis/storage/v1beta2.ts @@ -29,6 +29,40 @@ export namespace storage_v1beta2 { version: 'v1beta2'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Cloud Storage JSON API * @@ -933,7 +967,8 @@ export namespace storage_v1beta2 { } } - export interface Params$Resource$Bucketaccesscontrols$Delete { + export interface Params$Resource$Bucketaccesscontrols$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -949,7 +984,8 @@ export namespace storage_v1beta2 { */ entity?: string; } - export interface Params$Resource$Bucketaccesscontrols$Get { + export interface Params$Resource$Bucketaccesscontrols$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -965,7 +1001,8 @@ export namespace storage_v1beta2 { */ entity?: string; } - export interface Params$Resource$Bucketaccesscontrols$Insert { + export interface Params$Resource$Bucketaccesscontrols$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -981,7 +1018,8 @@ export namespace storage_v1beta2 { */ requestBody?: Schema$BucketAccessControl; } - export interface Params$Resource$Bucketaccesscontrols$List { + export interface Params$Resource$Bucketaccesscontrols$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -992,7 +1030,8 @@ export namespace storage_v1beta2 { */ bucket?: string; } - export interface Params$Resource$Bucketaccesscontrols$Patch { + export interface Params$Resource$Bucketaccesscontrols$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1013,7 +1052,8 @@ export namespace storage_v1beta2 { */ requestBody?: Schema$BucketAccessControl; } - export interface Params$Resource$Bucketaccesscontrols$Update { + export interface Params$Resource$Bucketaccesscontrols$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1446,7 +1486,7 @@ export namespace storage_v1beta2 { } } - export interface Params$Resource$Buckets$Delete { + export interface Params$Resource$Buckets$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1467,7 +1507,7 @@ export namespace storage_v1beta2 { */ ifMetagenerationNotMatch?: string; } - export interface Params$Resource$Buckets$Get { + export interface Params$Resource$Buckets$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1492,7 +1532,7 @@ export namespace storage_v1beta2 { */ projection?: string; } - export interface Params$Resource$Buckets$Insert { + export interface Params$Resource$Buckets$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1514,7 +1554,7 @@ export namespace storage_v1beta2 { */ requestBody?: Schema$Bucket; } - export interface Params$Resource$Buckets$List { + export interface Params$Resource$Buckets$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1538,7 +1578,7 @@ export namespace storage_v1beta2 { */ projection?: string; } - export interface Params$Resource$Buckets$Patch { + export interface Params$Resource$Buckets$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1568,7 +1608,7 @@ export namespace storage_v1beta2 { */ requestBody?: Schema$Bucket; } - export interface Params$Resource$Buckets$Update { + export interface Params$Resource$Buckets$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1675,7 +1715,7 @@ export namespace storage_v1beta2 { } } - export interface Params$Resource$Channels$Stop { + export interface Params$Resource$Channels$Stop extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2114,7 +2154,8 @@ export namespace storage_v1beta2 { } } - export interface Params$Resource$Defaultobjectaccesscontrols$Delete { + export interface Params$Resource$Defaultobjectaccesscontrols$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2130,7 +2171,8 @@ export namespace storage_v1beta2 { */ entity?: string; } - export interface Params$Resource$Defaultobjectaccesscontrols$Get { + export interface Params$Resource$Defaultobjectaccesscontrols$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2146,7 +2188,8 @@ export namespace storage_v1beta2 { */ entity?: string; } - export interface Params$Resource$Defaultobjectaccesscontrols$Insert { + export interface Params$Resource$Defaultobjectaccesscontrols$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2162,7 +2205,8 @@ export namespace storage_v1beta2 { */ requestBody?: Schema$ObjectAccessControl; } - export interface Params$Resource$Defaultobjectaccesscontrols$List { + export interface Params$Resource$Defaultobjectaccesscontrols$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2183,7 +2227,8 @@ export namespace storage_v1beta2 { */ ifMetagenerationNotMatch?: string; } - export interface Params$Resource$Defaultobjectaccesscontrols$Patch { + export interface Params$Resource$Defaultobjectaccesscontrols$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2204,7 +2249,8 @@ export namespace storage_v1beta2 { */ requestBody?: Schema$ObjectAccessControl; } - export interface Params$Resource$Defaultobjectaccesscontrols$Update { + export interface Params$Resource$Defaultobjectaccesscontrols$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2662,7 +2708,8 @@ export namespace storage_v1beta2 { } } - export interface Params$Resource$Objectaccesscontrols$Delete { + export interface Params$Resource$Objectaccesscontrols$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2687,7 +2734,8 @@ export namespace storage_v1beta2 { */ object?: string; } - export interface Params$Resource$Objectaccesscontrols$Get { + export interface Params$Resource$Objectaccesscontrols$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2712,7 +2760,8 @@ export namespace storage_v1beta2 { */ object?: string; } - export interface Params$Resource$Objectaccesscontrols$Insert { + export interface Params$Resource$Objectaccesscontrols$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2737,7 +2786,8 @@ export namespace storage_v1beta2 { */ requestBody?: Schema$ObjectAccessControl; } - export interface Params$Resource$Objectaccesscontrols$List { + export interface Params$Resource$Objectaccesscontrols$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2757,7 +2807,8 @@ export namespace storage_v1beta2 { */ object?: string; } - export interface Params$Resource$Objectaccesscontrols$Patch { + export interface Params$Resource$Objectaccesscontrols$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2787,7 +2838,8 @@ export namespace storage_v1beta2 { */ requestBody?: Schema$ObjectAccessControl; } - export interface Params$Resource$Objectaccesscontrols$Update { + export interface Params$Resource$Objectaccesscontrols$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3491,7 +3543,7 @@ export namespace storage_v1beta2 { } } - export interface Params$Resource$Objects$Compose { + export interface Params$Resource$Objects$Compose extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3522,7 +3574,7 @@ export namespace storage_v1beta2 { */ requestBody?: Schema$ComposeRequest; } - export interface Params$Resource$Objects$Copy { + export interface Params$Resource$Objects$Copy extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3602,7 +3654,7 @@ export namespace storage_v1beta2 { */ requestBody?: Schema$Object; } - export interface Params$Resource$Objects$Delete { + export interface Params$Resource$Objects$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3642,7 +3694,7 @@ export namespace storage_v1beta2 { */ object?: string; } - export interface Params$Resource$Objects$Get { + export interface Params$Resource$Objects$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3686,7 +3738,7 @@ export namespace storage_v1beta2 { */ projection?: string; } - export interface Params$Resource$Objects$Insert { + export interface Params$Resource$Objects$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3748,7 +3800,7 @@ export namespace storage_v1beta2 { body?: any; }; } - export interface Params$Resource$Objects$List { + export interface Params$Resource$Objects$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3789,7 +3841,7 @@ export namespace storage_v1beta2 { */ versions?: boolean; } - export interface Params$Resource$Objects$Patch { + export interface Params$Resource$Objects$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3838,7 +3890,7 @@ export namespace storage_v1beta2 { */ requestBody?: Schema$Object; } - export interface Params$Resource$Objects$Update { + export interface Params$Resource$Objects$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3887,7 +3939,7 @@ export namespace storage_v1beta2 { */ requestBody?: Schema$Object; } - export interface Params$Resource$Objects$Watchall { + export interface Params$Resource$Objects$Watchall extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/storagetransfer/v1.ts b/src/apis/storagetransfer/v1.ts index 844654ffc5..189228b29e 100644 --- a/src/apis/storagetransfer/v1.ts +++ b/src/apis/storagetransfer/v1.ts @@ -29,6 +29,57 @@ export namespace storagetransfer_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Storage Transfer API * @@ -846,7 +897,8 @@ export namespace storagetransfer_v1 { } } - export interface Params$Resource$Googleserviceaccounts$Get { + export interface Params$Resource$Googleserviceaccounts$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1374,7 +1426,8 @@ export namespace storagetransfer_v1 { } } - export interface Params$Resource$Transferjobs$Create { + export interface Params$Resource$Transferjobs$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1386,7 +1439,7 @@ export namespace storagetransfer_v1 { */ requestBody?: Schema$TransferJob; } - export interface Params$Resource$Transferjobs$Get { + export interface Params$Resource$Transferjobs$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1402,7 +1455,8 @@ export namespace storagetransfer_v1 { */ projectId?: string; } - export interface Params$Resource$Transferjobs$List { + export interface Params$Resource$Transferjobs$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1427,7 +1481,8 @@ export namespace storagetransfer_v1 { */ pageToken?: string; } - export interface Params$Resource$Transferjobs$Patch { + export interface Params$Resource$Transferjobs$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2206,7 +2261,8 @@ export namespace storagetransfer_v1 { } } - export interface Params$Resource$Transferoperations$Cancel { + export interface Params$Resource$Transferoperations$Cancel extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2217,7 +2273,8 @@ export namespace storagetransfer_v1 { */ name?: string; } - export interface Params$Resource$Transferoperations$Delete { + export interface Params$Resource$Transferoperations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2228,7 +2285,8 @@ export namespace storagetransfer_v1 { */ name?: string; } - export interface Params$Resource$Transferoperations$Get { + export interface Params$Resource$Transferoperations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2239,7 +2297,8 @@ export namespace storagetransfer_v1 { */ name?: string; } - export interface Params$Resource$Transferoperations$List { + export interface Params$Resource$Transferoperations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2268,7 +2327,8 @@ export namespace storagetransfer_v1 { */ pageToken?: string; } - export interface Params$Resource$Transferoperations$Pause { + export interface Params$Resource$Transferoperations$Pause extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2284,7 +2344,8 @@ export namespace storagetransfer_v1 { */ requestBody?: Schema$PauseTransferOperationRequest; } - export interface Params$Resource$Transferoperations$Resume { + export interface Params$Resource$Transferoperations$Resume extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/streetviewpublish/v1.ts b/src/apis/streetviewpublish/v1.ts index 7e6d0aae99..df440b402d 100644 --- a/src/apis/streetviewpublish/v1.ts +++ b/src/apis/streetviewpublish/v1.ts @@ -29,6 +29,57 @@ export namespace streetviewpublish_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Street View Publish API * @@ -303,6 +354,16 @@ export namespace streetviewpublish_v1 { * Place metadata for an entity. */ export interface Schema$Place { + /** + * Output-only. The language_code that the name is localized with. This + * should be the language_code specified in the request, but may be a + * fallback. + */ + languageCode?: string; + /** + * Output-only. The name of the place, localized to the language_code. + */ + name?: string; /** * Place identifier, as described in * https://developers.google.com/places/place-id. @@ -617,6 +678,7 @@ export namespace streetviewpublish_v1 { * @memberOf! () * * @param {object} params Parameters for request + * @param {string=} params.languageCode The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If language_code is unspecified, the user's language preference for Google services will be used. * @param {string} params.photoId Required. ID of the Photo. * @param {string=} params.view Specifies if a download URL for the photo bytes should be returned in the Photo response. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -830,7 +892,7 @@ export namespace streetviewpublish_v1 { } } - export interface Params$Resource$Photo$Create { + export interface Params$Resource$Photo$Create extends StandardParameters { /** * Auth client or API Key for the request */ @@ -842,7 +904,7 @@ export namespace streetviewpublish_v1 { */ requestBody?: Schema$Photo; } - export interface Params$Resource$Photo$Delete { + export interface Params$Resource$Photo$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -853,12 +915,20 @@ export namespace streetviewpublish_v1 { */ photoId?: string; } - export interface Params$Resource$Photo$Get { + export interface Params$Resource$Photo$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + /** + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more + * information, see + * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If + * language_code is unspecified, the user's language preference for Google + * services will be used. + */ + languageCode?: string; /** * Required. ID of the Photo. */ @@ -869,7 +939,8 @@ export namespace streetviewpublish_v1 { */ view?: string; } - export interface Params$Resource$Photo$Startupload { + export interface Params$Resource$Photo$Startupload extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -881,7 +952,7 @@ export namespace streetviewpublish_v1 { */ requestBody?: Schema$Empty; } - export interface Params$Resource$Photo$Update { + export interface Params$Resource$Photo$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1014,6 +1085,7 @@ export namespace streetviewpublish_v1 { * @memberOf! () * * @param {object} params Parameters for request + * @param {string=} params.languageCode The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If language_code is unspecified, the user's language preference for Google services will be used. * @param {string=} params.photoIds Required. IDs of the Photos. For HTTP GET requests, the URL query parameter should be `photoIds=&photoIds=&...`. * @param {string=} params.view Specifies if a download URL for the photo bytes should be returned in the Photo response. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1168,6 +1240,7 @@ export namespace streetviewpublish_v1 { * * @param {object} params Parameters for request * @param {string=} params.filter The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`. The only filter supported at the moment is `placeId`. + * @param {string=} params.languageCode The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If language_code is unspecified, the user's language preference for Google services will be used. * @param {integer=} params.pageSize The maximum number of photos to return. `pageSize` must be non-negative. If `pageSize` is zero or is not provided, the default page size of 100 will be used. The number of photos returned in the response may be less than `pageSize` if the number of photos that belong to the user is less than `pageSize`. * @param {string=} params.pageToken The nextPageToken value returned from a previous ListPhotos request, if any. * @param {string=} params.view Specifies if a download URL for the photos bytes should be returned in the Photos response. @@ -1228,7 +1301,8 @@ export namespace streetviewpublish_v1 { } } - export interface Params$Resource$Photos$Batchdelete { + export interface Params$Resource$Photos$Batchdelete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1240,12 +1314,20 @@ export namespace streetviewpublish_v1 { */ requestBody?: Schema$BatchDeletePhotosRequest; } - export interface Params$Resource$Photos$Batchget { + export interface Params$Resource$Photos$Batchget extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + /** + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more + * information, see + * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If + * language_code is unspecified, the user's language preference for Google + * services will be used. + */ + languageCode?: string; /** * Required. IDs of the Photos. For HTTP GET requests, the URL query * parameter should be `photoIds=&photoIds=&...`. @@ -1257,7 +1339,8 @@ export namespace streetviewpublish_v1 { */ view?: string; } - export interface Params$Resource$Photos$Batchupdate { + export interface Params$Resource$Photos$Batchupdate extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1269,7 +1352,7 @@ export namespace streetviewpublish_v1 { */ requestBody?: Schema$BatchUpdatePhotosRequest; } - export interface Params$Resource$Photos$List { + export interface Params$Resource$Photos$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1281,6 +1364,14 @@ export namespace streetviewpublish_v1 { * moment is `placeId`. */ filter?: string; + /** + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more + * information, see + * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If + * language_code is unspecified, the user's language preference for Google + * services will be used. + */ + languageCode?: string; /** * The maximum number of photos to return. `pageSize` must be non-negative. * If `pageSize` is zero or is not provided, the default page size of 100 diff --git a/src/apis/surveys/v2.ts b/src/apis/surveys/v2.ts index b972dbe5e5..3c87fa59f9 100644 --- a/src/apis/surveys/v2.ts +++ b/src/apis/surveys/v2.ts @@ -29,6 +29,40 @@ export namespace surveys_v2 { version: 'v2'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Surveys API * @@ -479,7 +513,7 @@ export namespace surveys_v2 { } } - export interface Params$Resource$Results$Get { + export interface Params$Resource$Results$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -965,7 +999,7 @@ export namespace surveys_v2 { } } - export interface Params$Resource$Surveys$Delete { + export interface Params$Resource$Surveys$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -976,7 +1010,7 @@ export namespace surveys_v2 { */ surveyUrlId?: string; } - export interface Params$Resource$Surveys$Get { + export interface Params$Resource$Surveys$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -987,7 +1021,7 @@ export namespace surveys_v2 { */ surveyUrlId?: string; } - export interface Params$Resource$Surveys$Insert { + export interface Params$Resource$Surveys$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -999,7 +1033,7 @@ export namespace surveys_v2 { */ requestBody?: Schema$Survey; } - export interface Params$Resource$Surveys$List { + export interface Params$Resource$Surveys$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1018,7 +1052,7 @@ export namespace surveys_v2 { */ token?: string; } - export interface Params$Resource$Surveys$Start { + export interface Params$Resource$Surveys$Start extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1034,7 +1068,7 @@ export namespace surveys_v2 { */ requestBody?: Schema$SurveysStartRequest; } - export interface Params$Resource$Surveys$Stop { + export interface Params$Resource$Surveys$Stop extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1045,7 +1079,7 @@ export namespace surveys_v2 { */ resourceId?: string; } - export interface Params$Resource$Surveys$Update { + export interface Params$Resource$Surveys$Update extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/tagmanager/v1.ts b/src/apis/tagmanager/v1.ts index 4f46a81ab7..b98fccc786 100644 --- a/src/apis/tagmanager/v1.ts +++ b/src/apis/tagmanager/v1.ts @@ -29,6 +29,40 @@ export namespace tagmanager_v1 { version: 'v1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Tag Manager API * @@ -1219,7 +1253,7 @@ export namespace tagmanager_v1 { } } - export interface Params$Resource$Accounts$Get { + export interface Params$Resource$Accounts$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1230,13 +1264,13 @@ export namespace tagmanager_v1 { */ accountId?: string; } - export interface Params$Resource$Accounts$List { + export interface Params$Resource$Accounts$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; } - export interface Params$Resource$Accounts$Update { + export interface Params$Resource$Accounts$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1630,7 +1664,8 @@ export namespace tagmanager_v1 { } } - export interface Params$Resource$Accounts$Containers$Create { + export interface Params$Resource$Accounts$Containers$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1646,7 +1681,8 @@ export namespace tagmanager_v1 { */ requestBody?: Schema$Container; } - export interface Params$Resource$Accounts$Containers$Delete { + export interface Params$Resource$Accounts$Containers$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1661,7 +1697,8 @@ export namespace tagmanager_v1 { */ containerId?: string; } - export interface Params$Resource$Accounts$Containers$Get { + export interface Params$Resource$Accounts$Containers$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1676,7 +1713,8 @@ export namespace tagmanager_v1 { */ containerId?: string; } - export interface Params$Resource$Accounts$Containers$List { + export interface Params$Resource$Accounts$Containers$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1687,7 +1725,8 @@ export namespace tagmanager_v1 { */ accountId?: string; } - export interface Params$Resource$Accounts$Containers$Update { + export interface Params$Resource$Accounts$Containers$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2154,7 +2193,8 @@ export namespace tagmanager_v1 { } } - export interface Params$Resource$Accounts$Containers$Environments$Create { + export interface Params$Resource$Accounts$Containers$Environments$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2174,7 +2214,8 @@ export namespace tagmanager_v1 { */ requestBody?: Schema$Environment; } - export interface Params$Resource$Accounts$Containers$Environments$Delete { + export interface Params$Resource$Accounts$Containers$Environments$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2193,7 +2234,8 @@ export namespace tagmanager_v1 { */ environmentId?: string; } - export interface Params$Resource$Accounts$Containers$Environments$Get { + export interface Params$Resource$Accounts$Containers$Environments$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2212,7 +2254,8 @@ export namespace tagmanager_v1 { */ environmentId?: string; } - export interface Params$Resource$Accounts$Containers$Environments$List { + export interface Params$Resource$Accounts$Containers$Environments$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2227,7 +2270,8 @@ export namespace tagmanager_v1 { */ containerId?: string; } - export interface Params$Resource$Accounts$Containers$Environments$Patch { + export interface Params$Resource$Accounts$Containers$Environments$Patch + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2256,7 +2300,8 @@ export namespace tagmanager_v1 { */ requestBody?: Schema$Environment; } - export interface Params$Resource$Accounts$Containers$Environments$Update { + export interface Params$Resource$Accounts$Containers$Environments$Update + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2648,7 +2693,8 @@ export namespace tagmanager_v1 { } } - export interface Params$Resource$Accounts$Containers$Folders$Create { + export interface Params$Resource$Accounts$Containers$Folders$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2668,7 +2714,8 @@ export namespace tagmanager_v1 { */ requestBody?: Schema$Folder; } - export interface Params$Resource$Accounts$Containers$Folders$Delete { + export interface Params$Resource$Accounts$Containers$Folders$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2687,7 +2734,8 @@ export namespace tagmanager_v1 { */ folderId?: string; } - export interface Params$Resource$Accounts$Containers$Folders$Get { + export interface Params$Resource$Accounts$Containers$Folders$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2706,7 +2754,8 @@ export namespace tagmanager_v1 { */ folderId?: string; } - export interface Params$Resource$Accounts$Containers$Folders$List { + export interface Params$Resource$Accounts$Containers$Folders$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2721,7 +2770,8 @@ export namespace tagmanager_v1 { */ containerId?: string; } - export interface Params$Resource$Accounts$Containers$Folders$Update { + export interface Params$Resource$Accounts$Containers$Folders$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2836,7 +2886,8 @@ export namespace tagmanager_v1 { } } - export interface Params$Resource$Accounts$Containers$Folders$Entities$List { + export interface Params$Resource$Accounts$Containers$Folders$Entities$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2944,7 +2995,8 @@ export namespace tagmanager_v1 { } } - export interface Params$Resource$Accounts$Containers$Move_folders$Update { + export interface Params$Resource$Accounts$Containers$Move_folders$Update + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3071,7 +3123,8 @@ export namespace tagmanager_v1 { } } - export interface Params$Resource$Accounts$Containers$Reauthorize_environments$Update { + export interface Params$Resource$Accounts$Containers$Reauthorize_environments$Update + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3456,7 +3509,8 @@ export namespace tagmanager_v1 { } } - export interface Params$Resource$Accounts$Containers$Tags$Create { + export interface Params$Resource$Accounts$Containers$Tags$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3476,7 +3530,8 @@ export namespace tagmanager_v1 { */ requestBody?: Schema$Tag; } - export interface Params$Resource$Accounts$Containers$Tags$Delete { + export interface Params$Resource$Accounts$Containers$Tags$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3495,7 +3550,8 @@ export namespace tagmanager_v1 { */ tagId?: string; } - export interface Params$Resource$Accounts$Containers$Tags$Get { + export interface Params$Resource$Accounts$Containers$Tags$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3514,7 +3570,8 @@ export namespace tagmanager_v1 { */ tagId?: string; } - export interface Params$Resource$Accounts$Containers$Tags$List { + export interface Params$Resource$Accounts$Containers$Tags$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3529,7 +3586,8 @@ export namespace tagmanager_v1 { */ containerId?: string; } - export interface Params$Resource$Accounts$Containers$Tags$Update { + export interface Params$Resource$Accounts$Containers$Tags$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3920,7 +3978,8 @@ export namespace tagmanager_v1 { } } - export interface Params$Resource$Accounts$Containers$Triggers$Create { + export interface Params$Resource$Accounts$Containers$Triggers$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3940,7 +3999,8 @@ export namespace tagmanager_v1 { */ requestBody?: Schema$Trigger; } - export interface Params$Resource$Accounts$Containers$Triggers$Delete { + export interface Params$Resource$Accounts$Containers$Triggers$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3959,7 +4019,8 @@ export namespace tagmanager_v1 { */ triggerId?: string; } - export interface Params$Resource$Accounts$Containers$Triggers$Get { + export interface Params$Resource$Accounts$Containers$Triggers$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3978,7 +4039,8 @@ export namespace tagmanager_v1 { */ triggerId?: string; } - export interface Params$Resource$Accounts$Containers$Triggers$List { + export interface Params$Resource$Accounts$Containers$Triggers$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3993,7 +4055,8 @@ export namespace tagmanager_v1 { */ containerId?: string; } - export interface Params$Resource$Accounts$Containers$Triggers$Update { + export interface Params$Resource$Accounts$Containers$Triggers$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4384,7 +4447,8 @@ export namespace tagmanager_v1 { } } - export interface Params$Resource$Accounts$Containers$Variables$Create { + export interface Params$Resource$Accounts$Containers$Variables$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4404,7 +4468,8 @@ export namespace tagmanager_v1 { */ requestBody?: Schema$Variable; } - export interface Params$Resource$Accounts$Containers$Variables$Delete { + export interface Params$Resource$Accounts$Containers$Variables$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4423,7 +4488,8 @@ export namespace tagmanager_v1 { */ variableId?: string; } - export interface Params$Resource$Accounts$Containers$Variables$Get { + export interface Params$Resource$Accounts$Containers$Variables$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4442,7 +4508,8 @@ export namespace tagmanager_v1 { */ variableId?: string; } - export interface Params$Resource$Accounts$Containers$Variables$List { + export interface Params$Resource$Accounts$Containers$Variables$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4457,7 +4524,8 @@ export namespace tagmanager_v1 { */ containerId?: string; } - export interface Params$Resource$Accounts$Containers$Variables$Update { + export interface Params$Resource$Accounts$Containers$Variables$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5094,7 +5162,8 @@ export namespace tagmanager_v1 { } } - export interface Params$Resource$Accounts$Containers$Versions$Create { + export interface Params$Resource$Accounts$Containers$Versions$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5114,7 +5183,8 @@ export namespace tagmanager_v1 { */ requestBody?: Schema$CreateContainerVersionRequestVersionOptions; } - export interface Params$Resource$Accounts$Containers$Versions$Delete { + export interface Params$Resource$Accounts$Containers$Versions$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5133,7 +5203,8 @@ export namespace tagmanager_v1 { */ containerVersionId?: string; } - export interface Params$Resource$Accounts$Containers$Versions$Get { + export interface Params$Resource$Accounts$Containers$Versions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5153,7 +5224,8 @@ export namespace tagmanager_v1 { */ containerVersionId?: string; } - export interface Params$Resource$Accounts$Containers$Versions$List { + export interface Params$Resource$Accounts$Containers$Versions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5176,7 +5248,8 @@ export namespace tagmanager_v1 { */ includeDeleted?: boolean; } - export interface Params$Resource$Accounts$Containers$Versions$Publish { + export interface Params$Resource$Accounts$Containers$Versions$Publish extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5200,7 +5273,8 @@ export namespace tagmanager_v1 { */ fingerprint?: string; } - export interface Params$Resource$Accounts$Containers$Versions$Restore { + export interface Params$Resource$Accounts$Containers$Versions$Restore extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5219,7 +5293,8 @@ export namespace tagmanager_v1 { */ containerVersionId?: string; } - export interface Params$Resource$Accounts$Containers$Versions$Undelete { + export interface Params$Resource$Accounts$Containers$Versions$Undelete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5238,7 +5313,8 @@ export namespace tagmanager_v1 { */ containerVersionId?: string; } - export interface Params$Resource$Accounts$Containers$Versions$Update { + export interface Params$Resource$Accounts$Containers$Versions$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5625,7 +5701,8 @@ export namespace tagmanager_v1 { } } - export interface Params$Resource$Accounts$Permissions$Create { + export interface Params$Resource$Accounts$Permissions$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5641,7 +5718,8 @@ export namespace tagmanager_v1 { */ requestBody?: Schema$UserAccess; } - export interface Params$Resource$Accounts$Permissions$Delete { + export interface Params$Resource$Accounts$Permissions$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5656,7 +5734,8 @@ export namespace tagmanager_v1 { */ permissionId?: string; } - export interface Params$Resource$Accounts$Permissions$Get { + export interface Params$Resource$Accounts$Permissions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5671,7 +5750,8 @@ export namespace tagmanager_v1 { */ permissionId?: string; } - export interface Params$Resource$Accounts$Permissions$List { + export interface Params$Resource$Accounts$Permissions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5682,7 +5762,8 @@ export namespace tagmanager_v1 { */ accountId?: string; } - export interface Params$Resource$Accounts$Permissions$Update { + export interface Params$Resource$Accounts$Permissions$Update extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/tagmanager/v2.ts b/src/apis/tagmanager/v2.ts index b37d09554f..5c2a09930d 100644 --- a/src/apis/tagmanager/v2.ts +++ b/src/apis/tagmanager/v2.ts @@ -29,6 +29,40 @@ export namespace tagmanager_v2 { version: 'v2'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Tag Manager API * @@ -1805,7 +1839,7 @@ export namespace tagmanager_v2 { } } - export interface Params$Resource$Accounts$Get { + export interface Params$Resource$Accounts$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1816,7 +1850,7 @@ export namespace tagmanager_v2 { */ path?: string; } - export interface Params$Resource$Accounts$List { + export interface Params$Resource$Accounts$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1827,7 +1861,7 @@ export namespace tagmanager_v2 { */ pageToken?: string; } - export interface Params$Resource$Accounts$Update { + export interface Params$Resource$Accounts$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2204,7 +2238,8 @@ export namespace tagmanager_v2 { } } - export interface Params$Resource$Accounts$Containers$Create { + export interface Params$Resource$Accounts$Containers$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2220,7 +2255,8 @@ export namespace tagmanager_v2 { */ requestBody?: Schema$Container; } - export interface Params$Resource$Accounts$Containers$Delete { + export interface Params$Resource$Accounts$Containers$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2232,7 +2268,8 @@ export namespace tagmanager_v2 { */ path?: string; } - export interface Params$Resource$Accounts$Containers$Get { + export interface Params$Resource$Accounts$Containers$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2244,7 +2281,8 @@ export namespace tagmanager_v2 { */ path?: string; } - export interface Params$Resource$Accounts$Containers$List { + export interface Params$Resource$Accounts$Containers$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2259,7 +2297,8 @@ export namespace tagmanager_v2 { */ parent?: string; } - export interface Params$Resource$Accounts$Containers$Update { + export interface Params$Resource$Accounts$Containers$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2772,7 +2811,8 @@ export namespace tagmanager_v2 { } } - export interface Params$Resource$Accounts$Containers$Environments$Create { + export interface Params$Resource$Accounts$Containers$Environments$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2789,7 +2829,8 @@ export namespace tagmanager_v2 { */ requestBody?: Schema$Environment; } - export interface Params$Resource$Accounts$Containers$Environments$Delete { + export interface Params$Resource$Accounts$Containers$Environments$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2801,7 +2842,8 @@ export namespace tagmanager_v2 { */ path?: string; } - export interface Params$Resource$Accounts$Containers$Environments$Get { + export interface Params$Resource$Accounts$Containers$Environments$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2813,7 +2855,8 @@ export namespace tagmanager_v2 { */ path?: string; } - export interface Params$Resource$Accounts$Containers$Environments$List { + export interface Params$Resource$Accounts$Containers$Environments$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2829,7 +2872,8 @@ export namespace tagmanager_v2 { */ parent?: string; } - export interface Params$Resource$Accounts$Containers$Environments$Patch { + export interface Params$Resource$Accounts$Containers$Environments$Patch + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2851,7 +2895,8 @@ export namespace tagmanager_v2 { */ requestBody?: Schema$Environment; } - export interface Params$Resource$Accounts$Containers$Environments$Reauthorize { + export interface Params$Resource$Accounts$Containers$Environments$Reauthorize + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2868,7 +2913,8 @@ export namespace tagmanager_v2 { */ requestBody?: Schema$Environment; } - export interface Params$Resource$Accounts$Containers$Environments$Update { + export interface Params$Resource$Accounts$Containers$Environments$Update + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3383,7 +3429,8 @@ export namespace tagmanager_v2 { } } - export interface Params$Resource$Accounts$Containers$Versions$Delete { + export interface Params$Resource$Accounts$Containers$Versions$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3395,7 +3442,8 @@ export namespace tagmanager_v2 { */ path?: string; } - export interface Params$Resource$Accounts$Containers$Versions$Get { + export interface Params$Resource$Accounts$Containers$Versions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3412,7 +3460,8 @@ export namespace tagmanager_v2 { */ path?: string; } - export interface Params$Resource$Accounts$Containers$Versions$Live { + export interface Params$Resource$Accounts$Containers$Versions$Live extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3424,7 +3473,8 @@ export namespace tagmanager_v2 { */ parent?: string; } - export interface Params$Resource$Accounts$Containers$Versions$Publish { + export interface Params$Resource$Accounts$Containers$Versions$Publish extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3441,7 +3491,8 @@ export namespace tagmanager_v2 { */ path?: string; } - export interface Params$Resource$Accounts$Containers$Versions$Set_latest { + export interface Params$Resource$Accounts$Containers$Versions$Set_latest + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3453,7 +3504,8 @@ export namespace tagmanager_v2 { */ path?: string; } - export interface Params$Resource$Accounts$Containers$Versions$Undelete { + export interface Params$Resource$Accounts$Containers$Versions$Undelete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3465,7 +3517,8 @@ export namespace tagmanager_v2 { */ path?: string; } - export interface Params$Resource$Accounts$Containers$Versions$Update { + export interface Params$Resource$Accounts$Containers$Versions$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -3648,7 +3701,8 @@ export namespace tagmanager_v2 { } } - export interface Params$Resource$Accounts$Containers$Version_headers$Latest { + export interface Params$Resource$Accounts$Containers$Version_headers$Latest + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3660,7 +3714,8 @@ export namespace tagmanager_v2 { */ parent?: string; } - export interface Params$Resource$Accounts$Containers$Version_headers$List { + export interface Params$Resource$Accounts$Containers$Version_headers$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4556,7 +4611,8 @@ export namespace tagmanager_v2 { } } - export interface Params$Resource$Accounts$Containers$Workspaces$Create { + export interface Params$Resource$Accounts$Containers$Workspaces$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4573,7 +4629,8 @@ export namespace tagmanager_v2 { */ requestBody?: Schema$Workspace; } - export interface Params$Resource$Accounts$Containers$Workspaces$Create_version { + export interface Params$Resource$Accounts$Containers$Workspaces$Create_version + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4590,7 +4647,8 @@ export namespace tagmanager_v2 { */ requestBody?: Schema$CreateContainerVersionRequestVersionOptions; } - export interface Params$Resource$Accounts$Containers$Workspaces$Delete { + export interface Params$Resource$Accounts$Containers$Workspaces$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4602,7 +4660,8 @@ export namespace tagmanager_v2 { */ path?: string; } - export interface Params$Resource$Accounts$Containers$Workspaces$Get { + export interface Params$Resource$Accounts$Containers$Workspaces$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4614,7 +4673,8 @@ export namespace tagmanager_v2 { */ path?: string; } - export interface Params$Resource$Accounts$Containers$Workspaces$Getproposal { + export interface Params$Resource$Accounts$Containers$Workspaces$Getproposal + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4626,7 +4686,8 @@ export namespace tagmanager_v2 { */ path?: string; } - export interface Params$Resource$Accounts$Containers$Workspaces$Getstatus { + export interface Params$Resource$Accounts$Containers$Workspaces$Getstatus + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4638,7 +4699,8 @@ export namespace tagmanager_v2 { */ path?: string; } - export interface Params$Resource$Accounts$Containers$Workspaces$List { + export interface Params$Resource$Accounts$Containers$Workspaces$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4654,7 +4716,8 @@ export namespace tagmanager_v2 { */ parent?: string; } - export interface Params$Resource$Accounts$Containers$Workspaces$Quick_preview { + export interface Params$Resource$Accounts$Containers$Workspaces$Quick_preview + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4666,7 +4729,8 @@ export namespace tagmanager_v2 { */ path?: string; } - export interface Params$Resource$Accounts$Containers$Workspaces$Resolve_conflict { + export interface Params$Resource$Accounts$Containers$Workspaces$Resolve_conflict + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4688,7 +4752,8 @@ export namespace tagmanager_v2 { */ requestBody?: Schema$Entity; } - export interface Params$Resource$Accounts$Containers$Workspaces$Sync { + export interface Params$Resource$Accounts$Containers$Workspaces$Sync extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4700,7 +4765,8 @@ export namespace tagmanager_v2 { */ path?: string; } - export interface Params$Resource$Accounts$Containers$Workspaces$Update { + export interface Params$Resource$Accounts$Containers$Workspaces$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4722,7 +4788,8 @@ export namespace tagmanager_v2 { */ requestBody?: Schema$Workspace; } - export interface Params$Resource$Accounts$Containers$Workspaces$Updateproposal { + export interface Params$Resource$Accounts$Containers$Workspaces$Updateproposal + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5073,7 +5140,8 @@ export namespace tagmanager_v2 { } } - export interface Params$Resource$Accounts$Containers$Workspaces$Built_in_variables$Create { + export interface Params$Resource$Accounts$Containers$Workspaces$Built_in_variables$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5089,7 +5157,8 @@ export namespace tagmanager_v2 { */ type?: string; } - export interface Params$Resource$Accounts$Containers$Workspaces$Built_in_variables$Delete { + export interface Params$Resource$Accounts$Containers$Workspaces$Built_in_variables$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5105,7 +5174,8 @@ export namespace tagmanager_v2 { */ type?: string; } - export interface Params$Resource$Accounts$Containers$Workspaces$Built_in_variables$List { + export interface Params$Resource$Accounts$Containers$Workspaces$Built_in_variables$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5121,7 +5191,8 @@ export namespace tagmanager_v2 { */ parent?: string; } - export interface Params$Resource$Accounts$Containers$Workspaces$Built_in_variables$Revert { + export interface Params$Resource$Accounts$Containers$Workspaces$Built_in_variables$Revert + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5708,7 +5779,8 @@ export namespace tagmanager_v2 { } } - export interface Params$Resource$Accounts$Containers$Workspaces$Folders$Create { + export interface Params$Resource$Accounts$Containers$Workspaces$Folders$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5725,7 +5797,8 @@ export namespace tagmanager_v2 { */ requestBody?: Schema$Folder; } - export interface Params$Resource$Accounts$Containers$Workspaces$Folders$Delete { + export interface Params$Resource$Accounts$Containers$Workspaces$Folders$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5737,7 +5810,8 @@ export namespace tagmanager_v2 { */ path?: string; } - export interface Params$Resource$Accounts$Containers$Workspaces$Folders$Entities { + export interface Params$Resource$Accounts$Containers$Workspaces$Folders$Entities + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5753,7 +5827,8 @@ export namespace tagmanager_v2 { */ path?: string; } - export interface Params$Resource$Accounts$Containers$Workspaces$Folders$Get { + export interface Params$Resource$Accounts$Containers$Workspaces$Folders$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5765,7 +5840,8 @@ export namespace tagmanager_v2 { */ path?: string; } - export interface Params$Resource$Accounts$Containers$Workspaces$Folders$List { + export interface Params$Resource$Accounts$Containers$Workspaces$Folders$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5781,7 +5857,8 @@ export namespace tagmanager_v2 { */ parent?: string; } - export interface Params$Resource$Accounts$Containers$Workspaces$Folders$Move_entities_to_folder { + export interface Params$Resource$Accounts$Containers$Workspaces$Folders$Move_entities_to_folder + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5810,7 +5887,8 @@ export namespace tagmanager_v2 { */ requestBody?: Schema$Folder; } - export interface Params$Resource$Accounts$Containers$Workspaces$Folders$Revert { + export interface Params$Resource$Accounts$Containers$Workspaces$Folders$Revert + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5827,7 +5905,8 @@ export namespace tagmanager_v2 { */ path?: string; } - export interface Params$Resource$Accounts$Containers$Workspaces$Folders$Update { + export interface Params$Resource$Accounts$Containers$Workspaces$Folders$Update + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6000,7 +6079,8 @@ export namespace tagmanager_v2 { } } - export interface Params$Resource$Accounts$Containers$Workspaces$Proposal$Create { + export interface Params$Resource$Accounts$Containers$Workspaces$Proposal$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6017,7 +6097,8 @@ export namespace tagmanager_v2 { */ requestBody?: Schema$CreateWorkspaceProposalRequest; } - export interface Params$Resource$Accounts$Containers$Workspaces$Proposal$Delete { + export interface Params$Resource$Accounts$Containers$Workspaces$Proposal$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6451,7 +6532,8 @@ export namespace tagmanager_v2 { } } - export interface Params$Resource$Accounts$Containers$Workspaces$Tags$Create { + export interface Params$Resource$Accounts$Containers$Workspaces$Tags$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6468,7 +6550,8 @@ export namespace tagmanager_v2 { */ requestBody?: Schema$Tag; } - export interface Params$Resource$Accounts$Containers$Workspaces$Tags$Delete { + export interface Params$Resource$Accounts$Containers$Workspaces$Tags$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6480,7 +6563,8 @@ export namespace tagmanager_v2 { */ path?: string; } - export interface Params$Resource$Accounts$Containers$Workspaces$Tags$Get { + export interface Params$Resource$Accounts$Containers$Workspaces$Tags$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6492,7 +6576,8 @@ export namespace tagmanager_v2 { */ path?: string; } - export interface Params$Resource$Accounts$Containers$Workspaces$Tags$List { + export interface Params$Resource$Accounts$Containers$Workspaces$Tags$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6508,7 +6593,8 @@ export namespace tagmanager_v2 { */ parent?: string; } - export interface Params$Resource$Accounts$Containers$Workspaces$Tags$Revert { + export interface Params$Resource$Accounts$Containers$Workspaces$Tags$Revert + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6525,7 +6611,8 @@ export namespace tagmanager_v2 { */ path?: string; } - export interface Params$Resource$Accounts$Containers$Workspaces$Tags$Update { + export interface Params$Resource$Accounts$Containers$Workspaces$Tags$Update + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6973,7 +7060,8 @@ export namespace tagmanager_v2 { } } - export interface Params$Resource$Accounts$Containers$Workspaces$Triggers$Create { + export interface Params$Resource$Accounts$Containers$Workspaces$Triggers$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6990,7 +7078,8 @@ export namespace tagmanager_v2 { */ requestBody?: Schema$Trigger; } - export interface Params$Resource$Accounts$Containers$Workspaces$Triggers$Delete { + export interface Params$Resource$Accounts$Containers$Workspaces$Triggers$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7002,7 +7091,8 @@ export namespace tagmanager_v2 { */ path?: string; } - export interface Params$Resource$Accounts$Containers$Workspaces$Triggers$Get { + export interface Params$Resource$Accounts$Containers$Workspaces$Triggers$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7014,7 +7104,8 @@ export namespace tagmanager_v2 { */ path?: string; } - export interface Params$Resource$Accounts$Containers$Workspaces$Triggers$List { + export interface Params$Resource$Accounts$Containers$Workspaces$Triggers$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7030,7 +7121,8 @@ export namespace tagmanager_v2 { */ parent?: string; } - export interface Params$Resource$Accounts$Containers$Workspaces$Triggers$Revert { + export interface Params$Resource$Accounts$Containers$Workspaces$Triggers$Revert + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7047,7 +7139,8 @@ export namespace tagmanager_v2 { */ path?: string; } - export interface Params$Resource$Accounts$Containers$Workspaces$Triggers$Update { + export interface Params$Resource$Accounts$Containers$Workspaces$Triggers$Update + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7499,7 +7592,8 @@ export namespace tagmanager_v2 { } } - export interface Params$Resource$Accounts$Containers$Workspaces$Variables$Create { + export interface Params$Resource$Accounts$Containers$Workspaces$Variables$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7516,7 +7610,8 @@ export namespace tagmanager_v2 { */ requestBody?: Schema$Variable; } - export interface Params$Resource$Accounts$Containers$Workspaces$Variables$Delete { + export interface Params$Resource$Accounts$Containers$Workspaces$Variables$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7528,7 +7623,8 @@ export namespace tagmanager_v2 { */ path?: string; } - export interface Params$Resource$Accounts$Containers$Workspaces$Variables$Get { + export interface Params$Resource$Accounts$Containers$Workspaces$Variables$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7540,7 +7636,8 @@ export namespace tagmanager_v2 { */ path?: string; } - export interface Params$Resource$Accounts$Containers$Workspaces$Variables$List { + export interface Params$Resource$Accounts$Containers$Workspaces$Variables$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7556,7 +7653,8 @@ export namespace tagmanager_v2 { */ parent?: string; } - export interface Params$Resource$Accounts$Containers$Workspaces$Variables$Revert { + export interface Params$Resource$Accounts$Containers$Workspaces$Variables$Revert + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7573,7 +7671,8 @@ export namespace tagmanager_v2 { */ path?: string; } - export interface Params$Resource$Accounts$Containers$Workspaces$Variables$Update { + export interface Params$Resource$Accounts$Containers$Workspaces$Variables$Update + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7950,7 +8049,8 @@ export namespace tagmanager_v2 { } } - export interface Params$Resource$Accounts$User_permissions$Create { + export interface Params$Resource$Accounts$User_permissions$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7966,7 +8066,8 @@ export namespace tagmanager_v2 { */ requestBody?: Schema$UserPermission; } - export interface Params$Resource$Accounts$User_permissions$Delete { + export interface Params$Resource$Accounts$User_permissions$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7978,7 +8079,8 @@ export namespace tagmanager_v2 { */ path?: string; } - export interface Params$Resource$Accounts$User_permissions$Get { + export interface Params$Resource$Accounts$User_permissions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7990,7 +8092,8 @@ export namespace tagmanager_v2 { */ path?: string; } - export interface Params$Resource$Accounts$User_permissions$List { + export interface Params$Resource$Accounts$User_permissions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8005,7 +8108,8 @@ export namespace tagmanager_v2 { */ parent?: string; } - export interface Params$Resource$Accounts$User_permissions$Update { + export interface Params$Resource$Accounts$User_permissions$Update extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/tasks/v1.ts b/src/apis/tasks/v1.ts index a98374d47c..80b31107e5 100644 --- a/src/apis/tasks/v1.ts +++ b/src/apis/tasks/v1.ts @@ -29,6 +29,40 @@ export namespace tasks_v1 { version: 'v1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Tasks API * @@ -603,7 +637,7 @@ export namespace tasks_v1 { } } - export interface Params$Resource$Tasklists$Delete { + export interface Params$Resource$Tasklists$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -614,7 +648,7 @@ export namespace tasks_v1 { */ tasklist?: string; } - export interface Params$Resource$Tasklists$Get { + export interface Params$Resource$Tasklists$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -625,7 +659,7 @@ export namespace tasks_v1 { */ tasklist?: string; } - export interface Params$Resource$Tasklists$Insert { + export interface Params$Resource$Tasklists$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -637,7 +671,7 @@ export namespace tasks_v1 { */ requestBody?: Schema$TaskList; } - export interface Params$Resource$Tasklists$List { + export interface Params$Resource$Tasklists$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -653,7 +687,7 @@ export namespace tasks_v1 { */ pageToken?: string; } - export interface Params$Resource$Tasklists$Patch { + export interface Params$Resource$Tasklists$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -669,7 +703,7 @@ export namespace tasks_v1 { */ requestBody?: Schema$TaskList; } - export interface Params$Resource$Tasklists$Update { + export interface Params$Resource$Tasklists$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1232,7 +1266,7 @@ export namespace tasks_v1 { } } - export interface Params$Resource$Tasks$Clear { + export interface Params$Resource$Tasks$Clear extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1243,7 +1277,7 @@ export namespace tasks_v1 { */ tasklist?: string; } - export interface Params$Resource$Tasks$Delete { + export interface Params$Resource$Tasks$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1258,7 +1292,7 @@ export namespace tasks_v1 { */ tasklist?: string; } - export interface Params$Resource$Tasks$Get { + export interface Params$Resource$Tasks$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1273,7 +1307,7 @@ export namespace tasks_v1 { */ tasklist?: string; } - export interface Params$Resource$Tasks$Insert { + export interface Params$Resource$Tasks$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1299,7 +1333,7 @@ export namespace tasks_v1 { */ requestBody?: Schema$Task; } - export interface Params$Resource$Tasks$List { + export interface Params$Resource$Tasks$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1360,7 +1394,7 @@ export namespace tasks_v1 { */ updatedMin?: string; } - export interface Params$Resource$Tasks$Move { + export interface Params$Resource$Tasks$Move extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1385,7 +1419,7 @@ export namespace tasks_v1 { */ tasklist?: string; } - export interface Params$Resource$Tasks$Patch { + export interface Params$Resource$Tasks$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1405,7 +1439,7 @@ export namespace tasks_v1 { */ requestBody?: Schema$Task; } - export interface Params$Resource$Tasks$Update { + export interface Params$Resource$Tasks$Update extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/testing/v1.ts b/src/apis/testing/v1.ts index 41c4132f04..841aa8a5ed 100644 --- a/src/apis/testing/v1.ts +++ b/src/apis/testing/v1.ts @@ -29,6 +29,57 @@ export namespace testing_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Testing API * @@ -241,6 +292,12 @@ export namespace testing_v1 { * TestExecutionService. @OutputOnly */ id?: string; + /** + * True if and only if tests with this model are recorded by stitching + * together screenshots. See use_low_spec_video_recording in device config. + * @OutputOnly + */ + lowFpsVideoRecording?: boolean; /** * The manufacturer of this device. @OutputOnly */ @@ -282,11 +339,6 @@ export namespace testing_v1 { * "preview", "deprecated" */ tags?: string[]; - /** - * True if and only if tests with this model DO NOT have video output. See - * also TestSpecification.disable_video_recording @OutputOnly - */ - videoRecordingNotSupported?: boolean; } /** * A test of an android application that explores the application on a virtual @@ -1025,12 +1077,6 @@ export namespace testing_v1 { * progress_messages. @OutputOnly */ progressMessages?: string[]; - /** - * Indicates that video will not be recorded for this execution either - * because the user chose to disable it or the device does not support it. - * See AndroidModel.video_recording_not_supported @OutputOnly - */ - videoRecordingDisabled?: boolean; } /** * A description of a test environment. @@ -1413,7 +1459,8 @@ export namespace testing_v1 { } } - export interface Params$Resource$Applicationdetailservice$Getapkdetails { + export interface Params$Resource$Applicationdetailservice$Getapkdetails + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1674,7 +1721,8 @@ export namespace testing_v1 { } } - export interface Params$Resource$Projects$Testmatrices$Cancel { + export interface Params$Resource$Projects$Testmatrices$Cancel extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1689,7 +1737,8 @@ export namespace testing_v1 { */ testMatrixId?: string; } - export interface Params$Resource$Projects$Testmatrices$Create { + export interface Params$Resource$Projects$Testmatrices$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1711,7 +1760,8 @@ export namespace testing_v1 { */ requestBody?: Schema$TestMatrix; } - export interface Params$Resource$Projects$Testmatrices$Get { + export interface Params$Resource$Projects$Testmatrices$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1809,7 +1859,8 @@ export namespace testing_v1 { } } - export interface Params$Resource$Testenvironmentcatalog$Get { + export interface Params$Resource$Testenvironmentcatalog$Get extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/texttospeech/v1.ts b/src/apis/texttospeech/v1.ts index e17d789b5e..e958cb5a92 100644 --- a/src/apis/texttospeech/v1.ts +++ b/src/apis/texttospeech/v1.ts @@ -29,6 +29,57 @@ export namespace texttospeech_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Text-to-Speech API * @@ -306,7 +357,7 @@ export namespace texttospeech_v1 { } } - export interface Params$Resource$Text$Synthesize { + export interface Params$Resource$Text$Synthesize extends StandardParameters { /** * Auth client or API Key for the request */ @@ -396,7 +447,7 @@ export namespace texttospeech_v1 { } } - export interface Params$Resource$Voices$List { + export interface Params$Resource$Voices$List extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/texttospeech/v1beta1.ts b/src/apis/texttospeech/v1beta1.ts index ff38702bff..0f0d800055 100644 --- a/src/apis/texttospeech/v1beta1.ts +++ b/src/apis/texttospeech/v1beta1.ts @@ -29,6 +29,57 @@ export namespace texttospeech_v1beta1 { version: 'v1beta1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Text-to-Speech API * @@ -312,7 +363,7 @@ export namespace texttospeech_v1beta1 { } } - export interface Params$Resource$Text$Synthesize { + export interface Params$Resource$Text$Synthesize extends StandardParameters { /** * Auth client or API Key for the request */ @@ -402,7 +453,7 @@ export namespace texttospeech_v1beta1 { } } - export interface Params$Resource$Voices$List { + export interface Params$Resource$Voices$List extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/toolresults/v1beta3.ts b/src/apis/toolresults/v1beta3.ts index a4d9c36938..744b94c8cb 100644 --- a/src/apis/toolresults/v1beta3.ts +++ b/src/apis/toolresults/v1beta3.ts @@ -29,6 +29,40 @@ export namespace toolresults_v1beta3 { version: 'v1beta3'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Cloud Tool Results API * @@ -1543,7 +1577,8 @@ export namespace toolresults_v1beta3 { } } - export interface Params$Resource$Projects$Getsettings { + export interface Params$Resource$Projects$Getsettings extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1554,7 +1589,8 @@ export namespace toolresults_v1beta3 { */ projectId?: string; } - export interface Params$Resource$Projects$Initializesettings { + export interface Params$Resource$Projects$Initializesettings extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1798,7 +1834,8 @@ export namespace toolresults_v1beta3 { } } - export interface Params$Resource$Projects$Histories$Create { + export interface Params$Resource$Projects$Histories$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1819,7 +1856,8 @@ export namespace toolresults_v1beta3 { */ requestBody?: Schema$History; } - export interface Params$Resource$Projects$Histories$Get { + export interface Params$Resource$Projects$Histories$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1834,7 +1872,8 @@ export namespace toolresults_v1beta3 { */ projectId?: string; } - export interface Params$Resource$Projects$Histories$List { + export interface Params$Resource$Projects$Histories$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2024,7 +2063,7 @@ export namespace toolresults_v1beta3 { /** * toolresults.projects.histories.executions.list - * @desc Lists Histories for a given Project. The executions are sorted by + * @desc Lists Executions for a given History. The executions are sorted by * creation_time in descending order. The execution_id key will be used to * order the executions with the same creation_time. May return any of the * following canonical error codes: - PERMISSION_DENIED - if the user is @@ -2178,7 +2217,8 @@ export namespace toolresults_v1beta3 { } } - export interface Params$Resource$Projects$Histories$Executions$Create { + export interface Params$Resource$Projects$Histories$Executions$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2203,7 +2243,8 @@ export namespace toolresults_v1beta3 { */ requestBody?: Schema$Execution; } - export interface Params$Resource$Projects$Histories$Executions$Get { + export interface Params$Resource$Projects$Histories$Executions$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2222,7 +2263,8 @@ export namespace toolresults_v1beta3 { */ projectId?: string; } - export interface Params$Resource$Projects$Histories$Executions$List { + export interface Params$Resource$Projects$Histories$Executions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2247,7 +2289,8 @@ export namespace toolresults_v1beta3 { */ projectId?: string; } - export interface Params$Resource$Projects$Histories$Executions$Patch { + export interface Params$Resource$Projects$Histories$Executions$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2445,7 +2488,8 @@ export namespace toolresults_v1beta3 { } } - export interface Params$Resource$Projects$Histories$Executions$Clusters$Get { + export interface Params$Resource$Projects$Histories$Executions$Clusters$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2468,7 +2512,8 @@ export namespace toolresults_v1beta3 { */ projectId?: string; } - export interface Params$Resource$Projects$Histories$Executions$Clusters$List { + export interface Params$Resource$Projects$Histories$Executions$Clusters$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2990,7 +3035,8 @@ export namespace toolresults_v1beta3 { } } - export interface Params$Resource$Projects$Histories$Executions$Steps$Create { + export interface Params$Resource$Projects$Histories$Executions$Steps$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3019,7 +3065,8 @@ export namespace toolresults_v1beta3 { */ requestBody?: Schema$Step; } - export interface Params$Resource$Projects$Histories$Executions$Steps$Get { + export interface Params$Resource$Projects$Histories$Executions$Steps$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3042,7 +3089,8 @@ export namespace toolresults_v1beta3 { */ stepId?: string; } - export interface Params$Resource$Projects$Histories$Executions$Steps$Getperfmetricssummary { + export interface Params$Resource$Projects$Histories$Executions$Steps$Getperfmetricssummary + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3065,7 +3113,8 @@ export namespace toolresults_v1beta3 { */ stepId?: string; } - export interface Params$Resource$Projects$Histories$Executions$Steps$List { + export interface Params$Resource$Projects$Histories$Executions$Steps$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3093,7 +3142,8 @@ export namespace toolresults_v1beta3 { */ projectId?: string; } - export interface Params$Resource$Projects$Histories$Executions$Steps$Patch { + export interface Params$Resource$Projects$Histories$Executions$Steps$Patch + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3126,7 +3176,8 @@ export namespace toolresults_v1beta3 { */ requestBody?: Schema$Step; } - export interface Params$Resource$Projects$Histories$Executions$Steps$Publishxunitxmlfiles { + export interface Params$Resource$Projects$Histories$Executions$Steps$Publishxunitxmlfiles + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3248,7 +3299,8 @@ export namespace toolresults_v1beta3 { } } - export interface Params$Resource$Projects$Histories$Executions$Steps$Perfmetricssummary$Create { + export interface Params$Resource$Projects$Histories$Executions$Steps$Perfmetricssummary$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3546,7 +3598,8 @@ export namespace toolresults_v1beta3 { } } - export interface Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Create { + export interface Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Create + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3574,7 +3627,8 @@ export namespace toolresults_v1beta3 { */ requestBody?: Schema$PerfSampleSeries; } - export interface Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Get { + export interface Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3601,7 +3655,8 @@ export namespace toolresults_v1beta3 { */ stepId?: string; } - export interface Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$List { + export interface Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3836,7 +3891,8 @@ export namespace toolresults_v1beta3 { } } - export interface Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Samples$Batchcreate { + export interface Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Samples$Batchcreate + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3868,7 +3924,8 @@ export namespace toolresults_v1beta3 { */ requestBody?: Schema$BatchCreatePerfSamplesRequest; } - export interface Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Samples$List { + export interface Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Samples$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4008,7 +4065,8 @@ export namespace toolresults_v1beta3 { } } - export interface Params$Resource$Projects$Histories$Executions$Steps$Thumbnails$List { + export interface Params$Resource$Projects$Histories$Executions$Steps$Thumbnails$List + extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/tpu/v1.ts b/src/apis/tpu/v1.ts index ccd08896eb..1903afd169 100644 --- a/src/apis/tpu/v1.ts +++ b/src/apis/tpu/v1.ts @@ -29,6 +29,57 @@ export namespace tpu_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud TPU API * @@ -123,6 +174,10 @@ export namespace tpu_v1 { * The listed nodes. */ nodes?: Schema$Node[]; + /** + * Locations that could not be reached. + */ + unreachable?: string[]; } /** * The response message for Operations.ListOperations. @@ -609,7 +664,8 @@ export namespace tpu_v1 { } } - export interface Params$Resource$Projects$Locations$Get { + export interface Params$Resource$Projects$Locations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -620,7 +676,8 @@ export namespace tpu_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$List { + export interface Params$Resource$Projects$Locations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -798,7 +855,8 @@ export namespace tpu_v1 { } } - export interface Params$Resource$Projects$Locations$Acceleratortypes$Get { + export interface Params$Resource$Projects$Locations$Acceleratortypes$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -809,7 +867,8 @@ export namespace tpu_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Acceleratortypes$List { + export interface Params$Resource$Projects$Locations$Acceleratortypes$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1318,7 +1377,8 @@ export namespace tpu_v1 { } } - export interface Params$Resource$Projects$Locations$Nodes$Create { + export interface Params$Resource$Projects$Locations$Nodes$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1338,7 +1398,8 @@ export namespace tpu_v1 { */ requestBody?: Schema$Node; } - export interface Params$Resource$Projects$Locations$Nodes$Delete { + export interface Params$Resource$Projects$Locations$Nodes$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1349,7 +1410,8 @@ export namespace tpu_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Nodes$Get { + export interface Params$Resource$Projects$Locations$Nodes$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1360,7 +1422,8 @@ export namespace tpu_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Nodes$List { + export interface Params$Resource$Projects$Locations$Nodes$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1379,7 +1442,8 @@ export namespace tpu_v1 { */ parent?: string; } - export interface Params$Resource$Projects$Locations$Nodes$Reimage { + export interface Params$Resource$Projects$Locations$Nodes$Reimage extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1395,7 +1459,8 @@ export namespace tpu_v1 { */ requestBody?: Schema$ReimageNodeRequest; } - export interface Params$Resource$Projects$Locations$Nodes$Start { + export interface Params$Resource$Projects$Locations$Nodes$Start extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1411,7 +1476,8 @@ export namespace tpu_v1 { */ requestBody?: Schema$StartNodeRequest; } - export interface Params$Resource$Projects$Locations$Nodes$Stop { + export interface Params$Resource$Projects$Locations$Nodes$Stop extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1726,7 +1792,8 @@ export namespace tpu_v1 { } } - export interface Params$Resource$Projects$Locations$Operations$Cancel { + export interface Params$Resource$Projects$Locations$Operations$Cancel extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1737,7 +1804,8 @@ export namespace tpu_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$Delete { + export interface Params$Resource$Projects$Locations$Operations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1748,7 +1816,8 @@ export namespace tpu_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$Get { + export interface Params$Resource$Projects$Locations$Operations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1759,7 +1828,8 @@ export namespace tpu_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$List { + export interface Params$Resource$Projects$Locations$Operations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1940,7 +2010,8 @@ export namespace tpu_v1 { } } - export interface Params$Resource$Projects$Locations$Tensorflowversions$Get { + export interface Params$Resource$Projects$Locations$Tensorflowversions$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1951,7 +2022,8 @@ export namespace tpu_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorflowversions$List { + export interface Params$Resource$Projects$Locations$Tensorflowversions$List + extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/tpu/v1alpha1.ts b/src/apis/tpu/v1alpha1.ts index 1c0834fec2..7d3caad2c5 100644 --- a/src/apis/tpu/v1alpha1.ts +++ b/src/apis/tpu/v1alpha1.ts @@ -29,6 +29,57 @@ export namespace tpu_v1alpha1 { version: 'v1alpha1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud TPU API * @@ -123,6 +174,10 @@ export namespace tpu_v1alpha1 { * The listed nodes. */ nodes?: Schema$Node[]; + /** + * Locations that could not be reached. + */ + unreachable?: string[]; } /** * The response message for Operations.ListOperations. @@ -610,7 +665,8 @@ export namespace tpu_v1alpha1 { } } - export interface Params$Resource$Projects$Locations$Get { + export interface Params$Resource$Projects$Locations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -621,7 +677,8 @@ export namespace tpu_v1alpha1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$List { + export interface Params$Resource$Projects$Locations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -800,7 +857,8 @@ export namespace tpu_v1alpha1 { } } - export interface Params$Resource$Projects$Locations$Acceleratortypes$Get { + export interface Params$Resource$Projects$Locations$Acceleratortypes$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -811,7 +869,8 @@ export namespace tpu_v1alpha1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Acceleratortypes$List { + export interface Params$Resource$Projects$Locations$Acceleratortypes$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1323,7 +1382,8 @@ export namespace tpu_v1alpha1 { } } - export interface Params$Resource$Projects$Locations$Nodes$Create { + export interface Params$Resource$Projects$Locations$Nodes$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1343,7 +1403,8 @@ export namespace tpu_v1alpha1 { */ requestBody?: Schema$Node; } - export interface Params$Resource$Projects$Locations$Nodes$Delete { + export interface Params$Resource$Projects$Locations$Nodes$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1354,7 +1415,8 @@ export namespace tpu_v1alpha1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Nodes$Get { + export interface Params$Resource$Projects$Locations$Nodes$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1365,7 +1427,8 @@ export namespace tpu_v1alpha1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Nodes$List { + export interface Params$Resource$Projects$Locations$Nodes$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1384,7 +1447,8 @@ export namespace tpu_v1alpha1 { */ parent?: string; } - export interface Params$Resource$Projects$Locations$Nodes$Reimage { + export interface Params$Resource$Projects$Locations$Nodes$Reimage extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1400,7 +1464,8 @@ export namespace tpu_v1alpha1 { */ requestBody?: Schema$ReimageNodeRequest; } - export interface Params$Resource$Projects$Locations$Nodes$Start { + export interface Params$Resource$Projects$Locations$Nodes$Start extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1416,7 +1481,8 @@ export namespace tpu_v1alpha1 { */ requestBody?: Schema$StartNodeRequest; } - export interface Params$Resource$Projects$Locations$Nodes$Stop { + export interface Params$Resource$Projects$Locations$Nodes$Stop extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1733,7 +1799,8 @@ export namespace tpu_v1alpha1 { } } - export interface Params$Resource$Projects$Locations$Operations$Cancel { + export interface Params$Resource$Projects$Locations$Operations$Cancel extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1744,7 +1811,8 @@ export namespace tpu_v1alpha1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$Delete { + export interface Params$Resource$Projects$Locations$Operations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1755,7 +1823,8 @@ export namespace tpu_v1alpha1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$Get { + export interface Params$Resource$Projects$Locations$Operations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1766,7 +1835,8 @@ export namespace tpu_v1alpha1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$List { + export interface Params$Resource$Projects$Locations$Operations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1948,7 +2018,8 @@ export namespace tpu_v1alpha1 { } } - export interface Params$Resource$Projects$Locations$Tensorflowversions$Get { + export interface Params$Resource$Projects$Locations$Tensorflowversions$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1959,7 +2030,8 @@ export namespace tpu_v1alpha1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorflowversions$List { + export interface Params$Resource$Projects$Locations$Tensorflowversions$List + extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/translate/README.md b/src/apis/translate/README.md index 5d708cc363..38e08b3c6f 100644 --- a/src/apis/translate/README.md +++ b/src/apis/translate/README.md @@ -2,7 +2,7 @@ # @google/translate -> The Google Cloud Translation API lets websites and programs integrate with Google Translate programmatically. +> Integrates text translation into your website or application. ## Installation diff --git a/src/apis/translate/v2.ts b/src/apis/translate/v2.ts index 1fdf8c5483..6d65b8d684 100644 --- a/src/apis/translate/v2.ts +++ b/src/apis/translate/v2.ts @@ -29,6 +29,65 @@ export namespace translate_v2 { version: 'v2'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * OAuth bearer token. + */ + bearer_token?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Pretty-print response. + */ + pp?: boolean; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. Overrides userIp if both are provided. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Google Cloud Translation API * @@ -331,7 +390,8 @@ export namespace translate_v2 { } } - export interface Params$Resource$Detections$Detect { + export interface Params$Resource$Detections$Detect extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -343,7 +403,7 @@ export namespace translate_v2 { */ requestBody?: Schema$DetectLanguageRequest; } - export interface Params$Resource$Detections$List { + export interface Params$Resource$Detections$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -436,7 +496,7 @@ export namespace translate_v2 { } } - export interface Params$Resource$Languages$List { + export interface Params$Resource$Languages$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -607,7 +667,8 @@ export namespace translate_v2 { } } - export interface Params$Resource$Translations$List { + export interface Params$Resource$Translations$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -646,7 +707,8 @@ export namespace translate_v2 { */ target?: string; } - export interface Params$Resource$Translations$Translate { + export interface Params$Resource$Translations$Translate extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/urlshortener/v1.ts b/src/apis/urlshortener/v1.ts index 9c7d1f1588..46be092328 100644 --- a/src/apis/urlshortener/v1.ts +++ b/src/apis/urlshortener/v1.ts @@ -29,6 +29,40 @@ export namespace urlshortener_v1 { version: 'v1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * URL Shortener API * @@ -393,7 +427,7 @@ export namespace urlshortener_v1 { } } - export interface Params$Resource$Url$Get { + export interface Params$Resource$Url$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -408,7 +442,7 @@ export namespace urlshortener_v1 { */ shortUrl?: string; } - export interface Params$Resource$Url$Insert { + export interface Params$Resource$Url$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -420,7 +454,7 @@ export namespace urlshortener_v1 { */ requestBody?: Schema$Url; } - export interface Params$Resource$Url$List { + export interface Params$Resource$Url$List extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/vault/v1.ts b/src/apis/vault/v1.ts index 5e77f523a6..04563ae161 100644 --- a/src/apis/vault/v1.ts +++ b/src/apis/vault/v1.ts @@ -29,6 +29,57 @@ export namespace vault_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * G Suite Vault API * @@ -526,6 +577,20 @@ export namespace vault_v1 { */ nextPageToken?: string; } + /** + * Definition of the response for method ListSaveQuery. + */ + export interface Schema$ListSavedQueriesResponse { + /** + * Page token to retrieve the next page of results in the list. If this is + * empty, then there are no more saved queries to list. + */ + nextPageToken?: string; + /** + * List of output saved queries. + */ + savedQueries?: Schema$SavedQuery[]; + } /** * The options for mail export. */ @@ -534,6 +599,10 @@ export namespace vault_v1 { * The export file format. */ exportFormat?: string; + /** + * Set to true to export confidential mode content + */ + showConfidentialModeContent?: boolean; } /** * Mail search advanced options @@ -712,6 +781,34 @@ export namespace vault_v1 { */ matter?: Schema$Matter; } + /** + * Definition of the saved query. + */ + export interface Schema$SavedQuery { + /** + * Output only. The server generated timestamp at which saved query was + * created. + */ + createTime?: string; + /** + * Name of the saved query. + */ + displayName?: string; + /** + * Output only. The matter id of the associated matter. The server does not + * look at this field during create and always uses matter id in the URL. + */ + matterId?: string; + /** + * The underlying Query object which contains all the information of the + * saved query. + */ + query?: Schema$Query; + /** + * A unique identifier for the saved query. + */ + savedQueryId?: string; + } /** * The `Status` type defines a logical error model that is suitable for * different programming environments, including REST APIs and RPC APIs. It is @@ -799,11 +896,13 @@ export namespace vault_v1 { root: Vault; exports: Resource$Matters$Exports; holds: Resource$Matters$Holds; + savedQueries: Resource$Matters$Savedqueries; constructor(root: Vault) { this.root = root; this.getRoot.bind(this); this.exports = new Resource$Matters$Exports(root); this.holds = new Resource$Matters$Holds(root); + this.savedQueries = new Resource$Matters$Savedqueries(root); } getRoot() { @@ -1471,7 +1570,8 @@ export namespace vault_v1 { } } - export interface Params$Resource$Matters$Addpermissions { + export interface Params$Resource$Matters$Addpermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1487,7 +1587,7 @@ export namespace vault_v1 { */ requestBody?: Schema$AddMatterPermissionsRequest; } - export interface Params$Resource$Matters$Close { + export interface Params$Resource$Matters$Close extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1503,7 +1603,7 @@ export namespace vault_v1 { */ requestBody?: Schema$CloseMatterRequest; } - export interface Params$Resource$Matters$Create { + export interface Params$Resource$Matters$Create extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1515,7 +1615,7 @@ export namespace vault_v1 { */ requestBody?: Schema$Matter; } - export interface Params$Resource$Matters$Delete { + export interface Params$Resource$Matters$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1526,7 +1626,7 @@ export namespace vault_v1 { */ matterId?: string; } - export interface Params$Resource$Matters$Get { + export interface Params$Resource$Matters$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1541,7 +1641,7 @@ export namespace vault_v1 { */ view?: string; } - export interface Params$Resource$Matters$List { + export interface Params$Resource$Matters$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1566,7 +1666,8 @@ export namespace vault_v1 { */ view?: string; } - export interface Params$Resource$Matters$Removepermissions { + export interface Params$Resource$Matters$Removepermissions extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1582,7 +1683,7 @@ export namespace vault_v1 { */ requestBody?: Schema$RemoveMatterPermissionsRequest; } - export interface Params$Resource$Matters$Reopen { + export interface Params$Resource$Matters$Reopen extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1598,7 +1699,7 @@ export namespace vault_v1 { */ requestBody?: Schema$ReopenMatterRequest; } - export interface Params$Resource$Matters$Undelete { + export interface Params$Resource$Matters$Undelete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1614,7 +1715,7 @@ export namespace vault_v1 { */ requestBody?: Schema$UndeleteMatterRequest; } - export interface Params$Resource$Matters$Update { + export interface Params$Resource$Matters$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1909,7 +2010,8 @@ export namespace vault_v1 { } } - export interface Params$Resource$Matters$Exports$Create { + export interface Params$Resource$Matters$Exports$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1925,7 +2027,8 @@ export namespace vault_v1 { */ requestBody?: Schema$Export; } - export interface Params$Resource$Matters$Exports$Delete { + export interface Params$Resource$Matters$Exports$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1940,7 +2043,8 @@ export namespace vault_v1 { */ matterId?: string; } - export interface Params$Resource$Matters$Exports$Get { + export interface Params$Resource$Matters$Exports$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1955,7 +2059,8 @@ export namespace vault_v1 { */ matterId?: string; } - export interface Params$Resource$Matters$Exports$List { + export interface Params$Resource$Matters$Exports$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2482,7 +2587,8 @@ export namespace vault_v1 { } } - export interface Params$Resource$Matters$Holds$Addheldaccounts { + export interface Params$Resource$Matters$Holds$Addheldaccounts extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2502,7 +2608,8 @@ export namespace vault_v1 { */ requestBody?: Schema$AddHeldAccountsRequest; } - export interface Params$Resource$Matters$Holds$Create { + export interface Params$Resource$Matters$Holds$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2518,7 +2625,8 @@ export namespace vault_v1 { */ requestBody?: Schema$Hold; } - export interface Params$Resource$Matters$Holds$Delete { + export interface Params$Resource$Matters$Holds$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2533,7 +2641,8 @@ export namespace vault_v1 { */ matterId?: string; } - export interface Params$Resource$Matters$Holds$Get { + export interface Params$Resource$Matters$Holds$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2552,7 +2661,8 @@ export namespace vault_v1 { */ view?: string; } - export interface Params$Resource$Matters$Holds$List { + export interface Params$Resource$Matters$Holds$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2577,7 +2687,8 @@ export namespace vault_v1 { */ view?: string; } - export interface Params$Resource$Matters$Holds$Removeheldaccounts { + export interface Params$Resource$Matters$Holds$Removeheldaccounts extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2597,7 +2708,8 @@ export namespace vault_v1 { */ requestBody?: Schema$RemoveHeldAccountsRequest; } - export interface Params$Resource$Matters$Holds$Update { + export interface Params$Resource$Matters$Holds$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2844,7 +2956,8 @@ export namespace vault_v1 { } } - export interface Params$Resource$Matters$Holds$Accounts$Create { + export interface Params$Resource$Matters$Holds$Accounts$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2864,7 +2977,8 @@ export namespace vault_v1 { */ requestBody?: Schema$HeldAccount; } - export interface Params$Resource$Matters$Holds$Accounts$Delete { + export interface Params$Resource$Matters$Holds$Accounts$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2883,7 +2997,8 @@ export namespace vault_v1 { */ matterId?: string; } - export interface Params$Resource$Matters$Holds$Accounts$List { + export interface Params$Resource$Matters$Holds$Accounts$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -2898,4 +3013,365 @@ export namespace vault_v1 { */ matterId?: string; } + + + + export class Resource$Matters$Savedqueries { + root: Vault; + constructor(root: Vault) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * vault.matters.savedQueries.create + * @desc Creates a saved query. + * @alias vault.matters.savedQueries.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.matterId The matter id of the parent matter for which the saved query is to be created. + * @param {().SavedQuery} 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$Matters$Savedqueries$Create, + options?: MethodOptions): AxiosPromise; + create( + params: Params$Resource$Matters$Savedqueries$Create, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + create( + params: Params$Resource$Matters$Savedqueries$Create, + callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: Params$Resource$Matters$Savedqueries$Create| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Matters$Savedqueries$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Matters$Savedqueries$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vault.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/matters/{matterId}/savedQueries') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['matterId'], + pathParams: ['matterId'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * vault.matters.savedQueries.delete + * @desc Deletes a saved query by Id. + * @alias vault.matters.savedQueries.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.matterId The matter id of the parent matter for which the saved query is to be deleted. + * @param {string} params.savedQueryId Id of the saved query 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 + */ + delete( + params?: Params$Resource$Matters$Savedqueries$Delete, + options?: MethodOptions): AxiosPromise; + delete( + params: Params$Resource$Matters$Savedqueries$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Matters$Savedqueries$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Matters$Savedqueries$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Matters$Savedqueries$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Matters$Savedqueries$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vault.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/v1/matters/{matterId}/savedQueries/{savedQueryId}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['matterId', 'savedQueryId'], + pathParams: ['matterId', 'savedQueryId'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * vault.matters.savedQueries.get + * @desc Retrieves a saved query by Id. + * @alias vault.matters.savedQueries.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.matterId The matter id of the parent matter for which the saved query is to be retrieved. + * @param {string} params.savedQueryId Id of the saved query 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 + */ + get(params?: Params$Resource$Matters$Savedqueries$Get, + options?: MethodOptions): AxiosPromise; + get(params: Params$Resource$Matters$Savedqueries$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Matters$Savedqueries$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Matters$Savedqueries$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Matters$Savedqueries$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Matters$Savedqueries$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vault.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/v1/matters/{matterId}/savedQueries/{savedQueryId}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['matterId', 'savedQueryId'], + pathParams: ['matterId', 'savedQueryId'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * vault.matters.savedQueries.list + * @desc Lists saved queries within a matter. An empty page token in + * ListSavedQueriesResponse denotes no more saved queries to list. + * @alias vault.matters.savedQueries.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.matterId The matter id of the parent matter for which the saved queries are to be retrieved. + * @param {integer=} params.pageSize The maximum number of saved queries to return. + * @param {string=} params.pageToken The pagination token as returned in the previous response. An empty token means start from the beginning. + * @param {object} [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$Matters$Savedqueries$List, + options?: MethodOptions): AxiosPromise; + list( + params: Params$Resource$Matters$Savedqueries$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Matters$Savedqueries$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Matters$Savedqueries$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Matters$Savedqueries$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Matters$Savedqueries$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vault.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/matters/{matterId}/savedQueries') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['matterId'], + pathParams: ['matterId'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Matters$Savedqueries$Create extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The matter id of the parent matter for which the saved query is to be + * created. + */ + matterId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SavedQuery; + } + export interface Params$Resource$Matters$Savedqueries$Delete extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The matter id of the parent matter for which the saved query is to be + * deleted. + */ + matterId?: string; + /** + * Id of the saved query to be deleted. + */ + savedQueryId?: string; + } + export interface Params$Resource$Matters$Savedqueries$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The matter id of the parent matter for which the saved query is to be + * retrieved. + */ + matterId?: string; + /** + * Id of the saved query to be retrieved. + */ + savedQueryId?: string; + } + export interface Params$Resource$Matters$Savedqueries$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The matter id of the parent matter for which the saved queries are to be + * retrieved. + */ + matterId?: string; + /** + * The maximum number of saved queries to return. + */ + pageSize?: number; + /** + * The pagination token as returned in the previous response. An empty token + * means start from the beginning. + */ + pageToken?: string; + } } diff --git a/src/apis/videointelligence/v1.ts b/src/apis/videointelligence/v1.ts index 9df1c5772d..2b4b781fcb 100644 --- a/src/apis/videointelligence/v1.ts +++ b/src/apis/videointelligence/v1.ts @@ -29,10 +29,62 @@ export namespace videointelligence_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Video Intelligence API * - * Cloud Video Intelligence API. + * Detects objects, explicit content, and scene changes in videos. It also + * specifies the region for annotation and transcribes speech to text. * * @example * const {google} = require('googleapis'); @@ -183,6 +235,47 @@ export namespace videointelligence_v1 { */ segment?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment; } + /** + * Alternative hypotheses (a.k.a. n-best list). + */ + export interface Schema$GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative { + /** + * The confidence estimate between 0.0 and 1.0. A higher number indicates an + * estimated greater likelihood that the recognized words are correct. This + * field is typically provided only for the top hypothesis, and only for + * `is_final=true` results. Clients should not rely on the `confidence` + * field as it is not guaranteed to be accurate or consistent. The default + * of 0.0 is a sentinel value indicating `confidence` was not set. + */ + confidence?: number; + /** + * Transcript text representing the words that the user spoke. + */ + transcript?: string; + /** + * A list of word-specific information for each recognized word. + */ + words?: Schema$GoogleCloudVideointelligenceV1beta2_WordInfo[]; + } + /** + * A speech recognition result corresponding to a portion of the audio. + */ + export interface Schema$GoogleCloudVideointelligenceV1beta2_SpeechTranscription { + /** + * May contain one or more recognition hypotheses (up to the maximum + * specified in `max_alternatives`). These alternatives are ordered in + * terms of accuracy, with the top (first) alternative being the most + * probable, as ranked by the recognizer. + */ + alternatives?: + Schema$GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative[]; + /** + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) + * language tag of the language in this result. This language code was + * detected to have the most likelihood of being spoken in the audio. + */ + languageCode?: string; + } /** * Annotation progress for a single video. */ @@ -247,6 +340,11 @@ export namespace videointelligence_v1 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; + /** + * Speech transcription. + */ + speechTranscriptions?: + Schema$GoogleCloudVideointelligenceV1beta2_SpeechTranscription[]; } /** * Video segment. @@ -263,6 +361,48 @@ export namespace videointelligence_v1 { */ startTimeOffset?: string; } + /** + * Word-specific information for recognized words. Word information is only + * included in the response when certain request parameters are set, such as + * `enable_word_time_offsets`. + */ + export interface Schema$GoogleCloudVideointelligenceV1beta2_WordInfo { + /** + * Output only. The confidence estimate between 0.0 and 1.0. A higher number + * indicates an estimated greater likelihood that the recognized words are + * correct. This field is set only for the top alternative. This field is + * not guaranteed to be accurate and users should not rely on it to be + * always provided. The default of 0.0 is a sentinel value indicating + * `confidence` was not set. + */ + confidence?: number; + /** + * Time offset relative to the beginning of the audio, and corresponding to + * the end of the spoken word. This field is only set if + * `enable_word_time_offsets=true` and only in the top hypothesis. This is + * an experimental feature and the accuracy of the time offset can vary. + */ + endTime?: string; + /** + * Output only. A distinct integer value is assigned for every speaker + * within the audio. This field specifies which one of those speakers was + * detected to have spoken this word. Value ranges from 1 up to + * diarization_speaker_count, and is only set if speaker diarization is + * enabled. + */ + speakerTag?: number; + /** + * Time offset relative to the beginning of the audio, and corresponding to + * the start of the spoken word. This field is only set if + * `enable_word_time_offsets=true` and only in the top hypothesis. This is + * an experimental feature and the accuracy of the time offset can vary. + */ + startTime?: string; + /** + * The word corresponding to this set of information. + */ + word?: string; + } /** * Video annotation progress. Included in the `metadata` field of the * `Operation` returned by the `GetOperation` call of the @@ -415,6 +555,12 @@ export namespace videointelligence_v1 { */ alternatives?: Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechRecognitionAlternative[]; + /** + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) + * language tag of the language in this result. This language code was + * detected to have the most likelihood of being spoken in the audio. + */ + languageCode?: string; } /** * Annotation progress for a single video. @@ -751,20 +897,52 @@ export namespace videointelligence_v1 { timeOffset?: string; } /** - * Annotations related to one detected OCR text snippet. This will contain the - * corresponding text, confidence value, and frame level information for each - * detection. + * Alternative hypotheses (a.k.a. n-best list). */ - export interface Schema$GoogleCloudVideointelligenceV1p2beta1_TextAnnotation { + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative { /** - * Confidence for the track of detected text. It is calculated as the - * highest over all frames where OCR detected text appears. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an + * estimated greater likelihood that the recognized words are correct. This + * field is typically provided only for the top hypothesis, and only for + * `is_final=true` results. Clients should not rely on the `confidence` + * field as it is not guaranteed to be accurate or consistent. The default + * of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** - * Information related to the frames where OCR detected text appears. + * Transcript text representing the words that the user spoke. */ - frames?: Schema$GoogleCloudVideointelligenceV1p2beta1_TextFrame[]; + transcript?: string; + /** + * A list of word-specific information for each recognized word. + */ + words?: Schema$GoogleCloudVideointelligenceV1p2beta1_WordInfo[]; + } + /** + * A speech recognition result corresponding to a portion of the audio. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechTranscription { + /** + * May contain one or more recognition hypotheses (up to the maximum + * specified in `max_alternatives`). These alternatives are ordered in + * terms of accuracy, with the top (first) alternative being the most + * probable, as ranked by the recognizer. + */ + alternatives?: + Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative[]; + /** + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) + * language tag of the language in this result. This language code was + * detected to have the most likelihood of being spoken in the audio. + */ + languageCode?: string; + } + /** + * Annotations related to one detected OCR text snippet. This will contain the + * corresponding text, confidence value, and frame level information for each + * detection. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_TextAnnotation { /** * All video segments where OCR detected text appears. */ @@ -794,6 +972,15 @@ export namespace videointelligence_v1 { * Video segment level annotation results for text detection. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_TextSegment { + /** + * Confidence for the track of detected text. It is calculated as the + * highest over all frames where OCR detected text appears. + */ + confidence?: number; + /** + * Information related to the frames where OCR detected text appears. + */ + frames?: Schema$GoogleCloudVideointelligenceV1p2beta1_TextFrame[]; /** * Video segment where a text snippet was detected. */ @@ -869,6 +1056,11 @@ export namespace videointelligence_v1 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; + /** + * Speech transcription. + */ + speechTranscriptions?: + Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechTranscription[]; /** * OCR text detection and tracking. Annotations for list of detected text * snippets. Each will have list of frame information associated with it. @@ -891,6 +1083,48 @@ export namespace videointelligence_v1 { */ startTimeOffset?: string; } + /** + * Word-specific information for recognized words. Word information is only + * included in the response when certain request parameters are set, such as + * `enable_word_time_offsets`. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_WordInfo { + /** + * Output only. The confidence estimate between 0.0 and 1.0. A higher number + * indicates an estimated greater likelihood that the recognized words are + * correct. This field is set only for the top alternative. This field is + * not guaranteed to be accurate and users should not rely on it to be + * always provided. The default of 0.0 is a sentinel value indicating + * `confidence` was not set. + */ + confidence?: number; + /** + * Time offset relative to the beginning of the audio, and corresponding to + * the end of the spoken word. This field is only set if + * `enable_word_time_offsets=true` and only in the top hypothesis. This is + * an experimental feature and the accuracy of the time offset can vary. + */ + endTime?: string; + /** + * Output only. A distinct integer value is assigned for every speaker + * within the audio. This field specifies which one of those speakers was + * detected to have spoken this word. Value ranges from 1 up to + * diarization_speaker_count, and is only set if speaker diarization is + * enabled. + */ + speakerTag?: number; + /** + * Time offset relative to the beginning of the audio, and corresponding to + * the start of the spoken word. This field is only set if + * `enable_word_time_offsets=true` and only in the top hypothesis. This is + * an experimental feature and the accuracy of the time offset can vary. + */ + startTime?: string; + /** + * The word corresponding to this set of information. + */ + word?: string; + } /** * Video annotation progress. Included in the `metadata` field of the * `Operation` returned by the `GetOperation` call of the @@ -1100,6 +1334,132 @@ export namespace videointelligence_v1 { */ model?: string; } + /** + * Provides "hints" to the speech recognizer to favor specific words + * and phrases in the results. + */ + export interface Schema$GoogleCloudVideointelligenceV1_SpeechContext { + /** + * *Optional* A list of strings containing words and phrases + * "hints" so that the speech recognition is more likely to + * recognize them. This can be used to improve the accuracy for specific + * words and phrases, for example, if specific commands are typically spoken + * by the user. This can also be used to add additional words to the + * vocabulary of the recognizer. See [usage + * limits](https://cloud.google.com/speech/limits#content). + */ + phrases?: string[]; + } + /** + * Alternative hypotheses (a.k.a. n-best list). + */ + export interface Schema$GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative { + /** + * The confidence estimate between 0.0 and 1.0. A higher number indicates an + * estimated greater likelihood that the recognized words are correct. This + * field is typically provided only for the top hypothesis, and only for + * `is_final=true` results. Clients should not rely on the `confidence` + * field as it is not guaranteed to be accurate or consistent. The default + * of 0.0 is a sentinel value indicating `confidence` was not set. + */ + confidence?: number; + /** + * Transcript text representing the words that the user spoke. + */ + transcript?: string; + /** + * A list of word-specific information for each recognized word. + */ + words?: Schema$GoogleCloudVideointelligenceV1_WordInfo[]; + } + /** + * A speech recognition result corresponding to a portion of the audio. + */ + export interface Schema$GoogleCloudVideointelligenceV1_SpeechTranscription { + /** + * May contain one or more recognition hypotheses (up to the maximum + * specified in `max_alternatives`). These alternatives are ordered in + * terms of accuracy, with the top (first) alternative being the most + * probable, as ranked by the recognizer. + */ + alternatives?: + Schema$GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative[]; + /** + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) + * language tag of the language in this result. This language code was + * detected to have the most likelihood of being spoken in the audio. + */ + languageCode?: string; + } + /** + * Config for SPEECH_TRANSCRIPTION. + */ + export interface Schema$GoogleCloudVideointelligenceV1_SpeechTranscriptionConfig { + /** + * *Optional* For file formats, such as MXF or MKV, supporting multiple + * audio tracks, specify up to two tracks. Default: track 0. + */ + audioTracks?: number[]; + /** + * *Optional* If set, specifies the estimated number of speakers in the + * conversation. If not set, defaults to '2'. Ignored unless + * enable_speaker_diarization is set to true. + */ + diarizationSpeakerCount?: number; + /** + * *Optional* If 'true', adds punctuation to recognition result + * hypotheses. This feature is only available in select languages. Setting + * this for requests in other languages has no effect at all. The default + * 'false' value does not add punctuation to result hypotheses. + * NOTE: "This is currently offered as an experimental service, + * complimentary to all users. In the future this may be exclusively + * available as a premium feature." + */ + enableAutomaticPunctuation?: boolean; + /** + * *Optional* If 'true', enables speaker detection for each + * recognized word in the top alternative of the recognition result using a + * speaker_tag provided in the WordInfo. Note: When this is true, we send + * all the words from the beginning of the audio for the top alternative in + * every consecutive responses. This is done in order to improve our speaker + * tags as our models learn to identify the speakers in the conversation + * over time. + */ + enableSpeakerDiarization?: boolean; + /** + * *Optional* If `true`, the top result includes a list of words and the + * confidence for those words. If `false`, no word-level confidence + * information is returned. The default is `false`. + */ + enableWordConfidence?: boolean; + /** + * *Optional* If set to `true`, the server will attempt to filter out + * profanities, replacing all but the initial character in each filtered + * word with asterisks, e.g. "f***". If set to `false` or omitted, + * profanities won't be filtered out. + */ + filterProfanity?: boolean; + /** + * *Required* The language of the supplied audio as a + * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. + * Example: "en-US". See [Language + * Support](https://cloud.google.com/speech/docs/languages) for a list of + * the currently supported language codes. + */ + languageCode?: string; + /** + * *Optional* Maximum number of recognition hypotheses to be returned. + * Specifically, the maximum number of `SpeechRecognitionAlternative` + * messages within each `SpeechTranscription`. The server may return fewer + * than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` + * will return a maximum of one. If omitted, will return a maximum of one. + */ + maxAlternatives?: number; + /** + * *Optional* A means to provide context to assist the speech recognition. + */ + speechContexts?: Schema$GoogleCloudVideointelligenceV1_SpeechContext[]; + } /** * Annotation progress for a single video. */ @@ -1164,6 +1524,11 @@ export namespace videointelligence_v1 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; + /** + * Speech transcription. + */ + speechTranscriptions?: + Schema$GoogleCloudVideointelligenceV1_SpeechTranscription[]; } /** * Video context and/or feature-specific parameters. @@ -1190,6 +1555,11 @@ export namespace videointelligence_v1 { */ shotChangeDetectionConfig?: Schema$GoogleCloudVideointelligenceV1_ShotChangeDetectionConfig; + /** + * Config for SPEECH_TRANSCRIPTION. + */ + speechTranscriptionConfig?: + Schema$GoogleCloudVideointelligenceV1_SpeechTranscriptionConfig; } /** * Video segment. @@ -1206,6 +1576,48 @@ export namespace videointelligence_v1 { */ startTimeOffset?: string; } + /** + * Word-specific information for recognized words. Word information is only + * included in the response when certain request parameters are set, such as + * `enable_word_time_offsets`. + */ + export interface Schema$GoogleCloudVideointelligenceV1_WordInfo { + /** + * Output only. The confidence estimate between 0.0 and 1.0. A higher number + * indicates an estimated greater likelihood that the recognized words are + * correct. This field is set only for the top alternative. This field is + * not guaranteed to be accurate and users should not rely on it to be + * always provided. The default of 0.0 is a sentinel value indicating + * `confidence` was not set. + */ + confidence?: number; + /** + * Time offset relative to the beginning of the audio, and corresponding to + * the end of the spoken word. This field is only set if + * `enable_word_time_offsets=true` and only in the top hypothesis. This is + * an experimental feature and the accuracy of the time offset can vary. + */ + endTime?: string; + /** + * Output only. A distinct integer value is assigned for every speaker + * within the audio. This field specifies which one of those speakers was + * detected to have spoken this word. Value ranges from 1 up to + * diarization_speaker_count, and is only set if speaker diarization is + * enabled. + */ + speakerTag?: number; + /** + * Time offset relative to the beginning of the audio, and corresponding to + * the start of the spoken word. This field is only set if + * `enable_word_time_offsets=true` and only in the top hypothesis. This is + * an experimental feature and the accuracy of the time offset can vary. + */ + startTime?: string; + /** + * The word corresponding to this set of information. + */ + word?: string; + } /** * The request message for Operations.CancelOperation. */ @@ -1638,7 +2050,8 @@ export namespace videointelligence_v1 { } } - export interface Params$Resource$Operations$Cancel { + export interface Params$Resource$Operations$Cancel extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1654,7 +2067,8 @@ export namespace videointelligence_v1 { */ requestBody?: Schema$GoogleLongrunning_CancelOperationRequest; } - export interface Params$Resource$Operations$Delete { + export interface Params$Resource$Operations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1665,7 +2079,7 @@ export namespace videointelligence_v1 { */ name?: string; } - export interface Params$Resource$Operations$Get { + export interface Params$Resource$Operations$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1676,7 +2090,7 @@ export namespace videointelligence_v1 { */ name?: string; } - export interface Params$Resource$Operations$List { + export interface Params$Resource$Operations$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1788,7 +2202,7 @@ export namespace videointelligence_v1 { } } - export interface Params$Resource$Videos$Annotate { + export interface Params$Resource$Videos$Annotate extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/videointelligence/v1beta2.ts b/src/apis/videointelligence/v1beta2.ts index 335f0124c3..d655e2c426 100644 --- a/src/apis/videointelligence/v1beta2.ts +++ b/src/apis/videointelligence/v1beta2.ts @@ -29,10 +29,62 @@ export namespace videointelligence_v1beta2 { version: 'v1beta2'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Video Intelligence API * - * Cloud Video Intelligence API. + * Detects objects, explicit content, and scene changes in videos. It also + * specifies the region for annotation and transcribes speech to text. * * @example * const {google} = require('googleapis'); @@ -273,6 +325,132 @@ export namespace videointelligence_v1beta2 { */ model?: string; } + /** + * Provides "hints" to the speech recognizer to favor specific words + * and phrases in the results. + */ + export interface Schema$GoogleCloudVideointelligenceV1beta2_SpeechContext { + /** + * *Optional* A list of strings containing words and phrases + * "hints" so that the speech recognition is more likely to + * recognize them. This can be used to improve the accuracy for specific + * words and phrases, for example, if specific commands are typically spoken + * by the user. This can also be used to add additional words to the + * vocabulary of the recognizer. See [usage + * limits](https://cloud.google.com/speech/limits#content). + */ + phrases?: string[]; + } + /** + * Alternative hypotheses (a.k.a. n-best list). + */ + export interface Schema$GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative { + /** + * The confidence estimate between 0.0 and 1.0. A higher number indicates an + * estimated greater likelihood that the recognized words are correct. This + * field is typically provided only for the top hypothesis, and only for + * `is_final=true` results. Clients should not rely on the `confidence` + * field as it is not guaranteed to be accurate or consistent. The default + * of 0.0 is a sentinel value indicating `confidence` was not set. + */ + confidence?: number; + /** + * Transcript text representing the words that the user spoke. + */ + transcript?: string; + /** + * A list of word-specific information for each recognized word. + */ + words?: Schema$GoogleCloudVideointelligenceV1beta2_WordInfo[]; + } + /** + * A speech recognition result corresponding to a portion of the audio. + */ + export interface Schema$GoogleCloudVideointelligenceV1beta2_SpeechTranscription { + /** + * May contain one or more recognition hypotheses (up to the maximum + * specified in `max_alternatives`). These alternatives are ordered in + * terms of accuracy, with the top (first) alternative being the most + * probable, as ranked by the recognizer. + */ + alternatives?: + Schema$GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative[]; + /** + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) + * language tag of the language in this result. This language code was + * detected to have the most likelihood of being spoken in the audio. + */ + languageCode?: string; + } + /** + * Config for SPEECH_TRANSCRIPTION. + */ + export interface Schema$GoogleCloudVideointelligenceV1beta2_SpeechTranscriptionConfig { + /** + * *Optional* For file formats, such as MXF or MKV, supporting multiple + * audio tracks, specify up to two tracks. Default: track 0. + */ + audioTracks?: number[]; + /** + * *Optional* If set, specifies the estimated number of speakers in the + * conversation. If not set, defaults to '2'. Ignored unless + * enable_speaker_diarization is set to true. + */ + diarizationSpeakerCount?: number; + /** + * *Optional* If 'true', adds punctuation to recognition result + * hypotheses. This feature is only available in select languages. Setting + * this for requests in other languages has no effect at all. The default + * 'false' value does not add punctuation to result hypotheses. + * NOTE: "This is currently offered as an experimental service, + * complimentary to all users. In the future this may be exclusively + * available as a premium feature." + */ + enableAutomaticPunctuation?: boolean; + /** + * *Optional* If 'true', enables speaker detection for each + * recognized word in the top alternative of the recognition result using a + * speaker_tag provided in the WordInfo. Note: When this is true, we send + * all the words from the beginning of the audio for the top alternative in + * every consecutive responses. This is done in order to improve our speaker + * tags as our models learn to identify the speakers in the conversation + * over time. + */ + enableSpeakerDiarization?: boolean; + /** + * *Optional* If `true`, the top result includes a list of words and the + * confidence for those words. If `false`, no word-level confidence + * information is returned. The default is `false`. + */ + enableWordConfidence?: boolean; + /** + * *Optional* If set to `true`, the server will attempt to filter out + * profanities, replacing all but the initial character in each filtered + * word with asterisks, e.g. "f***". If set to `false` or omitted, + * profanities won't be filtered out. + */ + filterProfanity?: boolean; + /** + * *Required* The language of the supplied audio as a + * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. + * Example: "en-US". See [Language + * Support](https://cloud.google.com/speech/docs/languages) for a list of + * the currently supported language codes. + */ + languageCode?: string; + /** + * *Optional* Maximum number of recognition hypotheses to be returned. + * Specifically, the maximum number of `SpeechRecognitionAlternative` + * messages within each `SpeechTranscription`. The server may return fewer + * than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` + * will return a maximum of one. If omitted, will return a maximum of one. + */ + maxAlternatives?: number; + /** + * *Optional* A means to provide context to assist the speech recognition. + */ + speechContexts?: Schema$GoogleCloudVideointelligenceV1beta2_SpeechContext[]; + } /** * Annotation progress for a single video. */ @@ -337,6 +515,11 @@ export namespace videointelligence_v1beta2 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; + /** + * Speech transcription. + */ + speechTranscriptions?: + Schema$GoogleCloudVideointelligenceV1beta2_SpeechTranscription[]; } /** * Video context and/or feature-specific parameters. @@ -363,6 +546,11 @@ export namespace videointelligence_v1beta2 { */ shotChangeDetectionConfig?: Schema$GoogleCloudVideointelligenceV1beta2_ShotChangeDetectionConfig; + /** + * Config for SPEECH_TRANSCRIPTION. + */ + speechTranscriptionConfig?: + Schema$GoogleCloudVideointelligenceV1beta2_SpeechTranscriptionConfig; } /** * Video segment. @@ -379,6 +567,48 @@ export namespace videointelligence_v1beta2 { */ startTimeOffset?: string; } + /** + * Word-specific information for recognized words. Word information is only + * included in the response when certain request parameters are set, such as + * `enable_word_time_offsets`. + */ + export interface Schema$GoogleCloudVideointelligenceV1beta2_WordInfo { + /** + * Output only. The confidence estimate between 0.0 and 1.0. A higher number + * indicates an estimated greater likelihood that the recognized words are + * correct. This field is set only for the top alternative. This field is + * not guaranteed to be accurate and users should not rely on it to be + * always provided. The default of 0.0 is a sentinel value indicating + * `confidence` was not set. + */ + confidence?: number; + /** + * Time offset relative to the beginning of the audio, and corresponding to + * the end of the spoken word. This field is only set if + * `enable_word_time_offsets=true` and only in the top hypothesis. This is + * an experimental feature and the accuracy of the time offset can vary. + */ + endTime?: string; + /** + * Output only. A distinct integer value is assigned for every speaker + * within the audio. This field specifies which one of those speakers was + * detected to have spoken this word. Value ranges from 1 up to + * diarization_speaker_count, and is only set if speaker diarization is + * enabled. + */ + speakerTag?: number; + /** + * Time offset relative to the beginning of the audio, and corresponding to + * the start of the spoken word. This field is only set if + * `enable_word_time_offsets=true` and only in the top hypothesis. This is + * an experimental feature and the accuracy of the time offset can vary. + */ + startTime?: string; + /** + * The word corresponding to this set of information. + */ + word?: string; + } /** * Video annotation progress. Included in the `metadata` field of the * `Operation` returned by the `GetOperation` call of the @@ -531,6 +761,12 @@ export namespace videointelligence_v1beta2 { */ alternatives?: Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechRecognitionAlternative[]; + /** + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) + * language tag of the language in this result. This language code was + * detected to have the most likelihood of being spoken in the audio. + */ + languageCode?: string; } /** * Annotation progress for a single video. @@ -867,20 +1103,52 @@ export namespace videointelligence_v1beta2 { timeOffset?: string; } /** - * Annotations related to one detected OCR text snippet. This will contain the - * corresponding text, confidence value, and frame level information for each - * detection. + * Alternative hypotheses (a.k.a. n-best list). */ - export interface Schema$GoogleCloudVideointelligenceV1p2beta1_TextAnnotation { + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative { /** - * Confidence for the track of detected text. It is calculated as the - * highest over all frames where OCR detected text appears. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an + * estimated greater likelihood that the recognized words are correct. This + * field is typically provided only for the top hypothesis, and only for + * `is_final=true` results. Clients should not rely on the `confidence` + * field as it is not guaranteed to be accurate or consistent. The default + * of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** - * Information related to the frames where OCR detected text appears. + * Transcript text representing the words that the user spoke. */ - frames?: Schema$GoogleCloudVideointelligenceV1p2beta1_TextFrame[]; + transcript?: string; + /** + * A list of word-specific information for each recognized word. + */ + words?: Schema$GoogleCloudVideointelligenceV1p2beta1_WordInfo[]; + } + /** + * A speech recognition result corresponding to a portion of the audio. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechTranscription { + /** + * May contain one or more recognition hypotheses (up to the maximum + * specified in `max_alternatives`). These alternatives are ordered in + * terms of accuracy, with the top (first) alternative being the most + * probable, as ranked by the recognizer. + */ + alternatives?: + Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative[]; + /** + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) + * language tag of the language in this result. This language code was + * detected to have the most likelihood of being spoken in the audio. + */ + languageCode?: string; + } + /** + * Annotations related to one detected OCR text snippet. This will contain the + * corresponding text, confidence value, and frame level information for each + * detection. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_TextAnnotation { /** * All video segments where OCR detected text appears. */ @@ -910,6 +1178,15 @@ export namespace videointelligence_v1beta2 { * Video segment level annotation results for text detection. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_TextSegment { + /** + * Confidence for the track of detected text. It is calculated as the + * highest over all frames where OCR detected text appears. + */ + confidence?: number; + /** + * Information related to the frames where OCR detected text appears. + */ + frames?: Schema$GoogleCloudVideointelligenceV1p2beta1_TextFrame[]; /** * Video segment where a text snippet was detected. */ @@ -985,6 +1262,11 @@ export namespace videointelligence_v1beta2 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; + /** + * Speech transcription. + */ + speechTranscriptions?: + Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechTranscription[]; /** * OCR text detection and tracking. Annotations for list of detected text * snippets. Each will have list of frame information associated with it. @@ -1007,6 +1289,48 @@ export namespace videointelligence_v1beta2 { */ startTimeOffset?: string; } + /** + * Word-specific information for recognized words. Word information is only + * included in the response when certain request parameters are set, such as + * `enable_word_time_offsets`. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_WordInfo { + /** + * Output only. The confidence estimate between 0.0 and 1.0. A higher number + * indicates an estimated greater likelihood that the recognized words are + * correct. This field is set only for the top alternative. This field is + * not guaranteed to be accurate and users should not rely on it to be + * always provided. The default of 0.0 is a sentinel value indicating + * `confidence` was not set. + */ + confidence?: number; + /** + * Time offset relative to the beginning of the audio, and corresponding to + * the end of the spoken word. This field is only set if + * `enable_word_time_offsets=true` and only in the top hypothesis. This is + * an experimental feature and the accuracy of the time offset can vary. + */ + endTime?: string; + /** + * Output only. A distinct integer value is assigned for every speaker + * within the audio. This field specifies which one of those speakers was + * detected to have spoken this word. Value ranges from 1 up to + * diarization_speaker_count, and is only set if speaker diarization is + * enabled. + */ + speakerTag?: number; + /** + * Time offset relative to the beginning of the audio, and corresponding to + * the start of the spoken word. This field is only set if + * `enable_word_time_offsets=true` and only in the top hypothesis. This is + * an experimental feature and the accuracy of the time offset can vary. + */ + startTime?: string; + /** + * The word corresponding to this set of information. + */ + word?: string; + } /** * Video annotation progress. Included in the `metadata` field of the * `Operation` returned by the `GetOperation` call of the @@ -1124,6 +1448,47 @@ export namespace videointelligence_v1beta2 { */ segment?: Schema$GoogleCloudVideointelligenceV1_VideoSegment; } + /** + * Alternative hypotheses (a.k.a. n-best list). + */ + export interface Schema$GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative { + /** + * The confidence estimate between 0.0 and 1.0. A higher number indicates an + * estimated greater likelihood that the recognized words are correct. This + * field is typically provided only for the top hypothesis, and only for + * `is_final=true` results. Clients should not rely on the `confidence` + * field as it is not guaranteed to be accurate or consistent. The default + * of 0.0 is a sentinel value indicating `confidence` was not set. + */ + confidence?: number; + /** + * Transcript text representing the words that the user spoke. + */ + transcript?: string; + /** + * A list of word-specific information for each recognized word. + */ + words?: Schema$GoogleCloudVideointelligenceV1_WordInfo[]; + } + /** + * A speech recognition result corresponding to a portion of the audio. + */ + export interface Schema$GoogleCloudVideointelligenceV1_SpeechTranscription { + /** + * May contain one or more recognition hypotheses (up to the maximum + * specified in `max_alternatives`). These alternatives are ordered in + * terms of accuracy, with the top (first) alternative being the most + * probable, as ranked by the recognizer. + */ + alternatives?: + Schema$GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative[]; + /** + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) + * language tag of the language in this result. This language code was + * detected to have the most likelihood of being spoken in the audio. + */ + languageCode?: string; + } /** * Annotation progress for a single video. */ @@ -1188,6 +1553,11 @@ export namespace videointelligence_v1beta2 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; + /** + * Speech transcription. + */ + speechTranscriptions?: + Schema$GoogleCloudVideointelligenceV1_SpeechTranscription[]; } /** * Video segment. @@ -1204,6 +1574,48 @@ export namespace videointelligence_v1beta2 { */ startTimeOffset?: string; } + /** + * Word-specific information for recognized words. Word information is only + * included in the response when certain request parameters are set, such as + * `enable_word_time_offsets`. + */ + export interface Schema$GoogleCloudVideointelligenceV1_WordInfo { + /** + * Output only. The confidence estimate between 0.0 and 1.0. A higher number + * indicates an estimated greater likelihood that the recognized words are + * correct. This field is set only for the top alternative. This field is + * not guaranteed to be accurate and users should not rely on it to be + * always provided. The default of 0.0 is a sentinel value indicating + * `confidence` was not set. + */ + confidence?: number; + /** + * Time offset relative to the beginning of the audio, and corresponding to + * the end of the spoken word. This field is only set if + * `enable_word_time_offsets=true` and only in the top hypothesis. This is + * an experimental feature and the accuracy of the time offset can vary. + */ + endTime?: string; + /** + * Output only. A distinct integer value is assigned for every speaker + * within the audio. This field specifies which one of those speakers was + * detected to have spoken this word. Value ranges from 1 up to + * diarization_speaker_count, and is only set if speaker diarization is + * enabled. + */ + speakerTag?: number; + /** + * Time offset relative to the beginning of the audio, and corresponding to + * the start of the spoken word. This field is only set if + * `enable_word_time_offsets=true` and only in the top hypothesis. This is + * an experimental feature and the accuracy of the time offset can vary. + */ + startTime?: string; + /** + * The word corresponding to this set of information. + */ + word?: string; + } /** * This resource represents a long-running operation that is the result of a * network API call. @@ -1385,7 +1797,7 @@ export namespace videointelligence_v1beta2 { } } - export interface Params$Resource$Videos$Annotate { + export interface Params$Resource$Videos$Annotate extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/videointelligence/v1p1beta1.ts b/src/apis/videointelligence/v1p1beta1.ts index c6fba01a40..7a1d1e9902 100644 --- a/src/apis/videointelligence/v1p1beta1.ts +++ b/src/apis/videointelligence/v1p1beta1.ts @@ -29,10 +29,62 @@ export namespace videointelligence_v1p1beta1 { version: 'v1p1beta1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Video Intelligence API * - * Cloud Video Intelligence API. + * Detects objects, explicit content, and scene changes in videos. It also + * specifies the region for annotation and transcribes speech to text. * * @example * const {google} = require('googleapis'); @@ -181,6 +233,47 @@ export namespace videointelligence_v1p1beta1 { */ segment?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment; } + /** + * Alternative hypotheses (a.k.a. n-best list). + */ + export interface Schema$GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative { + /** + * The confidence estimate between 0.0 and 1.0. A higher number indicates an + * estimated greater likelihood that the recognized words are correct. This + * field is typically provided only for the top hypothesis, and only for + * `is_final=true` results. Clients should not rely on the `confidence` + * field as it is not guaranteed to be accurate or consistent. The default + * of 0.0 is a sentinel value indicating `confidence` was not set. + */ + confidence?: number; + /** + * Transcript text representing the words that the user spoke. + */ + transcript?: string; + /** + * A list of word-specific information for each recognized word. + */ + words?: Schema$GoogleCloudVideointelligenceV1beta2_WordInfo[]; + } + /** + * A speech recognition result corresponding to a portion of the audio. + */ + export interface Schema$GoogleCloudVideointelligenceV1beta2_SpeechTranscription { + /** + * May contain one or more recognition hypotheses (up to the maximum + * specified in `max_alternatives`). These alternatives are ordered in + * terms of accuracy, with the top (first) alternative being the most + * probable, as ranked by the recognizer. + */ + alternatives?: + Schema$GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative[]; + /** + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) + * language tag of the language in this result. This language code was + * detected to have the most likelihood of being spoken in the audio. + */ + languageCode?: string; + } /** * Annotation progress for a single video. */ @@ -245,6 +338,11 @@ export namespace videointelligence_v1p1beta1 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; + /** + * Speech transcription. + */ + speechTranscriptions?: + Schema$GoogleCloudVideointelligenceV1beta2_SpeechTranscription[]; } /** * Video segment. @@ -261,6 +359,48 @@ export namespace videointelligence_v1p1beta1 { */ startTimeOffset?: string; } + /** + * Word-specific information for recognized words. Word information is only + * included in the response when certain request parameters are set, such as + * `enable_word_time_offsets`. + */ + export interface Schema$GoogleCloudVideointelligenceV1beta2_WordInfo { + /** + * Output only. The confidence estimate between 0.0 and 1.0. A higher number + * indicates an estimated greater likelihood that the recognized words are + * correct. This field is set only for the top alternative. This field is + * not guaranteed to be accurate and users should not rely on it to be + * always provided. The default of 0.0 is a sentinel value indicating + * `confidence` was not set. + */ + confidence?: number; + /** + * Time offset relative to the beginning of the audio, and corresponding to + * the end of the spoken word. This field is only set if + * `enable_word_time_offsets=true` and only in the top hypothesis. This is + * an experimental feature and the accuracy of the time offset can vary. + */ + endTime?: string; + /** + * Output only. A distinct integer value is assigned for every speaker + * within the audio. This field specifies which one of those speakers was + * detected to have spoken this word. Value ranges from 1 up to + * diarization_speaker_count, and is only set if speaker diarization is + * enabled. + */ + speakerTag?: number; + /** + * Time offset relative to the beginning of the audio, and corresponding to + * the start of the spoken word. This field is only set if + * `enable_word_time_offsets=true` and only in the top hypothesis. This is + * an experimental feature and the accuracy of the time offset can vary. + */ + startTime?: string; + /** + * The word corresponding to this set of information. + */ + word?: string; + } /** * Video annotation progress. Included in the `metadata` field of the * `Operation` returned by the `GetOperation` call of the @@ -521,6 +661,12 @@ export namespace videointelligence_v1p1beta1 { */ alternatives?: Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechRecognitionAlternative[]; + /** + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) + * language tag of the language in this result. This language code was + * detected to have the most likelihood of being spoken in the audio. + */ + languageCode?: string; } /** * Config for SPEECH_TRANSCRIPTION. @@ -581,10 +727,9 @@ export namespace videointelligence_v1p1beta1 { /** * *Optional* Maximum number of recognition hypotheses to be returned. * Specifically, the maximum number of `SpeechRecognitionAlternative` - * messages within each `SpeechRecognitionResult`. The server may return - * fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` - * or `1` will return a maximum of one. If omitted, will return a maximum of - * one. + * messages within each `SpeechTranscription`. The server may return fewer + * than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` + * will return a maximum of one. If omitted, will return a maximum of one. */ maxAlternatives?: number; /** @@ -959,20 +1104,52 @@ export namespace videointelligence_v1p1beta1 { timeOffset?: string; } /** - * Annotations related to one detected OCR text snippet. This will contain the - * corresponding text, confidence value, and frame level information for each - * detection. + * Alternative hypotheses (a.k.a. n-best list). */ - export interface Schema$GoogleCloudVideointelligenceV1p2beta1_TextAnnotation { + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative { /** - * Confidence for the track of detected text. It is calculated as the - * highest over all frames where OCR detected text appears. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an + * estimated greater likelihood that the recognized words are correct. This + * field is typically provided only for the top hypothesis, and only for + * `is_final=true` results. Clients should not rely on the `confidence` + * field as it is not guaranteed to be accurate or consistent. The default + * of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** - * Information related to the frames where OCR detected text appears. + * Transcript text representing the words that the user spoke. */ - frames?: Schema$GoogleCloudVideointelligenceV1p2beta1_TextFrame[]; + transcript?: string; + /** + * A list of word-specific information for each recognized word. + */ + words?: Schema$GoogleCloudVideointelligenceV1p2beta1_WordInfo[]; + } + /** + * A speech recognition result corresponding to a portion of the audio. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechTranscription { + /** + * May contain one or more recognition hypotheses (up to the maximum + * specified in `max_alternatives`). These alternatives are ordered in + * terms of accuracy, with the top (first) alternative being the most + * probable, as ranked by the recognizer. + */ + alternatives?: + Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative[]; + /** + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) + * language tag of the language in this result. This language code was + * detected to have the most likelihood of being spoken in the audio. + */ + languageCode?: string; + } + /** + * Annotations related to one detected OCR text snippet. This will contain the + * corresponding text, confidence value, and frame level information for each + * detection. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_TextAnnotation { /** * All video segments where OCR detected text appears. */ @@ -1002,6 +1179,15 @@ export namespace videointelligence_v1p1beta1 { * Video segment level annotation results for text detection. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_TextSegment { + /** + * Confidence for the track of detected text. It is calculated as the + * highest over all frames where OCR detected text appears. + */ + confidence?: number; + /** + * Information related to the frames where OCR detected text appears. + */ + frames?: Schema$GoogleCloudVideointelligenceV1p2beta1_TextFrame[]; /** * Video segment where a text snippet was detected. */ @@ -1077,6 +1263,11 @@ export namespace videointelligence_v1p1beta1 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; + /** + * Speech transcription. + */ + speechTranscriptions?: + Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechTranscription[]; /** * OCR text detection and tracking. Annotations for list of detected text * snippets. Each will have list of frame information associated with it. @@ -1099,6 +1290,48 @@ export namespace videointelligence_v1p1beta1 { */ startTimeOffset?: string; } + /** + * Word-specific information for recognized words. Word information is only + * included in the response when certain request parameters are set, such as + * `enable_word_time_offsets`. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_WordInfo { + /** + * Output only. The confidence estimate between 0.0 and 1.0. A higher number + * indicates an estimated greater likelihood that the recognized words are + * correct. This field is set only for the top alternative. This field is + * not guaranteed to be accurate and users should not rely on it to be + * always provided. The default of 0.0 is a sentinel value indicating + * `confidence` was not set. + */ + confidence?: number; + /** + * Time offset relative to the beginning of the audio, and corresponding to + * the end of the spoken word. This field is only set if + * `enable_word_time_offsets=true` and only in the top hypothesis. This is + * an experimental feature and the accuracy of the time offset can vary. + */ + endTime?: string; + /** + * Output only. A distinct integer value is assigned for every speaker + * within the audio. This field specifies which one of those speakers was + * detected to have spoken this word. Value ranges from 1 up to + * diarization_speaker_count, and is only set if speaker diarization is + * enabled. + */ + speakerTag?: number; + /** + * Time offset relative to the beginning of the audio, and corresponding to + * the start of the spoken word. This field is only set if + * `enable_word_time_offsets=true` and only in the top hypothesis. This is + * an experimental feature and the accuracy of the time offset can vary. + */ + startTime?: string; + /** + * The word corresponding to this set of information. + */ + word?: string; + } /** * Video annotation progress. Included in the `metadata` field of the * `Operation` returned by the `GetOperation` call of the @@ -1216,6 +1449,47 @@ export namespace videointelligence_v1p1beta1 { */ segment?: Schema$GoogleCloudVideointelligenceV1_VideoSegment; } + /** + * Alternative hypotheses (a.k.a. n-best list). + */ + export interface Schema$GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative { + /** + * The confidence estimate between 0.0 and 1.0. A higher number indicates an + * estimated greater likelihood that the recognized words are correct. This + * field is typically provided only for the top hypothesis, and only for + * `is_final=true` results. Clients should not rely on the `confidence` + * field as it is not guaranteed to be accurate or consistent. The default + * of 0.0 is a sentinel value indicating `confidence` was not set. + */ + confidence?: number; + /** + * Transcript text representing the words that the user spoke. + */ + transcript?: string; + /** + * A list of word-specific information for each recognized word. + */ + words?: Schema$GoogleCloudVideointelligenceV1_WordInfo[]; + } + /** + * A speech recognition result corresponding to a portion of the audio. + */ + export interface Schema$GoogleCloudVideointelligenceV1_SpeechTranscription { + /** + * May contain one or more recognition hypotheses (up to the maximum + * specified in `max_alternatives`). These alternatives are ordered in + * terms of accuracy, with the top (first) alternative being the most + * probable, as ranked by the recognizer. + */ + alternatives?: + Schema$GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative[]; + /** + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) + * language tag of the language in this result. This language code was + * detected to have the most likelihood of being spoken in the audio. + */ + languageCode?: string; + } /** * Annotation progress for a single video. */ @@ -1280,6 +1554,11 @@ export namespace videointelligence_v1p1beta1 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; + /** + * Speech transcription. + */ + speechTranscriptions?: + Schema$GoogleCloudVideointelligenceV1_SpeechTranscription[]; } /** * Video segment. @@ -1296,6 +1575,48 @@ export namespace videointelligence_v1p1beta1 { */ startTimeOffset?: string; } + /** + * Word-specific information for recognized words. Word information is only + * included in the response when certain request parameters are set, such as + * `enable_word_time_offsets`. + */ + export interface Schema$GoogleCloudVideointelligenceV1_WordInfo { + /** + * Output only. The confidence estimate between 0.0 and 1.0. A higher number + * indicates an estimated greater likelihood that the recognized words are + * correct. This field is set only for the top alternative. This field is + * not guaranteed to be accurate and users should not rely on it to be + * always provided. The default of 0.0 is a sentinel value indicating + * `confidence` was not set. + */ + confidence?: number; + /** + * Time offset relative to the beginning of the audio, and corresponding to + * the end of the spoken word. This field is only set if + * `enable_word_time_offsets=true` and only in the top hypothesis. This is + * an experimental feature and the accuracy of the time offset can vary. + */ + endTime?: string; + /** + * Output only. A distinct integer value is assigned for every speaker + * within the audio. This field specifies which one of those speakers was + * detected to have spoken this word. Value ranges from 1 up to + * diarization_speaker_count, and is only set if speaker diarization is + * enabled. + */ + speakerTag?: number; + /** + * Time offset relative to the beginning of the audio, and corresponding to + * the start of the spoken word. This field is only set if + * `enable_word_time_offsets=true` and only in the top hypothesis. This is + * an experimental feature and the accuracy of the time offset can vary. + */ + startTime?: string; + /** + * The word corresponding to this set of information. + */ + word?: string; + } /** * This resource represents a long-running operation that is the result of a * network API call. @@ -1477,7 +1798,7 @@ export namespace videointelligence_v1p1beta1 { } } - export interface Params$Resource$Videos$Annotate { + export interface Params$Resource$Videos$Annotate extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/vision/v1.ts b/src/apis/vision/v1.ts index 040a63d974..93577b438c 100644 --- a/src/apis/vision/v1.ts +++ b/src/apis/vision/v1.ts @@ -29,6 +29,57 @@ export namespace vision_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Vision API * @@ -55,6 +106,7 @@ export namespace vision_v1 { images: Resource$Images; locations: Resource$Locations; operations: Resource$Operations; + projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { this._options = options || {}; @@ -65,6 +117,7 @@ export namespace vision_v1 { this.images = new Resource$Images(this); this.locations = new Resource$Locations(this); this.operations = new Resource$Operations(this); + this.projects = new Resource$Projects(this); } getRoot() { @@ -72,6 +125,16 @@ export namespace vision_v1 { } } + /** + * Request message for the `AddProductToProductSet` method. + */ + export interface Schema$AddProductToProductSetRequest { + /** + * The resource name for the Product to be added to this ProductSet. Format + * is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + */ + product?: string; + } /** * Response to a single file annotation request. A file may contain one or * more images, which individually have their own responses. @@ -154,6 +217,10 @@ export namespace vision_v1 { * If present, logo detection has completed successfully. */ logoAnnotations?: Schema$EntityAnnotation[]; + /** + * If present, product search has completed successfully. + */ + productSearchResults?: Schema$ProductSearchResults; /** * If present, safe-search annotation has completed successfully. */ @@ -235,6 +302,26 @@ export namespace vision_v1 { */ responses?: Schema$AnnotateImageResponse[]; } + /** + * Metadata for the batch operations such as the current state. This is + * included in the `metadata` field of the `Operation` returned by the + * `GetOperation` call of the `google::longrunning::Operations` service. + */ + export interface Schema$BatchOperationMetadata { + /** + * The time when the batch request is finished and + * google.longrunning.Operation.done is set to true. + */ + endTime?: string; + /** + * The current state of the batch operation. + */ + state?: string; + /** + * The time when the batch request was submitted to the server. + */ + submitTime?: string; + } /** * Logical element on the page. */ @@ -724,6 +811,11 @@ export namespace vision_v1 { * If present, logo detection has completed successfully. */ logoAnnotations?: Schema$GoogleCloudVisionV1p1beta1EntityAnnotation[]; + /** + * If present, product search has completed successfully. + */ + productSearchResults?: + Schema$GoogleCloudVisionV1p1beta1ProductSearchResults; /** * If present, safe-search annotation has completed successfully. */ @@ -1218,6 +1310,112 @@ export namespace vision_v1 { */ z?: number; } + /** + * A Product contains ReferenceImages. + */ + export interface Schema$GoogleCloudVisionV1p1beta1Product { + /** + * User-provided metadata to be stored with this product. Must be at most + * 4096 characters long. + */ + description?: string; + /** + * The user-provided name for this Product. Must not be empty. Must be at + * most 4096 characters long. + */ + displayName?: string; + /** + * The resource name of the product. Format is: + * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field + * is ignored when creating a product. + */ + name?: string; + /** + * The category for the product identified by the reference image. This + * should be either "homegoods", "apparel", or + * "toys". This field is immutable. + */ + productCategory?: string; + /** + * Key-value pairs that can be attached to a product. At query time, + * constraints can be specified based on the product_labels. Note that + * integer values can be provided as strings, e.g. "1199". Only + * strings with integer values can match a range-based restriction which is + * to be supported soon. Multiple values can be assigned to the same key. + * One product may have up to 100 product_labels. + */ + productLabels?: Schema$GoogleCloudVisionV1p1beta1ProductKeyValue[]; + } + /** + * A product label represented as a key-value pair. + */ + export interface Schema$GoogleCloudVisionV1p1beta1ProductKeyValue { + /** + * The key of the label attached to the product. Cannot be empty and cannot + * exceed 128 bytes. + */ + key?: string; + /** + * The value of the label attached to the product. Cannot be empty and + * cannot exceed 128 bytes. + */ + value?: string; + } + /** + * Results for a product search request. + */ + export interface Schema$GoogleCloudVisionV1p1beta1ProductSearchResults { + /** + * Timestamp of the index which provided these results. Changes made after + * this time are not reflected in the current results. + */ + indexTime?: string; + /** + * List of results grouped by products detected in the query image. Each + * entry corresponds to one bounding polygon in the query image, and + * contains the matching products specific to that region. There may be + * duplicate product matches in the union of all the per-product results. + */ + productGroupedResults?: + Schema$GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult[]; + /** + * List of results, one for each product match. + */ + results?: Schema$GoogleCloudVisionV1p1beta1ProductSearchResultsResult[]; + } + /** + * Information about the products similar to a single product in a query + * image. + */ + export interface Schema$GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult { + /** + * The bounding polygon around the product detected in the query image. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; + /** + * List of results, one for each product match. + */ + results?: Schema$GoogleCloudVisionV1p1beta1ProductSearchResultsResult[]; + } + /** + * Information about a product. + */ + export interface Schema$GoogleCloudVisionV1p1beta1ProductSearchResultsResult { + /** + * The resource name of the image from the product that is the closest match + * to the query. + */ + image?: string; + /** + * The Product. + */ + product?: Schema$GoogleCloudVisionV1p1beta1Product; + /** + * A confidence level on the match, ranging from 0 (no confidence) to 1 + * (full confidence). + */ + score?: number; + } /** * A `Property` consists of a user-supplied name/value pair. */ @@ -1580,6 +1778,11 @@ export namespace vision_v1 { * If present, logo detection has completed successfully. */ logoAnnotations?: Schema$GoogleCloudVisionV1p2beta1EntityAnnotation[]; + /** + * If present, product search has completed successfully. + */ + productSearchResults?: + Schema$GoogleCloudVisionV1p2beta1ProductSearchResults; /** * If present, safe-search annotation has completed successfully. */ @@ -2092,6 +2295,112 @@ export namespace vision_v1 { */ z?: number; } + /** + * A Product contains ReferenceImages. + */ + export interface Schema$GoogleCloudVisionV1p2beta1Product { + /** + * User-provided metadata to be stored with this product. Must be at most + * 4096 characters long. + */ + description?: string; + /** + * The user-provided name for this Product. Must not be empty. Must be at + * most 4096 characters long. + */ + displayName?: string; + /** + * The resource name of the product. Format is: + * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field + * is ignored when creating a product. + */ + name?: string; + /** + * The category for the product identified by the reference image. This + * should be either "homegoods", "apparel", or + * "toys". This field is immutable. + */ + productCategory?: string; + /** + * Key-value pairs that can be attached to a product. At query time, + * constraints can be specified based on the product_labels. Note that + * integer values can be provided as strings, e.g. "1199". Only + * strings with integer values can match a range-based restriction which is + * to be supported soon. Multiple values can be assigned to the same key. + * One product may have up to 100 product_labels. + */ + productLabels?: Schema$GoogleCloudVisionV1p2beta1ProductKeyValue[]; + } + /** + * A product label represented as a key-value pair. + */ + export interface Schema$GoogleCloudVisionV1p2beta1ProductKeyValue { + /** + * The key of the label attached to the product. Cannot be empty and cannot + * exceed 128 bytes. + */ + key?: string; + /** + * The value of the label attached to the product. Cannot be empty and + * cannot exceed 128 bytes. + */ + value?: string; + } + /** + * Results for a product search request. + */ + export interface Schema$GoogleCloudVisionV1p2beta1ProductSearchResults { + /** + * Timestamp of the index which provided these results. Changes made after + * this time are not reflected in the current results. + */ + indexTime?: string; + /** + * List of results grouped by products detected in the query image. Each + * entry corresponds to one bounding polygon in the query image, and + * contains the matching products specific to that region. There may be + * duplicate product matches in the union of all the per-product results. + */ + productGroupedResults?: + Schema$GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult[]; + /** + * List of results, one for each product match. + */ + results?: Schema$GoogleCloudVisionV1p2beta1ProductSearchResultsResult[]; + } + /** + * Information about the products similar to a single product in a query + * image. + */ + export interface Schema$GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult { + /** + * The bounding polygon around the product detected in the query image. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; + /** + * List of results, one for each product match. + */ + results?: Schema$GoogleCloudVisionV1p2beta1ProductSearchResultsResult[]; + } + /** + * Information about a product. + */ + export interface Schema$GoogleCloudVisionV1p2beta1ProductSearchResultsResult { + /** + * The resource name of the image from the product that is the closest match + * to the query. + */ + image?: string; + /** + * The Product. + */ + product?: Schema$GoogleCloudVisionV1p2beta1Product; + /** + * A confidence level on the match, ranging from 0 (no confidence) to 1 + * (full confidence). + */ + score?: number; + } /** * A `Property` consists of a user-supplied name/value pair. */ @@ -3069,6 +3378,28 @@ export namespace vision_v1 { * this time are not reflected in the current results. */ indexTime?: string; + /** + * List of results grouped by products detected in the query image. Each + * entry corresponds to one bounding polygon in the query image, and + * contains the matching products specific to that region. There may be + * duplicate product matches in the union of all the per-product results. + */ + productGroupedResults?: + Schema$GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult[]; + /** + * List of results, one for each product match. + */ + results?: Schema$GoogleCloudVisionV1p3beta1ProductSearchResultsResult[]; + } + /** + * Information about the products similar to a single product in a query + * image. + */ + export interface Schema$GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult { + /** + * The bounding polygon around the product detected in the query image. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** * List of results, one for each product match. */ @@ -3416,17 +3747,31 @@ export namespace vision_v1 { symbols?: Schema$GoogleCloudVisionV1p3beta1Symbol[]; } /** - * Client image to perform Google Cloud Vision API tasks over. + * Information about the products similar to a single product in a query + * image. */ - export interface Schema$Image { + export interface Schema$GroupedResult { /** - * Image content, represented as a stream of bytes. Note: As with all - * `bytes` fields, protobuffers use a pure binary representation, whereas - * JSON representations use base64. + * The bounding polygon around the product detected in the query image. */ - content?: string; + boundingPoly?: Schema$BoundingPoly; /** - * Google Cloud Storage image location, or publicly-accessible image URL. If + * List of results, one for each product match. + */ + results?: Schema$Result[]; + } + /** + * Client image to perform Google Cloud Vision API tasks over. + */ + export interface Schema$Image { + /** + * Image content, represented as a stream of bytes. Note: As with all + * `bytes` fields, protobuffers use a pure binary representation, whereas + * JSON representations use base64. + */ + content?: string; + /** + * Google Cloud Storage image location, or publicly-accessible image URL. If * both `content` and `source` are provided for an image, `content` takes * precedence and is used to perform the image annotation request. */ @@ -3470,6 +3815,10 @@ export namespace vision_v1 { * Not used. */ latLongRect?: Schema$LatLongRect; + /** + * Parameters for product search. + */ + productSearchParams?: Schema$ProductSearchParams; /** * Parameters for web detection. */ @@ -3512,6 +3861,86 @@ export namespace vision_v1 { */ imageUri?: string; } + /** + * The Google Cloud Storage location for a csv file which preserves a list of + * ImportProductSetRequests in each line. + */ + export interface Schema$ImportProductSetsGcsSource { + /** + * The Google Cloud Storage URI of the input csv file. The URI must start + * with `gs://`. The format of the input csv file should be one image per + * line. In each line, there are 8 columns. 1. image-uri 2. image-id 3. + * product-set-id 4. product-id 5. product-category 6. + * product-display-name 7. labels 8. bounding-poly The `image-uri`, + * `product-set-id`, `product-id`, and `product-category` columns are + * required. All other columns are optional. If the `ProductSet` or + * `Product` specified by the `product-set-id` and `product-id` values does + * not exist, then the system will create a new `ProductSet` or `Product` + * for the image. In this case, the `product-display-name` column refers to + * display_name, the `product-category` column refers to product_category, + * and the `labels` column refers to product_labels. The `image-id` column + * is optional but must be unique if provided. If it is empty, the system + * will automatically assign a unique id to the image. The + * `product-display-name` column is optional. If it is empty, the system + * sets the display_name field for the product to a space (" "). + * You can update the `display_name` later by using the API. If a `Product` + * with the specified `product-id` already exists, then the system ignores + * the `product-display-name`, `product-category`, and `labels` columns. The + * `labels` column (optional) is a line containing a list of comma-separated + * key-value pairs, in the following format: + * "key_1=value_1,key_2=value_2,...,key_n=value_n" The + * `bounding-poly` column (optional) identifies one region of interest from + * the image in the same manner as `CreateReferenceImage`. If you do not + * specify the `bounding-poly` column, then the system will try to detect + * regions of interest automatically. At most one `bounding-poly` column is + * allowed per line. If the image contains multiple regions of interest, add + * a line to the CSV file that includes the same product information, and + * the `bounding-poly` values for each region of interest. The + * `bounding-poly` column must contain an even number of comma-separated + * numbers, in the format "p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y". Use + * non-negative integers for absolute bounding polygons, and float values in + * [0, 1] for normalized bounding polygons. The system will resize the + * image if the image resolution is too large to process (larger than 20MP). + */ + csvFileUri?: string; + } + /** + * The input content for the `ImportProductSets` method. + */ + export interface Schema$ImportProductSetsInputConfig { + /** + * The Google Cloud Storage location for a csv file which preserves a list + * of ImportProductSetRequests in each line. + */ + gcsSource?: Schema$ImportProductSetsGcsSource; + } + /** + * Request message for the `ImportProductSets` method. + */ + export interface Schema$ImportProductSetsRequest { + /** + * The input content for the list of requests. + */ + inputConfig?: Schema$ImportProductSetsInputConfig; + } + /** + * Response message for the `ImportProductSets` method. This message is + * returned by the google.longrunning.Operations.GetOperation method in the + * returned google.longrunning.Operation.response field. + */ + export interface Schema$ImportProductSetsResponse { + /** + * The list of reference_images that are imported successfully. + */ + referenceImages?: Schema$ReferenceImage[]; + /** + * The rpc status for each ImportProductSet request, including both + * successes and errors. The number of statuses here matches the number of + * lines in the csv file, and statuses[i] stores the success or failure + * status of processing the i-th line of the csv, starting from line 0. + */ + statuses?: Schema$Status[]; + } /** * The desired input location and metadata. */ @@ -3526,6 +3955,21 @@ export namespace vision_v1 { */ mimeType?: string; } + /** + * A product label represented as a key-value pair. + */ + export interface Schema$KeyValue { + /** + * The key of the label attached to the product. Cannot be empty and cannot + * exceed 128 bytes. + */ + key?: string; + /** + * The value of the label attached to the product. Cannot be empty and + * cannot exceed 128 bytes. + */ + value?: string; + } /** * A face-specific landmark (for example, a face feature). */ @@ -3582,6 +4026,65 @@ export namespace vision_v1 { */ operations?: Schema$Operation[]; } + /** + * Response message for the `ListProductSets` method. + */ + export interface Schema$ListProductSetsResponse { + /** + * Token to retrieve the next page of results, or empty if there are no more + * results in the list. + */ + nextPageToken?: string; + /** + * List of ProductSets. + */ + productSets?: Schema$ProductSet[]; + } + /** + * Response message for the `ListProductsInProductSet` method. + */ + export interface Schema$ListProductsInProductSetResponse { + /** + * Token to retrieve the next page of results, or empty if there are no more + * results in the list. + */ + nextPageToken?: string; + /** + * The list of Products. + */ + products?: Schema$Product[]; + } + /** + * Response message for the `ListProducts` method. + */ + export interface Schema$ListProductsResponse { + /** + * Token to retrieve the next page of results, or empty if there are no more + * results in the list. + */ + nextPageToken?: string; + /** + * List of products. + */ + products?: Schema$Product[]; + } + /** + * Response message for the `ListReferenceImages` method. + */ + export interface Schema$ListReferenceImagesResponse { + /** + * The next_page_token returned from a previous List request, if any. + */ + nextPageToken?: string; + /** + * The maximum number of items to return. Default 10, maximum 100. + */ + pageSize?: number; + /** + * The list of reference images. + */ + referenceImages?: Schema$ReferenceImage[]; + } /** * Set of detected objects with bounding boxes. */ @@ -3782,6 +4285,124 @@ export namespace vision_v1 { */ z?: number; } + /** + * A Product contains ReferenceImages. + */ + export interface Schema$Product { + /** + * User-provided metadata to be stored with this product. Must be at most + * 4096 characters long. + */ + description?: string; + /** + * The user-provided name for this Product. Must not be empty. Must be at + * most 4096 characters long. + */ + displayName?: string; + /** + * The resource name of the product. Format is: + * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field + * is ignored when creating a product. + */ + name?: string; + /** + * The category for the product identified by the reference image. This + * should be either "homegoods", "apparel", or + * "toys". This field is immutable. + */ + productCategory?: string; + /** + * Key-value pairs that can be attached to a product. At query time, + * constraints can be specified based on the product_labels. Note that + * integer values can be provided as strings, e.g. "1199". Only + * strings with integer values can match a range-based restriction which is + * to be supported soon. Multiple values can be assigned to the same key. + * One product may have up to 100 product_labels. + */ + productLabels?: Schema$KeyValue[]; + } + /** + * Parameters for a product search request. + */ + export interface Schema$ProductSearchParams { + /** + * The bounding polygon around the area of interest in the image. Optional. + * If it is not specified, system discretion will be applied. + */ + boundingPoly?: Schema$BoundingPoly; + /** + * The filtering expression. This can be used to restrict search results + * based on Product labels. We currently support an AND of OR of key-value + * expressions, where each expression within an OR must have the same key. + * For example, "(color = red OR color = blue) AND brand = Google" + * is acceptable, but not "(color = red OR brand = Google)" or + * "color: red". + */ + filter?: string; + /** + * The list of product categories to search in. Currently, we only consider + * the first category, and either "homegoods", + * "apparel", or "toys" should be specified. + */ + productCategories?: string[]; + /** + * The resource name of a ProductSet to be searched for similar images. + * Format is: + * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. + */ + productSet?: string; + } + /** + * Results for a product search request. + */ + export interface Schema$ProductSearchResults { + /** + * Timestamp of the index which provided these results. Changes made after + * this time are not reflected in the current results. + */ + indexTime?: string; + /** + * List of results grouped by products detected in the query image. Each + * entry corresponds to one bounding polygon in the query image, and + * contains the matching products specific to that region. There may be + * duplicate product matches in the union of all the per-product results. + */ + productGroupedResults?: Schema$GroupedResult[]; + /** + * List of results, one for each product match. + */ + results?: Schema$Result[]; + } + /** + * A ProductSet contains Products. A ProductSet can contain a maximum of 1 + * million reference images. If the limit is exceeded, periodic indexing will + * fail. + */ + export interface Schema$ProductSet { + /** + * The user-provided name for this ProductSet. Must not be empty. Must be at + * most 4096 characters long. + */ + displayName?: string; + /** + * Output only. If there was an error with indexing the product set, the + * field is populated. This field is ignored when creating a ProductSet. + */ + indexError?: Schema$Status; + /** + * Output only. The time at which this ProductSet was last indexed. Query + * results will reflect all updates before this time. If this ProductSet has + * never been indexed, this field is 0. This field is ignored when creating + * a ProductSet. + */ + indexTime?: string; + /** + * The resource name of the ProductSet. Format is: + * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. This + * field is ignored when creating a ProductSet. + */ + name?: string; + } /** * A `Property` consists of a user-supplied name/value pair. */ @@ -3799,6 +4420,61 @@ export namespace vision_v1 { */ value?: string; } + /** + * A `ReferenceImage` represents a product image and its associated metadata, + * such as bounding boxes. + */ + export interface Schema$ReferenceImage { + /** + * Bounding polygons around the areas of interest in the reference image. + * Optional. If this field is empty, the system will try to detect regions + * of interest. At most 10 bounding polygons will be used. The provided + * shape is converted into a non-rotated rectangle. Once converted, the + * small edge of the rectangle must be greater than or equal to 300 pixels. + * The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + */ + boundingPolys?: Schema$BoundingPoly[]; + /** + * The resource name of the reference image. Format is: + * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. + * This field is ignored when creating a reference image. + */ + name?: string; + /** + * The Google Cloud Storage URI of the reference image. The URI must start + * with `gs://`. Required. + */ + uri?: string; + } + /** + * Request message for the `RemoveProductFromProductSet` method. + */ + export interface Schema$RemoveProductFromProductSetRequest { + /** + * The resource name for the Product to be removed from this ProductSet. + * Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + */ + product?: string; + } + /** + * Information about a product. + */ + export interface Schema$Result { + /** + * The resource name of the image from the product that is the closest match + * to the query. + */ + image?: string; + /** + * The Product. + */ + product?: Schema$Product; + /** + * A confidence level on the match, ranging from 0 (no confidence) to 1 + * (full confidence). + */ + score?: number; + } /** * Set of features pertaining to the image, computed by computer vision * methods over safe-search verticals (for example, adult, spoof, medical, @@ -4190,7 +4866,8 @@ export namespace vision_v1 { } } - export interface Params$Resource$Files$Asyncbatchannotate { + export interface Params$Resource$Files$Asyncbatchannotate extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4341,7 +5018,7 @@ export namespace vision_v1 { } } - export interface Params$Resource$Images$Annotate { + export interface Params$Resource$Images$Annotate extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4446,7 +5123,8 @@ export namespace vision_v1 { } } - export interface Params$Resource$Locations$Operations$Get { + export interface Params$Resource$Locations$Operations$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4752,7 +5430,8 @@ export namespace vision_v1 { } } - export interface Params$Resource$Operations$Cancel { + export interface Params$Resource$Operations$Cancel extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4768,7 +5447,8 @@ export namespace vision_v1 { */ requestBody?: Schema$CancelOperationRequest; } - export interface Params$Resource$Operations$Delete { + export interface Params$Resource$Operations$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4779,7 +5459,7 @@ export namespace vision_v1 { */ name?: string; } - export interface Params$Resource$Operations$Get { + export interface Params$Resource$Operations$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4790,7 +5470,7 @@ export namespace vision_v1 { */ name?: string; } - export interface Params$Resource$Operations$List { + export interface Params$Resource$Operations$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4813,4 +5493,1712 @@ export namespace vision_v1 { */ pageToken?: string; } + + + export class Resource$Projects { + root: Vision; + locations: Resource$Projects$Locations; + constructor(root: Vision) { + this.root = root; + this.getRoot.bind(this); + this.locations = new Resource$Projects$Locations(root); + } + + getRoot() { + return this.root; + } + } + + + export class Resource$Projects$Locations { + root: Vision; + products: Resource$Projects$Locations$Products; + productSets: Resource$Projects$Locations$Productsets; + constructor(root: Vision) { + this.root = root; + this.getRoot.bind(this); + this.products = new Resource$Projects$Locations$Products(root); + this.productSets = new Resource$Projects$Locations$Productsets(root); + } + + getRoot() { + return this.root; + } + } + + + export class Resource$Projects$Locations$Products { + root: Vision; + referenceImages: Resource$Projects$Locations$Products$Referenceimages; + constructor(root: Vision) { + this.root = root; + this.getRoot.bind(this); + this.referenceImages = + new Resource$Projects$Locations$Products$Referenceimages(root); + } + + getRoot() { + return this.root; + } + + + /** + * vision.projects.locations.products.create + * @desc Creates and returns a new product resource. Possible errors: * + * Returns INVALID_ARGUMENT if display_name is missing or longer than 4096 + * characters. * Returns INVALID_ARGUMENT if description is longer than 4096 + * characters. * Returns INVALID_ARGUMENT if product_category is missing or + * invalid. + * @alias vision.projects.locations.products.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The project in which the Product should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`. + * @param {string=} params.productId A user-supplied resource id for this Product. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`. + * @param {().Product} 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$Locations$Products$Create, + options?: MethodOptions): AxiosPromise; + create( + params: Params$Resource$Projects$Locations$Products$Create, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + create( + params: Params$Resource$Projects$Locations$Products$Create, + callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: Params$Resource$Projects$Locations$Products$Create| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Products$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Products$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vision.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/products') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * vision.projects.locations.products.delete + * @desc Permanently deletes a product and its reference images. Metadata + * of the product and all its images will be deleted right away, but search + * queries against ProductSets containing the product may still work until + * all related caches are refreshed. Possible errors: * Returns NOT_FOUND + * if the product does not exist. + * @alias vision.projects.locations.products.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Resource name of product to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_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 + */ + delete( + params?: Params$Resource$Projects$Locations$Products$Delete, + options?: MethodOptions): AxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Products$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Projects$Locations$Products$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Projects$Locations$Products$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Products$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Products$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vision.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * vision.projects.locations.products.get + * @desc Gets information associated with a Product. Possible errors: * + * Returns NOT_FOUND if the Product does not exist. + * @alias vision.projects.locations.products.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Resource name of the Product to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_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 + */ + get(params?: Params$Resource$Projects$Locations$Products$Get, + options?: MethodOptions): AxiosPromise; + get(params: Params$Resource$Projects$Locations$Products$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Projects$Locations$Products$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Projects$Locations$Products$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Products$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Products$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vision.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * vision.projects.locations.products.list + * @desc Lists products in an unspecified order. Possible errors: * + * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1. + * @alias vision.projects.locations.products.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize The maximum number of items to return. Default 10, maximum 100. + * @param {string=} params.pageToken The next_page_token returned from a previous List request, if any. + * @param {string} params.parent The project OR ProductSet from which Products should be listed. Format: `projects/PROJECT_ID/locations/LOC_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 + */ + list( + params?: Params$Resource$Projects$Locations$Products$List, + options?: MethodOptions): AxiosPromise; + list( + params: Params$Resource$Projects$Locations$Products$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Projects$Locations$Products$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Projects$Locations$Products$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Products$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Products$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vision.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/products') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * vision.projects.locations.products.patch + * @desc Makes changes to a Product resource. Only the `display_name`, + * `description`, and `labels` fields can be updated right now. If labels + * are updated, the change will not be reflected in queries until the next + * index time. Possible errors: * Returns NOT_FOUND if the Product does + * not exist. * Returns INVALID_ARGUMENT if display_name is present in + * update_mask but is missing from the request or longer than 4096 + * characters. * Returns INVALID_ARGUMENT if description is present in + * update_mask but is longer than 4096 characters. * Returns + * INVALID_ARGUMENT if product_category is present in update_mask. + * @alias vision.projects.locations.products.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. + * @param {string=} params.updateMask The FieldMask that specifies which fields to update. If update_mask isn't specified, all mutable fields are to be updated. Valid mask paths include `product_labels`, `display_name`, and `description`. + * @param {().Product} 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 + */ + patch( + params?: Params$Resource$Projects$Locations$Products$Patch, + options?: MethodOptions): AxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Products$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Projects$Locations$Products$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Projects$Locations$Products$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Products$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Products$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vision.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Products$Create extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The project in which the Product should be created. Format is + * `projects/PROJECT_ID/locations/LOC_ID`. + */ + parent?: string; + /** + * A user-supplied resource id for this Product. If set, the server will + * attempt to use this value as the resource id. If it is already in use, an + * error is returned with code ALREADY_EXISTS. Must be at most 128 + * characters long. It cannot contain the character `/`. + */ + productId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Product; + } + export interface Params$Resource$Projects$Locations$Products$Delete extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Resource name of product to delete. Format is: + * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Products$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Resource name of the Product to get. Format is: + * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Products$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The maximum number of items to return. Default 10, maximum 100. + */ + pageSize?: number; + /** + * The next_page_token returned from a previous List request, if any. + */ + pageToken?: string; + /** + * The project OR ProductSet from which Products should be listed. Format: + * `projects/PROJECT_ID/locations/LOC_ID` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Products$Patch extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The resource name of the product. Format is: + * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field + * is ignored when creating a product. + */ + name?: string; + /** + * The FieldMask that specifies which fields to update. If update_mask isn't + * specified, all mutable fields are to be updated. Valid mask paths include + * `product_labels`, `display_name`, and `description`. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Product; + } + + export class Resource$Projects$Locations$Products$Referenceimages { + root: Vision; + constructor(root: Vision) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * vision.projects.locations.products.referenceImages.create + * @desc Creates and returns a new ReferenceImage resource. The + * `bounding_poly` field is optional. If `bounding_poly` is not specified, + * the system will try to detect regions of interest in the image that are + * compatible with the product_category on the parent product. If it is + * specified, detection is ALWAYS skipped. The system converts polygons into + * non-rotated rectangles. Note that the pipeline will resize the image if + * the image resolution is too large to process (above 50MP). Possible + * errors: * Returns INVALID_ARGUMENT if the image_uri is missing or longer + * than 4096 characters. * Returns INVALID_ARGUMENT if the product does + * not exist. * Returns INVALID_ARGUMENT if bounding_poly is not provided, + * and nothing compatible with the parent product's product_category is + * detected. * Returns INVALID_ARGUMENT if bounding_poly contains more than + * 10 polygons. + * @alias vision.projects.locations.products.referenceImages.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Resource name of the product in which to create the reference image. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + * @param {string=} params.referenceImageId A user-supplied resource id for the ReferenceImage to be added. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`. + * @param {().ReferenceImage} 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$Locations$Products$Referenceimages$Create, + options?: MethodOptions): AxiosPromise; + create( + params: + Params$Resource$Projects$Locations$Products$Referenceimages$Create, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + create( + params: + Params$Resource$Projects$Locations$Products$Referenceimages$Create, + callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + Params$Resource$Projects$Locations$Products$Referenceimages$Create| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Products$Referenceimages$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Products$Referenceimages$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vision.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/referenceImages') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * vision.projects.locations.products.referenceImages.delete + * @desc Permanently deletes a reference image. The image metadata will be + * deleted right away, but search queries against ProductSets containing the + * image may still work until all related caches are refreshed. The actual + * image files are not deleted from Google Cloud Storage. Possible errors: + * * Returns NOT_FOUND if the reference image does not exist. + * @alias vision.projects.locations.products.referenceImages.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the reference image to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_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 + */ + delete( + params?: + Params$Resource$Projects$Locations$Products$Referenceimages$Delete, + options?: MethodOptions): AxiosPromise; + delete( + params: + Params$Resource$Projects$Locations$Products$Referenceimages$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: + Params$Resource$Projects$Locations$Products$Referenceimages$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + Params$Resource$Projects$Locations$Products$Referenceimages$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Products$Referenceimages$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Products$Referenceimages$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vision.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * vision.projects.locations.products.referenceImages.get + * @desc Gets information associated with a ReferenceImage. Possible + * errors: * Returns NOT_FOUND if the specified image does not exist. + * @alias vision.projects.locations.products.referenceImages.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the ReferenceImage to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_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 + */ + get(params?: + Params$Resource$Projects$Locations$Products$Referenceimages$Get, + options?: MethodOptions): AxiosPromise; + get(params: Params$Resource$Projects$Locations$Products$Referenceimages$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Projects$Locations$Products$Referenceimages$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: + Params$Resource$Projects$Locations$Products$Referenceimages$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Products$Referenceimages$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Products$Referenceimages$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vision.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * vision.projects.locations.products.referenceImages.list + * @desc Lists reference images. Possible errors: * Returns NOT_FOUND if + * the parent product does not exist. * Returns INVALID_ARGUMENT if the + * page_size is greater than 100, or less than 1. + * @alias vision.projects.locations.products.referenceImages.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize The maximum number of items to return. Default 10, maximum 100. + * @param {string=} params.pageToken A token identifying a page of results to be returned. This is the value of `nextPageToken` returned in a previous reference image list request. Defaults to the first page if not specified. + * @param {string} params.parent Resource name of the product containing the reference images. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_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 + */ + list( + params?: + Params$Resource$Projects$Locations$Products$Referenceimages$List, + options?: MethodOptions): + AxiosPromise; + list( + params: + Params$Resource$Projects$Locations$Products$Referenceimages$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + list( + params: + Params$Resource$Projects$Locations$Products$Referenceimages$List, + callback: BodyResponseCallback): + void; + list(callback: BodyResponseCallback): + void; + list( + paramsOrCallback?: + Params$Resource$Projects$Locations$Products$Referenceimages$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Products$Referenceimages$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Products$Referenceimages$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vision.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/referenceImages') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Products$Referenceimages$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Resource name of the product in which to create the reference image. + * Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + */ + parent?: string; + /** + * A user-supplied resource id for the ReferenceImage to be added. If set, + * the server will attempt to use this value as the resource id. If it is + * already in use, an error is returned with code ALREADY_EXISTS. Must be at + * most 128 characters long. It cannot contain the character `/`. + */ + referenceImageId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ReferenceImage; + } + export interface Params$Resource$Projects$Locations$Products$Referenceimages$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The resource name of the reference image to delete. Format is: + * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Products$Referenceimages$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The resource name of the ReferenceImage to get. Format is: + * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Products$Referenceimages$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The maximum number of items to return. Default 10, maximum 100. + */ + pageSize?: number; + /** + * A token identifying a page of results to be returned. This is the value + * of `nextPageToken` returned in a previous reference image list request. + * Defaults to the first page if not specified. + */ + pageToken?: string; + /** + * Resource name of the product containing the reference images. Format is + * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + */ + parent?: string; + } + + + + export class Resource$Projects$Locations$Productsets { + root: Vision; + products: Resource$Projects$Locations$Productsets$Products; + constructor(root: Vision) { + this.root = root; + this.getRoot.bind(this); + this.products = + new Resource$Projects$Locations$Productsets$Products(root); + } + + getRoot() { + return this.root; + } + + + /** + * vision.projects.locations.productSets.addProduct + * @desc Adds a Product to the specified ProductSet. If the Product is + * already present, no change is made. One Product can be added to at most + * 100 ProductSets. Possible errors: * Returns NOT_FOUND if the Product or + * the ProductSet doesn't exist. + * @alias vision.projects.locations.productSets.addProduct + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * @param {().AddProductToProductSetRequest} 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 + */ + addProduct( + params?: Params$Resource$Projects$Locations$Productsets$Addproduct, + options?: MethodOptions): AxiosPromise; + addProduct( + params: Params$Resource$Projects$Locations$Productsets$Addproduct, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + addProduct( + params: Params$Resource$Projects$Locations$Productsets$Addproduct, + callback: BodyResponseCallback): void; + addProduct(callback: BodyResponseCallback): void; + addProduct( + paramsOrCallback?: + Params$Resource$Projects$Locations$Productsets$Addproduct| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Productsets$Addproduct; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Productsets$Addproduct; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vision.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:addProduct') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * vision.projects.locations.productSets.create + * @desc Creates and returns a new ProductSet resource. Possible errors: * + * Returns INVALID_ARGUMENT if display_name is missing, or is longer than + * 4096 characters. + * @alias vision.projects.locations.productSets.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The project in which the ProductSet should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`. + * @param {string=} params.productSetId A user-supplied resource id for this ProductSet. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`. + * @param {().ProductSet} 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$Locations$Productsets$Create, + options?: MethodOptions): AxiosPromise; + create( + params: Params$Resource$Projects$Locations$Productsets$Create, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + create( + params: Params$Resource$Projects$Locations$Productsets$Create, + callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + Params$Resource$Projects$Locations$Productsets$Create| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Productsets$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Productsets$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vision.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/productSets') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * vision.projects.locations.productSets.delete + * @desc Permanently deletes a ProductSet. All Products and ReferenceImages + * in the ProductSet will be deleted. The actual image files are not + * deleted from Google Cloud Storage. Possible errors: * Returns NOT_FOUND + * if the ProductSet does not exist. + * @alias vision.projects.locations.productSets.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Resource name of the ProductSet to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_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 + */ + delete( + params?: Params$Resource$Projects$Locations$Productsets$Delete, + options?: MethodOptions): AxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Productsets$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Projects$Locations$Productsets$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + Params$Resource$Projects$Locations$Productsets$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Productsets$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Productsets$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vision.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * vision.projects.locations.productSets.get + * @desc Gets information associated with a ProductSet. Possible errors: * + * Returns NOT_FOUND if the ProductSet does not exist. + * @alias vision.projects.locations.productSets.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Resource name of the ProductSet to get. Format is: `projects/PROJECT_ID/locations/LOG_ID/productSets/PRODUCT_SET_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 + */ + get(params?: Params$Resource$Projects$Locations$Productsets$Get, + options?: MethodOptions): AxiosPromise; + get(params: Params$Resource$Projects$Locations$Productsets$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Projects$Locations$Productsets$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Projects$Locations$Productsets$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Productsets$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Productsets$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vision.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + +/** + * vision.projects.locations.productSets.import + * @desc Asynchronous API that imports a list of reference images to specified + * product sets based on a list of image information. The + * google.longrunning.Operation API can be used to keep track of the progress + * and results of the request. `Operation.metadata` contains + * `BatchOperationMetadata`. (progress) `Operation.response` contains + * `ImportProductSetsResponse`. (results) The input source of this method is a + * csv file on Google Cloud Storage. For the format of the csv file please see + * ImportProductSetsGcsSource.csv_file_uri. + * @alias vision.projects.locations.productSets.import + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The project in which the ProductSets should be imported. Format is `projects/PROJECT_ID/locations/LOC_ID`. + * @param {().ImportProductSetsRequest} 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 + */ +import(params?: Params$Resource$Projects$Locations$Productsets$Import, options?: MethodOptions): AxiosPromise; +import(params: Params$Resource$Projects$Locations$Productsets$Import, options: MethodOptions|BodyResponseCallback, callback: BodyResponseCallback): void; +import(params: Params$Resource$Projects$Locations$Productsets$Import, callback: BodyResponseCallback): void; +import(callback: BodyResponseCallback): void; +import(paramsOrCallback?: Params$Resource$Projects$Locations$Productsets$Import|BodyResponseCallback, optionsOrCallback?: MethodOptions|BodyResponseCallback, callback?: BodyResponseCallback): void|AxiosPromise {let params = (paramsOrCallback || {}) as Params$Resource$Projects$Locations$Productsets$Import; let options = (optionsOrCallback || {}) as MethodOptions; + + if(typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Productsets$Import; + options = {}; + } + + if(typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vision.googleapis.com/'; const parameters = {options: Object.assign({url: (rootUrl + '/v1/{+parent}/productSets:import').replace(/([^:]\/)\/+/g, '$1'), method: 'POST'}, options), params, requiredParams: ['parent'], pathParams: ['parent'], context: this.getRoot()}; if(callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + }} + + + /** + * vision.projects.locations.productSets.list + * @desc Lists ProductSets in an unspecified order. Possible errors: * Returns INVALID_ARGUMENT if page_size is greater than 100, or less than 1. + * @alias vision.projects.locations.productSets.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize The maximum number of items to return. Default 10, maximum 100. + * @param {string=} params.pageToken The next_page_token returned from a previous List request, if any. + * @param {string} params.parent The project from which ProductSets should be listed. Format is `projects/PROJECT_ID/locations/LOC_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 + */ + list(params?: Params$Resource$Projects$Locations$Productsets$List, options?: MethodOptions): AxiosPromise; + list( + params: Params$Resource$Projects$Locations$Productsets$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Projects$Locations$Productsets$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Projects$Locations$Productsets$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Productsets$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Productsets$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vision.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/productSets') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * vision.projects.locations.productSets.patch + * @desc Makes changes to a ProductSet resource. Only display_name can be + * updated currently. Possible errors: * Returns NOT_FOUND if the + * ProductSet does not exist. * Returns INVALID_ARGUMENT if display_name is + * present in update_mask but missing from the request or longer than 4096 + * characters. + * @alias vision.projects.locations.productSets.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. This field is ignored when creating a ProductSet. + * @param {string=} params.updateMask The FieldMask that specifies which fields to update. If update_mask isn't specified, all mutable fields are to be updated. Valid mask path is `display_name`. + * @param {().ProductSet} 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 + */ + patch( + params?: Params$Resource$Projects$Locations$Productsets$Patch, + options?: MethodOptions): AxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Productsets$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Projects$Locations$Productsets$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Projects$Locations$Productsets$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Productsets$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Productsets$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vision.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * vision.projects.locations.productSets.removeProduct + * @desc Removes a Product from the specified ProductSet. Possible errors: + * * Returns NOT_FOUND If the Product is not found under the ProductSet. + * @alias vision.projects.locations.productSets.removeProduct + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * @param {().RemoveProductFromProductSetRequest} 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 + */ + removeProduct( + params?: Params$Resource$Projects$Locations$Productsets$Removeproduct, + options?: MethodOptions): AxiosPromise; + removeProduct( + params: Params$Resource$Projects$Locations$Productsets$Removeproduct, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + removeProduct( + params: Params$Resource$Projects$Locations$Productsets$Removeproduct, + callback: BodyResponseCallback): void; + removeProduct(callback: BodyResponseCallback): void; + removeProduct( + paramsOrCallback?: + Params$Resource$Projects$Locations$Productsets$Removeproduct| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Productsets$Removeproduct; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Productsets$Removeproduct; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vision.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:removeProduct') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Productsets$Addproduct + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The resource name for the ProductSet to modify. Format is: + * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AddProductToProductSetRequest; + } + export interface Params$Resource$Projects$Locations$Productsets$Create extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The project in which the ProductSet should be created. Format is + * `projects/PROJECT_ID/locations/LOC_ID`. + */ + parent?: string; + /** + * A user-supplied resource id for this ProductSet. If set, the server will + * attempt to use this value as the resource id. If it is already in use, an + * error is returned with code ALREADY_EXISTS. Must be at most 128 + * characters long. It cannot contain the character `/`. + */ + productSetId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ProductSet; + } + export interface Params$Resource$Projects$Locations$Productsets$Delete extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Resource name of the ProductSet to delete. Format is: + * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Productsets$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Resource name of the ProductSet to get. Format is: + * `projects/PROJECT_ID/locations/LOG_ID/productSets/PRODUCT_SET_ID` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Productsets$Import extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The project in which the ProductSets should be imported. Format is + * `projects/PROJECT_ID/locations/LOC_ID`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ImportProductSetsRequest; + } + export interface Params$Resource$Projects$Locations$Productsets$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The maximum number of items to return. Default 10, maximum 100. + */ + pageSize?: number; + /** + * The next_page_token returned from a previous List request, if any. + */ + pageToken?: string; + /** + * The project from which ProductSets should be listed. Format is + * `projects/PROJECT_ID/locations/LOC_ID`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Productsets$Patch extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The resource name of the ProductSet. Format is: + * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. This + * field is ignored when creating a ProductSet. + */ + name?: string; + /** + * The FieldMask that specifies which fields to update. If update_mask isn't + * specified, all mutable fields are to be updated. Valid mask path is + * `display_name`. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ProductSet; + } + export interface Params$Resource$Projects$Locations$Productsets$Removeproduct + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The resource name for the ProductSet to modify. Format is: + * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RemoveProductFromProductSetRequest; + } + + export class Resource$Projects$Locations$Productsets$Products { + root: Vision; + constructor(root: Vision) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * vision.projects.locations.productSets.products.list + * @desc Lists the Products in a ProductSet, in an unspecified order. If the + * ProductSet does not exist, the products field of the response will be + * empty. Possible errors: * Returns INVALID_ARGUMENT if page_size is + * greater than 100 or less than 1. + * @alias vision.projects.locations.productSets.products.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The ProductSet resource for which to retrieve Products. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * @param {integer=} params.pageSize The maximum number of items to return. Default 10, maximum 100. + * @param {string=} params.pageToken The next_page_token returned from a previous List request, if any. + * @param {object} [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$Locations$Productsets$Products$List, + options?: MethodOptions): + AxiosPromise; + list( + params: Params$Resource$Projects$Locations$Productsets$Products$List, + options: MethodOptions| + BodyResponseCallback, + callback: + BodyResponseCallback): + void; + list( + params: Params$Resource$Projects$Locations$Productsets$Products$List, + callback: + BodyResponseCallback): + void; + list(callback: + BodyResponseCallback): + void; + list( + paramsOrCallback?: + Params$Resource$Projects$Locations$Productsets$Products$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: + BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Productsets$Products$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Productsets$Products$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vision.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/products') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Productsets$Products$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The ProductSet resource for which to retrieve Products. Format is: + * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + */ + name?: string; + /** + * The maximum number of items to return. Default 10, maximum 100. + */ + pageSize?: number; + /** + * The next_page_token returned from a previous List request, if any. + */ + pageToken?: string; + } } diff --git a/src/apis/vision/v1p1beta1.ts b/src/apis/vision/v1p1beta1.ts index 0554c83018..8c43b03ca8 100644 --- a/src/apis/vision/v1p1beta1.ts +++ b/src/apis/vision/v1p1beta1.ts @@ -29,6 +29,57 @@ export namespace vision_v1p1beta1 { version: 'v1p1beta1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Vision API * @@ -132,6 +183,10 @@ export namespace vision_v1p1beta1 { * If present, logo detection has completed successfully. */ logoAnnotations?: Schema$EntityAnnotation[]; + /** + * If present, product search has completed successfully. + */ + productSearchResults?: Schema$ProductSearchResults; /** * If present, safe-search annotation has completed successfully. */ @@ -164,6 +219,26 @@ export namespace vision_v1p1beta1 { */ responses?: Schema$AsyncAnnotateFileResponse[]; } + /** + * Metadata for the batch operations such as the current state. This is + * included in the `metadata` field of the `Operation` returned by the + * `GetOperation` call of the `google::longrunning::Operations` service. + */ + export interface Schema$BatchOperationMetadata { + /** + * The time when the batch request is finished and + * google.longrunning.Operation.done is set to true. + */ + endTime?: string; + /** + * The current state of the batch operation. + */ + state?: string; + /** + * The time when the batch request was submitted to the server. + */ + submitTime?: string; + } /** * Logical element on the page. */ @@ -623,6 +698,11 @@ export namespace vision_v1p1beta1 { * If present, logo detection has completed successfully. */ logoAnnotations?: Schema$GoogleCloudVisionV1p1beta1EntityAnnotation[]; + /** + * If present, product search has completed successfully. + */ + productSearchResults?: + Schema$GoogleCloudVisionV1p1beta1ProductSearchResults; /** * If present, safe-search annotation has completed successfully. */ @@ -1072,6 +1152,10 @@ export namespace vision_v1p1beta1 { * Not used. */ latLongRect?: Schema$GoogleCloudVisionV1p1beta1LatLongRect; + /** + * Parameters for product search. + */ + productSearchParams?: Schema$GoogleCloudVisionV1p1beta1ProductSearchParams; /** * Parameters for web detection. */ @@ -1288,6 +1372,143 @@ export namespace vision_v1p1beta1 { */ z?: number; } + /** + * A Product contains ReferenceImages. + */ + export interface Schema$GoogleCloudVisionV1p1beta1Product { + /** + * User-provided metadata to be stored with this product. Must be at most + * 4096 characters long. + */ + description?: string; + /** + * The user-provided name for this Product. Must not be empty. Must be at + * most 4096 characters long. + */ + displayName?: string; + /** + * The resource name of the product. Format is: + * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field + * is ignored when creating a product. + */ + name?: string; + /** + * The category for the product identified by the reference image. This + * should be either "homegoods", "apparel", or + * "toys". This field is immutable. + */ + productCategory?: string; + /** + * Key-value pairs that can be attached to a product. At query time, + * constraints can be specified based on the product_labels. Note that + * integer values can be provided as strings, e.g. "1199". Only + * strings with integer values can match a range-based restriction which is + * to be supported soon. Multiple values can be assigned to the same key. + * One product may have up to 100 product_labels. + */ + productLabels?: Schema$GoogleCloudVisionV1p1beta1ProductKeyValue[]; + } + /** + * A product label represented as a key-value pair. + */ + export interface Schema$GoogleCloudVisionV1p1beta1ProductKeyValue { + /** + * The key of the label attached to the product. Cannot be empty and cannot + * exceed 128 bytes. + */ + key?: string; + /** + * The value of the label attached to the product. Cannot be empty and + * cannot exceed 128 bytes. + */ + value?: string; + } + /** + * Parameters for a product search request. + */ + export interface Schema$GoogleCloudVisionV1p1beta1ProductSearchParams { + /** + * The bounding polygon around the area of interest in the image. Optional. + * If it is not specified, system discretion will be applied. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; + /** + * The filtering expression. This can be used to restrict search results + * based on Product labels. We currently support an AND of OR of key-value + * expressions, where each expression within an OR must have the same key. + * For example, "(color = red OR color = blue) AND brand = Google" + * is acceptable, but not "(color = red OR brand = Google)" or + * "color: red". + */ + filter?: string; + /** + * The list of product categories to search in. Currently, we only consider + * the first category, and either "homegoods", + * "apparel", or "toys" should be specified. + */ + productCategories?: string[]; + /** + * The resource name of a ProductSet to be searched for similar images. + * Format is: + * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. + */ + productSet?: string; + } + /** + * Results for a product search request. + */ + export interface Schema$GoogleCloudVisionV1p1beta1ProductSearchResults { + /** + * Timestamp of the index which provided these results. Changes made after + * this time are not reflected in the current results. + */ + indexTime?: string; + /** + * List of results grouped by products detected in the query image. Each + * entry corresponds to one bounding polygon in the query image, and + * contains the matching products specific to that region. There may be + * duplicate product matches in the union of all the per-product results. + */ + productGroupedResults?: + Schema$GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult[]; + /** + * List of results, one for each product match. + */ + results?: Schema$GoogleCloudVisionV1p1beta1ProductSearchResultsResult[]; + } + /** + * Information about the products similar to a single product in a query + * image. + */ + export interface Schema$GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult { + /** + * The bounding polygon around the product detected in the query image. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; + /** + * List of results, one for each product match. + */ + results?: Schema$GoogleCloudVisionV1p1beta1ProductSearchResultsResult[]; + } + /** + * Information about a product. + */ + export interface Schema$GoogleCloudVisionV1p1beta1ProductSearchResultsResult { + /** + * The resource name of the image from the product that is the closest match + * to the query. + */ + image?: string; + /** + * The Product. + */ + product?: Schema$GoogleCloudVisionV1p1beta1Product; + /** + * A confidence level on the match, ranging from 0 (no confidence) to 1 + * (full confidence). + */ + score?: number; + } /** * A `Property` consists of a user-supplied name/value pair. */ @@ -1659,6 +1880,11 @@ export namespace vision_v1p1beta1 { * If present, logo detection has completed successfully. */ logoAnnotations?: Schema$GoogleCloudVisionV1p2beta1EntityAnnotation[]; + /** + * If present, product search has completed successfully. + */ + productSearchResults?: + Schema$GoogleCloudVisionV1p2beta1ProductSearchResults; /** * If present, safe-search annotation has completed successfully. */ @@ -2171,6 +2397,112 @@ export namespace vision_v1p1beta1 { */ z?: number; } + /** + * A Product contains ReferenceImages. + */ + export interface Schema$GoogleCloudVisionV1p2beta1Product { + /** + * User-provided metadata to be stored with this product. Must be at most + * 4096 characters long. + */ + description?: string; + /** + * The user-provided name for this Product. Must not be empty. Must be at + * most 4096 characters long. + */ + displayName?: string; + /** + * The resource name of the product. Format is: + * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field + * is ignored when creating a product. + */ + name?: string; + /** + * The category for the product identified by the reference image. This + * should be either "homegoods", "apparel", or + * "toys". This field is immutable. + */ + productCategory?: string; + /** + * Key-value pairs that can be attached to a product. At query time, + * constraints can be specified based on the product_labels. Note that + * integer values can be provided as strings, e.g. "1199". Only + * strings with integer values can match a range-based restriction which is + * to be supported soon. Multiple values can be assigned to the same key. + * One product may have up to 100 product_labels. + */ + productLabels?: Schema$GoogleCloudVisionV1p2beta1ProductKeyValue[]; + } + /** + * A product label represented as a key-value pair. + */ + export interface Schema$GoogleCloudVisionV1p2beta1ProductKeyValue { + /** + * The key of the label attached to the product. Cannot be empty and cannot + * exceed 128 bytes. + */ + key?: string; + /** + * The value of the label attached to the product. Cannot be empty and + * cannot exceed 128 bytes. + */ + value?: string; + } + /** + * Results for a product search request. + */ + export interface Schema$GoogleCloudVisionV1p2beta1ProductSearchResults { + /** + * Timestamp of the index which provided these results. Changes made after + * this time are not reflected in the current results. + */ + indexTime?: string; + /** + * List of results grouped by products detected in the query image. Each + * entry corresponds to one bounding polygon in the query image, and + * contains the matching products specific to that region. There may be + * duplicate product matches in the union of all the per-product results. + */ + productGroupedResults?: + Schema$GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult[]; + /** + * List of results, one for each product match. + */ + results?: Schema$GoogleCloudVisionV1p2beta1ProductSearchResultsResult[]; + } + /** + * Information about the products similar to a single product in a query + * image. + */ + export interface Schema$GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult { + /** + * The bounding polygon around the product detected in the query image. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; + /** + * List of results, one for each product match. + */ + results?: Schema$GoogleCloudVisionV1p2beta1ProductSearchResultsResult[]; + } + /** + * Information about a product. + */ + export interface Schema$GoogleCloudVisionV1p2beta1ProductSearchResultsResult { + /** + * The resource name of the image from the product that is the closest match + * to the query. + */ + image?: string; + /** + * The Product. + */ + product?: Schema$GoogleCloudVisionV1p2beta1Product; + /** + * A confidence level on the match, ranging from 0 (no confidence) to 1 + * (full confidence). + */ + score?: number; + } /** * A `Property` consists of a user-supplied name/value pair. */ @@ -3148,6 +3480,28 @@ export namespace vision_v1p1beta1 { * this time are not reflected in the current results. */ indexTime?: string; + /** + * List of results grouped by products detected in the query image. Each + * entry corresponds to one bounding polygon in the query image, and + * contains the matching products specific to that region. There may be + * duplicate product matches in the union of all the per-product results. + */ + productGroupedResults?: + Schema$GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult[]; + /** + * List of results, one for each product match. + */ + results?: Schema$GoogleCloudVisionV1p3beta1ProductSearchResultsResult[]; + } + /** + * Information about the products similar to a single product in a query + * image. + */ + export interface Schema$GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult { + /** + * The bounding polygon around the product detected in the query image. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** * List of results, one for each product match. */ @@ -3494,6 +3848,20 @@ export namespace vision_v1p1beta1 { */ symbols?: Schema$GoogleCloudVisionV1p3beta1Symbol[]; } + /** + * Information about the products similar to a single product in a query + * image. + */ + export interface Schema$GroupedResult { + /** + * The bounding polygon around the product detected in the query image. + */ + boundingPoly?: Schema$BoundingPoly; + /** + * List of results, one for each product match. + */ + results?: Schema$Result[]; + } /** * If an image was produced from a file (e.g. a PDF), this message gives * information about the source of that image. @@ -3518,6 +3886,24 @@ export namespace vision_v1p1beta1 { */ dominantColors?: Schema$DominantColorsAnnotation; } + /** + * Response message for the `ImportProductSets` method. This message is + * returned by the google.longrunning.Operations.GetOperation method in the + * returned google.longrunning.Operation.response field. + */ + export interface Schema$ImportProductSetsResponse { + /** + * The list of reference_images that are imported successfully. + */ + referenceImages?: Schema$ReferenceImage[]; + /** + * The rpc status for each ImportProductSet request, including both + * successes and errors. The number of statuses here matches the number of + * lines in the csv file, and statuses[i] stores the success or failure + * status of processing the i-th line of the csv, starting from line 0. + */ + statuses?: Schema$Status[]; + } /** * The desired input location and metadata. */ @@ -3532,6 +3918,21 @@ export namespace vision_v1p1beta1 { */ mimeType?: string; } + /** + * A product label represented as a key-value pair. + */ + export interface Schema$KeyValue { + /** + * The key of the label attached to the product. Cannot be empty and cannot + * exceed 128 bytes. + */ + key?: string; + /** + * The value of the label attached to the product. Cannot be empty and + * cannot exceed 128 bytes. + */ + value?: string; + } /** * A face-specific landmark (for example, a face feature). */ @@ -3762,6 +4163,63 @@ export namespace vision_v1p1beta1 { */ z?: number; } + /** + * A Product contains ReferenceImages. + */ + export interface Schema$Product { + /** + * User-provided metadata to be stored with this product. Must be at most + * 4096 characters long. + */ + description?: string; + /** + * The user-provided name for this Product. Must not be empty. Must be at + * most 4096 characters long. + */ + displayName?: string; + /** + * The resource name of the product. Format is: + * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field + * is ignored when creating a product. + */ + name?: string; + /** + * The category for the product identified by the reference image. This + * should be either "homegoods", "apparel", or + * "toys". This field is immutable. + */ + productCategory?: string; + /** + * Key-value pairs that can be attached to a product. At query time, + * constraints can be specified based on the product_labels. Note that + * integer values can be provided as strings, e.g. "1199". Only + * strings with integer values can match a range-based restriction which is + * to be supported soon. Multiple values can be assigned to the same key. + * One product may have up to 100 product_labels. + */ + productLabels?: Schema$KeyValue[]; + } + /** + * Results for a product search request. + */ + export interface Schema$ProductSearchResults { + /** + * Timestamp of the index which provided these results. Changes made after + * this time are not reflected in the current results. + */ + indexTime?: string; + /** + * List of results grouped by products detected in the query image. Each + * entry corresponds to one bounding polygon in the query image, and + * contains the matching products specific to that region. There may be + * duplicate product matches in the union of all the per-product results. + */ + productGroupedResults?: Schema$GroupedResult[]; + /** + * List of results, one for each product match. + */ + results?: Schema$Result[]; + } /** * A `Property` consists of a user-supplied name/value pair. */ @@ -3779,6 +4237,51 @@ export namespace vision_v1p1beta1 { */ value?: string; } + /** + * A `ReferenceImage` represents a product image and its associated metadata, + * such as bounding boxes. + */ + export interface Schema$ReferenceImage { + /** + * Bounding polygons around the areas of interest in the reference image. + * Optional. If this field is empty, the system will try to detect regions + * of interest. At most 10 bounding polygons will be used. The provided + * shape is converted into a non-rotated rectangle. Once converted, the + * small edge of the rectangle must be greater than or equal to 300 pixels. + * The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + */ + boundingPolys?: Schema$BoundingPoly[]; + /** + * The resource name of the reference image. Format is: + * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. + * This field is ignored when creating a reference image. + */ + name?: string; + /** + * The Google Cloud Storage URI of the reference image. The URI must start + * with `gs://`. Required. + */ + uri?: string; + } + /** + * Information about a product. + */ + export interface Schema$Result { + /** + * The resource name of the image from the product that is the closest match + * to the query. + */ + image?: string; + /** + * The Product. + */ + product?: Schema$Product; + /** + * A confidence level on the match, ranging from 0 (no confidence) to 1 + * (full confidence). + */ + score?: number; + } /** * Set of features pertaining to the image, computed by computer vision * methods over safe-search verticals (for example, adult, spoof, medical, @@ -4161,7 +4664,8 @@ export namespace vision_v1p1beta1 { } } - export interface Params$Resource$Files$Asyncbatchannotate { + export interface Params$Resource$Files$Asyncbatchannotate extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4267,7 +4771,7 @@ export namespace vision_v1p1beta1 { } } - export interface Params$Resource$Images$Annotate { + export interface Params$Resource$Images$Annotate extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/vision/v1p2beta1.ts b/src/apis/vision/v1p2beta1.ts index 48dad15b03..3dbeca466b 100644 --- a/src/apis/vision/v1p2beta1.ts +++ b/src/apis/vision/v1p2beta1.ts @@ -29,6 +29,57 @@ export namespace vision_v1p2beta1 { version: 'v1p2beta1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Cloud Vision API * @@ -132,6 +183,10 @@ export namespace vision_v1p2beta1 { * If present, logo detection has completed successfully. */ logoAnnotations?: Schema$EntityAnnotation[]; + /** + * If present, product search has completed successfully. + */ + productSearchResults?: Schema$ProductSearchResults; /** * If present, safe-search annotation has completed successfully. */ @@ -164,6 +219,26 @@ export namespace vision_v1p2beta1 { */ responses?: Schema$AsyncAnnotateFileResponse[]; } + /** + * Metadata for the batch operations such as the current state. This is + * included in the `metadata` field of the `Operation` returned by the + * `GetOperation` call of the `google::longrunning::Operations` service. + */ + export interface Schema$BatchOperationMetadata { + /** + * The time when the batch request is finished and + * google.longrunning.Operation.done is set to true. + */ + endTime?: string; + /** + * The current state of the batch operation. + */ + state?: string; + /** + * The time when the batch request was submitted to the server. + */ + submitTime?: string; + } /** * Logical element on the page. */ @@ -605,6 +680,11 @@ export namespace vision_v1p2beta1 { * If present, logo detection has completed successfully. */ logoAnnotations?: Schema$GoogleCloudVisionV1p1beta1EntityAnnotation[]; + /** + * If present, product search has completed successfully. + */ + productSearchResults?: + Schema$GoogleCloudVisionV1p1beta1ProductSearchResults; /** * If present, safe-search annotation has completed successfully. */ @@ -1099,6 +1179,112 @@ export namespace vision_v1p2beta1 { */ z?: number; } + /** + * A Product contains ReferenceImages. + */ + export interface Schema$GoogleCloudVisionV1p1beta1Product { + /** + * User-provided metadata to be stored with this product. Must be at most + * 4096 characters long. + */ + description?: string; + /** + * The user-provided name for this Product. Must not be empty. Must be at + * most 4096 characters long. + */ + displayName?: string; + /** + * The resource name of the product. Format is: + * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field + * is ignored when creating a product. + */ + name?: string; + /** + * The category for the product identified by the reference image. This + * should be either "homegoods", "apparel", or + * "toys". This field is immutable. + */ + productCategory?: string; + /** + * Key-value pairs that can be attached to a product. At query time, + * constraints can be specified based on the product_labels. Note that + * integer values can be provided as strings, e.g. "1199". Only + * strings with integer values can match a range-based restriction which is + * to be supported soon. Multiple values can be assigned to the same key. + * One product may have up to 100 product_labels. + */ + productLabels?: Schema$GoogleCloudVisionV1p1beta1ProductKeyValue[]; + } + /** + * A product label represented as a key-value pair. + */ + export interface Schema$GoogleCloudVisionV1p1beta1ProductKeyValue { + /** + * The key of the label attached to the product. Cannot be empty and cannot + * exceed 128 bytes. + */ + key?: string; + /** + * The value of the label attached to the product. Cannot be empty and + * cannot exceed 128 bytes. + */ + value?: string; + } + /** + * Results for a product search request. + */ + export interface Schema$GoogleCloudVisionV1p1beta1ProductSearchResults { + /** + * Timestamp of the index which provided these results. Changes made after + * this time are not reflected in the current results. + */ + indexTime?: string; + /** + * List of results grouped by products detected in the query image. Each + * entry corresponds to one bounding polygon in the query image, and + * contains the matching products specific to that region. There may be + * duplicate product matches in the union of all the per-product results. + */ + productGroupedResults?: + Schema$GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult[]; + /** + * List of results, one for each product match. + */ + results?: Schema$GoogleCloudVisionV1p1beta1ProductSearchResultsResult[]; + } + /** + * Information about the products similar to a single product in a query + * image. + */ + export interface Schema$GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult { + /** + * The bounding polygon around the product detected in the query image. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; + /** + * List of results, one for each product match. + */ + results?: Schema$GoogleCloudVisionV1p1beta1ProductSearchResultsResult[]; + } + /** + * Information about a product. + */ + export interface Schema$GoogleCloudVisionV1p1beta1ProductSearchResultsResult { + /** + * The resource name of the image from the product that is the closest match + * to the query. + */ + image?: string; + /** + * The Product. + */ + product?: Schema$GoogleCloudVisionV1p1beta1Product; + /** + * A confidence level on the match, ranging from 0 (no confidence) to 1 + * (full confidence). + */ + score?: number; + } /** * A `Property` consists of a user-supplied name/value pair. */ @@ -1479,6 +1665,11 @@ export namespace vision_v1p2beta1 { * If present, logo detection has completed successfully. */ logoAnnotations?: Schema$GoogleCloudVisionV1p2beta1EntityAnnotation[]; + /** + * If present, product search has completed successfully. + */ + productSearchResults?: + Schema$GoogleCloudVisionV1p2beta1ProductSearchResults; /** * If present, safe-search annotation has completed successfully. */ @@ -1932,6 +2123,10 @@ export namespace vision_v1p2beta1 { * Not used. */ latLongRect?: Schema$GoogleCloudVisionV1p2beta1LatLongRect; + /** + * Parameters for product search. + */ + productSearchParams?: Schema$GoogleCloudVisionV1p2beta1ProductSearchParams; /** * Parameters for web detection. */ @@ -2162,6 +2357,143 @@ export namespace vision_v1p2beta1 { */ z?: number; } + /** + * A Product contains ReferenceImages. + */ + export interface Schema$GoogleCloudVisionV1p2beta1Product { + /** + * User-provided metadata to be stored with this product. Must be at most + * 4096 characters long. + */ + description?: string; + /** + * The user-provided name for this Product. Must not be empty. Must be at + * most 4096 characters long. + */ + displayName?: string; + /** + * The resource name of the product. Format is: + * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field + * is ignored when creating a product. + */ + name?: string; + /** + * The category for the product identified by the reference image. This + * should be either "homegoods", "apparel", or + * "toys". This field is immutable. + */ + productCategory?: string; + /** + * Key-value pairs that can be attached to a product. At query time, + * constraints can be specified based on the product_labels. Note that + * integer values can be provided as strings, e.g. "1199". Only + * strings with integer values can match a range-based restriction which is + * to be supported soon. Multiple values can be assigned to the same key. + * One product may have up to 100 product_labels. + */ + productLabels?: Schema$GoogleCloudVisionV1p2beta1ProductKeyValue[]; + } + /** + * A product label represented as a key-value pair. + */ + export interface Schema$GoogleCloudVisionV1p2beta1ProductKeyValue { + /** + * The key of the label attached to the product. Cannot be empty and cannot + * exceed 128 bytes. + */ + key?: string; + /** + * The value of the label attached to the product. Cannot be empty and + * cannot exceed 128 bytes. + */ + value?: string; + } + /** + * Parameters for a product search request. + */ + export interface Schema$GoogleCloudVisionV1p2beta1ProductSearchParams { + /** + * The bounding polygon around the area of interest in the image. Optional. + * If it is not specified, system discretion will be applied. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; + /** + * The filtering expression. This can be used to restrict search results + * based on Product labels. We currently support an AND of OR of key-value + * expressions, where each expression within an OR must have the same key. + * For example, "(color = red OR color = blue) AND brand = Google" + * is acceptable, but not "(color = red OR brand = Google)" or + * "color: red". + */ + filter?: string; + /** + * The list of product categories to search in. Currently, we only consider + * the first category, and either "homegoods", + * "apparel", or "toys" should be specified. + */ + productCategories?: string[]; + /** + * The resource name of a ProductSet to be searched for similar images. + * Format is: + * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. + */ + productSet?: string; + } + /** + * Results for a product search request. + */ + export interface Schema$GoogleCloudVisionV1p2beta1ProductSearchResults { + /** + * Timestamp of the index which provided these results. Changes made after + * this time are not reflected in the current results. + */ + indexTime?: string; + /** + * List of results grouped by products detected in the query image. Each + * entry corresponds to one bounding polygon in the query image, and + * contains the matching products specific to that region. There may be + * duplicate product matches in the union of all the per-product results. + */ + productGroupedResults?: + Schema$GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult[]; + /** + * List of results, one for each product match. + */ + results?: Schema$GoogleCloudVisionV1p2beta1ProductSearchResultsResult[]; + } + /** + * Information about the products similar to a single product in a query + * image. + */ + export interface Schema$GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult { + /** + * The bounding polygon around the product detected in the query image. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; + /** + * List of results, one for each product match. + */ + results?: Schema$GoogleCloudVisionV1p2beta1ProductSearchResultsResult[]; + } + /** + * Information about a product. + */ + export interface Schema$GoogleCloudVisionV1p2beta1ProductSearchResultsResult { + /** + * The resource name of the image from the product that is the closest match + * to the query. + */ + image?: string; + /** + * The Product. + */ + product?: Schema$GoogleCloudVisionV1p2beta1Product; + /** + * A confidence level on the match, ranging from 0 (no confidence) to 1 + * (full confidence). + */ + score?: number; + } /** * A `Property` consists of a user-supplied name/value pair. */ @@ -3148,6 +3480,28 @@ export namespace vision_v1p2beta1 { * this time are not reflected in the current results. */ indexTime?: string; + /** + * List of results grouped by products detected in the query image. Each + * entry corresponds to one bounding polygon in the query image, and + * contains the matching products specific to that region. There may be + * duplicate product matches in the union of all the per-product results. + */ + productGroupedResults?: + Schema$GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult[]; + /** + * List of results, one for each product match. + */ + results?: Schema$GoogleCloudVisionV1p3beta1ProductSearchResultsResult[]; + } + /** + * Information about the products similar to a single product in a query + * image. + */ + export interface Schema$GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult { + /** + * The bounding polygon around the product detected in the query image. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** * List of results, one for each product match. */ @@ -3494,6 +3848,20 @@ export namespace vision_v1p2beta1 { */ symbols?: Schema$GoogleCloudVisionV1p3beta1Symbol[]; } + /** + * Information about the products similar to a single product in a query + * image. + */ + export interface Schema$GroupedResult { + /** + * The bounding polygon around the product detected in the query image. + */ + boundingPoly?: Schema$BoundingPoly; + /** + * List of results, one for each product match. + */ + results?: Schema$Result[]; + } /** * If an image was produced from a file (e.g. a PDF), this message gives * information about the source of that image. @@ -3518,6 +3886,24 @@ export namespace vision_v1p2beta1 { */ dominantColors?: Schema$DominantColorsAnnotation; } + /** + * Response message for the `ImportProductSets` method. This message is + * returned by the google.longrunning.Operations.GetOperation method in the + * returned google.longrunning.Operation.response field. + */ + export interface Schema$ImportProductSetsResponse { + /** + * The list of reference_images that are imported successfully. + */ + referenceImages?: Schema$ReferenceImage[]; + /** + * The rpc status for each ImportProductSet request, including both + * successes and errors. The number of statuses here matches the number of + * lines in the csv file, and statuses[i] stores the success or failure + * status of processing the i-th line of the csv, starting from line 0. + */ + statuses?: Schema$Status[]; + } /** * The desired input location and metadata. */ @@ -3532,6 +3918,21 @@ export namespace vision_v1p2beta1 { */ mimeType?: string; } + /** + * A product label represented as a key-value pair. + */ + export interface Schema$KeyValue { + /** + * The key of the label attached to the product. Cannot be empty and cannot + * exceed 128 bytes. + */ + key?: string; + /** + * The value of the label attached to the product. Cannot be empty and + * cannot exceed 128 bytes. + */ + value?: string; + } /** * A face-specific landmark (for example, a face feature). */ @@ -3762,6 +4163,63 @@ export namespace vision_v1p2beta1 { */ z?: number; } + /** + * A Product contains ReferenceImages. + */ + export interface Schema$Product { + /** + * User-provided metadata to be stored with this product. Must be at most + * 4096 characters long. + */ + description?: string; + /** + * The user-provided name for this Product. Must not be empty. Must be at + * most 4096 characters long. + */ + displayName?: string; + /** + * The resource name of the product. Format is: + * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field + * is ignored when creating a product. + */ + name?: string; + /** + * The category for the product identified by the reference image. This + * should be either "homegoods", "apparel", or + * "toys". This field is immutable. + */ + productCategory?: string; + /** + * Key-value pairs that can be attached to a product. At query time, + * constraints can be specified based on the product_labels. Note that + * integer values can be provided as strings, e.g. "1199". Only + * strings with integer values can match a range-based restriction which is + * to be supported soon. Multiple values can be assigned to the same key. + * One product may have up to 100 product_labels. + */ + productLabels?: Schema$KeyValue[]; + } + /** + * Results for a product search request. + */ + export interface Schema$ProductSearchResults { + /** + * Timestamp of the index which provided these results. Changes made after + * this time are not reflected in the current results. + */ + indexTime?: string; + /** + * List of results grouped by products detected in the query image. Each + * entry corresponds to one bounding polygon in the query image, and + * contains the matching products specific to that region. There may be + * duplicate product matches in the union of all the per-product results. + */ + productGroupedResults?: Schema$GroupedResult[]; + /** + * List of results, one for each product match. + */ + results?: Schema$Result[]; + } /** * A `Property` consists of a user-supplied name/value pair. */ @@ -3779,6 +4237,51 @@ export namespace vision_v1p2beta1 { */ value?: string; } + /** + * A `ReferenceImage` represents a product image and its associated metadata, + * such as bounding boxes. + */ + export interface Schema$ReferenceImage { + /** + * Bounding polygons around the areas of interest in the reference image. + * Optional. If this field is empty, the system will try to detect regions + * of interest. At most 10 bounding polygons will be used. The provided + * shape is converted into a non-rotated rectangle. Once converted, the + * small edge of the rectangle must be greater than or equal to 300 pixels. + * The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + */ + boundingPolys?: Schema$BoundingPoly[]; + /** + * The resource name of the reference image. Format is: + * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. + * This field is ignored when creating a reference image. + */ + name?: string; + /** + * The Google Cloud Storage URI of the reference image. The URI must start + * with `gs://`. Required. + */ + uri?: string; + } + /** + * Information about a product. + */ + export interface Schema$Result { + /** + * The resource name of the image from the product that is the closest match + * to the query. + */ + image?: string; + /** + * The Product. + */ + product?: Schema$Product; + /** + * A confidence level on the match, ranging from 0 (no confidence) to 1 + * (full confidence). + */ + score?: number; + } /** * Set of features pertaining to the image, computed by computer vision * methods over safe-search verticals (for example, adult, spoof, medical, @@ -4161,7 +4664,8 @@ export namespace vision_v1p2beta1 { } } - export interface Params$Resource$Files$Asyncbatchannotate { + export interface Params$Resource$Files$Asyncbatchannotate extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -4267,7 +4771,7 @@ export namespace vision_v1p2beta1 { } } - export interface Params$Resource$Images$Annotate { + export interface Params$Resource$Images$Annotate extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/webfonts/v1.ts b/src/apis/webfonts/v1.ts index 31c39883a3..52dc31f308 100644 --- a/src/apis/webfonts/v1.ts +++ b/src/apis/webfonts/v1.ts @@ -29,6 +29,40 @@ export namespace webfonts_v1 { version: 'v1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Google Fonts Developer API * @@ -192,7 +226,7 @@ export namespace webfonts_v1 { } } - export interface Params$Resource$Webfonts$List { + export interface Params$Resource$Webfonts$List extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/webmasters/v3.ts b/src/apis/webmasters/v3.ts index b5e691f611..861dd78506 100644 --- a/src/apis/webmasters/v3.ts +++ b/src/apis/webmasters/v3.ts @@ -29,6 +29,40 @@ export namespace webmasters_v3 { version: 'v3'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * Search Console API * @@ -441,7 +475,8 @@ export namespace webmasters_v3 { } } - export interface Params$Resource$Searchanalytics$Query { + export interface Params$Resource$Searchanalytics$Query extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -733,7 +768,7 @@ export namespace webmasters_v3 { } } - export interface Params$Resource$Sitemaps$Delete { + export interface Params$Resource$Sitemaps$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -749,7 +784,7 @@ export namespace webmasters_v3 { */ siteUrl?: string; } - export interface Params$Resource$Sitemaps$Get { + export interface Params$Resource$Sitemaps$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -765,7 +800,7 @@ export namespace webmasters_v3 { */ siteUrl?: string; } - export interface Params$Resource$Sitemaps$List { + export interface Params$Resource$Sitemaps$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -781,7 +816,7 @@ export namespace webmasters_v3 { */ siteUrl?: string; } - export interface Params$Resource$Sitemaps$Submit { + export interface Params$Resource$Sitemaps$Submit extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1058,7 +1093,7 @@ export namespace webmasters_v3 { } } - export interface Params$Resource$Sites$Add { + export interface Params$Resource$Sites$Add extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1069,7 +1104,7 @@ export namespace webmasters_v3 { */ siteUrl?: string; } - export interface Params$Resource$Sites$Delete { + export interface Params$Resource$Sites$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1083,7 +1118,7 @@ export namespace webmasters_v3 { */ siteUrl?: string; } - export interface Params$Resource$Sites$Get { + export interface Params$Resource$Sites$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1097,7 +1132,7 @@ export namespace webmasters_v3 { */ siteUrl?: string; } - export interface Params$Resource$Sites$List { + export interface Params$Resource$Sites$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1200,7 +1235,8 @@ export namespace webmasters_v3 { } } - export interface Params$Resource$Urlcrawlerrorscounts$Query { + export interface Params$Resource$Urlcrawlerrorscounts$Query extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1461,7 +1497,8 @@ export namespace webmasters_v3 { } } - export interface Params$Resource$Urlcrawlerrorssamples$Get { + export interface Params$Resource$Urlcrawlerrorssamples$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1487,7 +1524,8 @@ export namespace webmasters_v3 { */ url?: string; } - export interface Params$Resource$Urlcrawlerrorssamples$List { + export interface Params$Resource$Urlcrawlerrorssamples$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1506,7 +1544,8 @@ export namespace webmasters_v3 { */ siteUrl?: string; } - export interface Params$Resource$Urlcrawlerrorssamples$Markasfixed { + export interface Params$Resource$Urlcrawlerrorssamples$Markasfixed extends + StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/websecurityscanner/README.md b/src/apis/websecurityscanner/README.md index 28e9502a3e..ce9e74d982 100644 --- a/src/apis/websecurityscanner/README.md +++ b/src/apis/websecurityscanner/README.md @@ -2,7 +2,7 @@ # @google/websecurityscanner -> Web Security Scanner API (under development). +> Scans your Compute and App Engine apps for common web vulnerabilities. ## Installation diff --git a/src/apis/websecurityscanner/v1alpha.ts b/src/apis/websecurityscanner/v1alpha.ts index 22e33c587e..d3ce90b4b4 100644 --- a/src/apis/websecurityscanner/v1alpha.ts +++ b/src/apis/websecurityscanner/v1alpha.ts @@ -29,10 +29,61 @@ export namespace websecurityscanner_v1alpha { version: 'v1alpha'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * Web Security Scanner API * - * Web Security Scanner API (under development). + * Scans your Compute and App Engine apps for common web vulnerabilities. * * @example * const {google} = require('googleapis'); @@ -940,7 +991,8 @@ export namespace websecurityscanner_v1alpha { } } - export interface Params$Resource$Projects$Scanconfigs$Create { + export interface Params$Resource$Projects$Scanconfigs$Create extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -957,7 +1009,8 @@ export namespace websecurityscanner_v1alpha { */ requestBody?: Schema$ScanConfig; } - export interface Params$Resource$Projects$Scanconfigs$Delete { + export interface Params$Resource$Projects$Scanconfigs$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -969,7 +1022,8 @@ export namespace websecurityscanner_v1alpha { */ name?: string; } - export interface Params$Resource$Projects$Scanconfigs$Get { + export interface Params$Resource$Projects$Scanconfigs$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -981,7 +1035,8 @@ export namespace websecurityscanner_v1alpha { */ name?: string; } - export interface Params$Resource$Projects$Scanconfigs$List { + export interface Params$Resource$Projects$Scanconfigs$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1005,7 +1060,8 @@ export namespace websecurityscanner_v1alpha { */ parent?: string; } - export interface Params$Resource$Projects$Scanconfigs$Patch { + export interface Params$Resource$Projects$Scanconfigs$Patch extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1029,7 +1085,8 @@ export namespace websecurityscanner_v1alpha { */ requestBody?: Schema$ScanConfig; } - export interface Params$Resource$Projects$Scanconfigs$Start { + export interface Params$Resource$Projects$Scanconfigs$Start extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1269,7 +1326,8 @@ export namespace websecurityscanner_v1alpha { } } - export interface Params$Resource$Projects$Scanconfigs$Scanruns$Get { + export interface Params$Resource$Projects$Scanconfigs$Scanruns$Get extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1282,7 +1340,8 @@ export namespace websecurityscanner_v1alpha { */ name?: string; } - export interface Params$Resource$Projects$Scanconfigs$Scanruns$List { + export interface Params$Resource$Projects$Scanconfigs$Scanruns$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1306,7 +1365,8 @@ export namespace websecurityscanner_v1alpha { */ parent?: string; } - export interface Params$Resource$Projects$Scanconfigs$Scanruns$Stop { + export interface Params$Resource$Projects$Scanconfigs$Scanruns$Stop extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1410,7 +1470,8 @@ export namespace websecurityscanner_v1alpha { } } - export interface Params$Resource$Projects$Scanconfigs$Scanruns$Crawledurls$List { + export interface Params$Resource$Projects$Scanconfigs$Scanruns$Crawledurls$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1587,7 +1648,8 @@ export namespace websecurityscanner_v1alpha { } } - export interface Params$Resource$Projects$Scanconfigs$Scanruns$Findings$Get { + export interface Params$Resource$Projects$Scanconfigs$Scanruns$Findings$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1600,7 +1662,8 @@ export namespace websecurityscanner_v1alpha { */ name?: string; } - export interface Params$Resource$Projects$Scanconfigs$Scanruns$Findings$List { + export interface Params$Resource$Projects$Scanconfigs$Scanruns$Findings$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1726,7 +1789,8 @@ export namespace websecurityscanner_v1alpha { } } - export interface Params$Resource$Projects$Scanconfigs$Scanruns$Findingtypestats$List { + export interface Params$Resource$Projects$Scanconfigs$Scanruns$Findingtypestats$List + extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/youtube/v3.ts b/src/apis/youtube/v3.ts index 4f82613ec7..fa7d957df7 100644 --- a/src/apis/youtube/v3.ts +++ b/src/apis/youtube/v3.ts @@ -29,6 +29,40 @@ export namespace youtube_v3 { version: 'v3'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * YouTube Data API * @@ -5108,7 +5142,8 @@ export namespace youtube_v3 { } } - export interface Params$Resource$Activities$Insert { + export interface Params$Resource$Activities$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5126,7 +5161,7 @@ export namespace youtube_v3 { */ requestBody?: Schema$Activity; } - export interface Params$Resource$Activities$List { + export interface Params$Resource$Activities$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5565,7 +5600,7 @@ export namespace youtube_v3 { } } - export interface Params$Resource$Captions$Delete { + export interface Params$Resource$Captions$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5596,7 +5631,8 @@ export namespace youtube_v3 { */ onBehalfOfContentOwner?: string; } - export interface Params$Resource$Captions$Download { + export interface Params$Resource$Captions$Download extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -5641,7 +5677,7 @@ export namespace youtube_v3 { */ tlang?: string; } - export interface Params$Resource$Captions$Insert { + export interface Params$Resource$Captions$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5701,7 +5737,7 @@ export namespace youtube_v3 { body?: any; }; } - export interface Params$Resource$Captions$List { + export interface Params$Resource$Captions$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5742,7 +5778,7 @@ export namespace youtube_v3 { */ videoId?: string; } - export interface Params$Resource$Captions$Update { + export interface Params$Resource$Captions$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5900,7 +5936,8 @@ export namespace youtube_v3 { } } - export interface Params$Resource$Channelbanners$Insert { + export interface Params$Resource$Channelbanners$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6109,7 +6146,7 @@ export namespace youtube_v3 { } } - export interface Params$Resource$Channels$List { + export interface Params$Resource$Channels$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6190,7 +6227,7 @@ export namespace youtube_v3 { */ part?: string; } - export interface Params$Resource$Channels$Update { + export interface Params$Resource$Channels$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -6521,7 +6558,8 @@ export namespace youtube_v3 { } } - export interface Params$Resource$Channelsections$Delete { + export interface Params$Resource$Channelsections$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6547,7 +6585,8 @@ export namespace youtube_v3 { */ onBehalfOfContentOwner?: string; } - export interface Params$Resource$Channelsections$Insert { + export interface Params$Resource$Channelsections$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6598,7 +6637,8 @@ export namespace youtube_v3 { */ requestBody?: Schema$ChannelSection; } - export interface Params$Resource$Channelsections$List { + export interface Params$Resource$Channelsections$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -6657,7 +6697,8 @@ export namespace youtube_v3 { */ part?: string; } - export interface Params$Resource$Channelsections$Update { + export interface Params$Resource$Channelsections$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7102,7 +7143,7 @@ export namespace youtube_v3 { } } - export interface Params$Resource$Comments$Delete { + export interface Params$Resource$Comments$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7114,7 +7155,7 @@ export namespace youtube_v3 { */ id?: string; } - export interface Params$Resource$Comments$Insert { + export interface Params$Resource$Comments$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7132,7 +7173,7 @@ export namespace youtube_v3 { */ requestBody?: Schema$Comment; } - export interface Params$Resource$Comments$List { + export interface Params$Resource$Comments$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7175,7 +7216,8 @@ export namespace youtube_v3 { */ textFormat?: string; } - export interface Params$Resource$Comments$Markasspam { + export interface Params$Resource$Comments$Markasspam extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7187,7 +7229,8 @@ export namespace youtube_v3 { */ id?: string; } - export interface Params$Resource$Comments$Setmoderationstatus { + export interface Params$Resource$Comments$Setmoderationstatus extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7210,7 +7253,7 @@ export namespace youtube_v3 { */ moderationStatus?: string; } - export interface Params$Resource$Comments$Update { + export interface Params$Resource$Comments$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -7460,7 +7503,8 @@ export namespace youtube_v3 { } } - export interface Params$Resource$Commentthreads$Insert { + export interface Params$Resource$Commentthreads$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7478,7 +7522,8 @@ export namespace youtube_v3 { */ requestBody?: Schema$CommentThread; } - export interface Params$Resource$Commentthreads$List { + export interface Params$Resource$Commentthreads$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7551,7 +7596,8 @@ export namespace youtube_v3 { */ videoId?: string; } - export interface Params$Resource$Commentthreads$Update { + export interface Params$Resource$Commentthreads$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7658,7 +7704,8 @@ export namespace youtube_v3 { } } - export interface Params$Resource$Guidecategories$List { + export interface Params$Resource$Guidecategories$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7771,7 +7818,8 @@ export namespace youtube_v3 { } } - export interface Params$Resource$I18nlanguages$List { + export interface Params$Resource$I18nlanguages$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -7870,7 +7918,7 @@ export namespace youtube_v3 { } } - export interface Params$Resource$I18nregions$List { + export interface Params$Resource$I18nregions$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -8410,7 +8458,8 @@ export namespace youtube_v3 { } } - export interface Params$Resource$Livebroadcasts$Bind { + export interface Params$Resource$Livebroadcasts$Bind extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8467,7 +8516,8 @@ export namespace youtube_v3 { */ streamId?: string; } - export interface Params$Resource$Livebroadcasts$Control { + export interface Params$Resource$Livebroadcasts$Control extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8542,7 +8592,8 @@ export namespace youtube_v3 { */ walltime?: string; } - export interface Params$Resource$Livebroadcasts$Delete { + export interface Params$Resource$Livebroadcasts$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8586,7 +8637,8 @@ export namespace youtube_v3 { */ onBehalfOfContentOwnerChannel?: string; } - export interface Params$Resource$Livebroadcasts$Insert { + export interface Params$Resource$Livebroadcasts$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8638,7 +8690,8 @@ export namespace youtube_v3 { */ requestBody?: Schema$LiveBroadcast; } - export interface Params$Resource$Livebroadcasts$List { + export interface Params$Resource$Livebroadcasts$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8718,7 +8771,8 @@ export namespace youtube_v3 { */ part?: string; } - export interface Params$Resource$Livebroadcasts$Transition { + export interface Params$Resource$Livebroadcasts$Transition extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8776,7 +8830,8 @@ export namespace youtube_v3 { */ part?: string; } - export interface Params$Resource$Livebroadcasts$Update { + export interface Params$Resource$Livebroadcasts$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8983,7 +9038,8 @@ export namespace youtube_v3 { } } - export interface Params$Resource$Livechatbans$Delete { + export interface Params$Resource$Livechatbans$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -8995,7 +9051,8 @@ export namespace youtube_v3 { */ id?: string; } - export interface Params$Resource$Livechatbans$Insert { + export interface Params$Resource$Livechatbans$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9239,7 +9296,8 @@ export namespace youtube_v3 { } } - export interface Params$Resource$Livechatmessages$Delete { + export interface Params$Resource$Livechatmessages$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9251,7 +9309,8 @@ export namespace youtube_v3 { */ id?: string; } - export interface Params$Resource$Livechatmessages$Insert { + export interface Params$Resource$Livechatmessages$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9269,7 +9328,8 @@ export namespace youtube_v3 { */ requestBody?: Schema$LiveChatMessage; } - export interface Params$Resource$Livechatmessages$List { + export interface Params$Resource$Livechatmessages$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9537,7 +9597,8 @@ export namespace youtube_v3 { } } - export interface Params$Resource$Livechatmoderators$Delete { + export interface Params$Resource$Livechatmoderators$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9549,7 +9610,8 @@ export namespace youtube_v3 { */ id?: string; } - export interface Params$Resource$Livechatmoderators$Insert { + export interface Params$Resource$Livechatmoderators$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9568,7 +9630,8 @@ export namespace youtube_v3 { */ requestBody?: Schema$LiveChatModerator; } - export interface Params$Resource$Livechatmoderators$List { + export interface Params$Resource$Livechatmoderators$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9893,7 +9956,8 @@ export namespace youtube_v3 { } } - export interface Params$Resource$Livestreams$Delete { + export interface Params$Resource$Livestreams$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9937,7 +10001,8 @@ export namespace youtube_v3 { */ onBehalfOfContentOwnerChannel?: string; } - export interface Params$Resource$Livestreams$Insert { + export interface Params$Resource$Livestreams$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -9988,7 +10053,7 @@ export namespace youtube_v3 { */ requestBody?: Schema$LiveStream; } - export interface Params$Resource$Livestreams$List { + export interface Params$Resource$Livestreams$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -10057,7 +10122,8 @@ export namespace youtube_v3 { */ part?: string; } - export interface Params$Resource$Livestreams$Update { + export interface Params$Resource$Livestreams$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10406,7 +10472,8 @@ export namespace youtube_v3 { } } - export interface Params$Resource$Playlistitems$Delete { + export interface Params$Resource$Playlistitems$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10432,7 +10499,8 @@ export namespace youtube_v3 { */ onBehalfOfContentOwner?: string; } - export interface Params$Resource$Playlistitems$Insert { + export interface Params$Resource$Playlistitems$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10463,7 +10531,8 @@ export namespace youtube_v3 { */ requestBody?: Schema$PlaylistItem; } - export interface Params$Resource$Playlistitems$List { + export interface Params$Resource$Playlistitems$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10522,7 +10591,8 @@ export namespace youtube_v3 { */ videoId?: string; } - export interface Params$Resource$Playlistitems$Update { + export interface Params$Resource$Playlistitems$Update extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -10852,7 +10922,7 @@ export namespace youtube_v3 { } } - export interface Params$Resource$Playlists$Delete { + export interface Params$Resource$Playlists$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -10878,7 +10948,7 @@ export namespace youtube_v3 { */ onBehalfOfContentOwner?: string; } - export interface Params$Resource$Playlists$Insert { + export interface Params$Resource$Playlists$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -10928,7 +10998,7 @@ export namespace youtube_v3 { */ requestBody?: Schema$Playlist; } - export interface Params$Resource$Playlists$List { + export interface Params$Resource$Playlists$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11009,7 +11079,7 @@ export namespace youtube_v3 { */ part?: string; } - export interface Params$Resource$Playlists$Update { + export interface Params$Resource$Playlists$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11158,7 +11228,7 @@ export namespace youtube_v3 { } } - export interface Params$Resource$Search$List { + export interface Params$Resource$Search$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11467,7 +11537,7 @@ export namespace youtube_v3 { } } - export interface Params$Resource$Sponsors$List { + export interface Params$Resource$Sponsors$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -11719,7 +11789,8 @@ export namespace youtube_v3 { } } - export interface Params$Resource$Subscriptions$Delete { + export interface Params$Resource$Subscriptions$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -11732,7 +11803,8 @@ export namespace youtube_v3 { */ id?: string; } - export interface Params$Resource$Subscriptions$Insert { + export interface Params$Resource$Subscriptions$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -11750,7 +11822,8 @@ export namespace youtube_v3 { */ requestBody?: Schema$Subscription; } - export interface Params$Resource$Subscriptions$List { + export interface Params$Resource$Subscriptions$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -11937,7 +12010,8 @@ export namespace youtube_v3 { } } - export interface Params$Resource$Superchatevents$List { + export interface Params$Resource$Superchatevents$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12055,7 +12129,7 @@ export namespace youtube_v3 { } } - export interface Params$Resource$Thumbnails$Set { + export interface Params$Resource$Thumbnails$Set extends StandardParameters { /** * Auth client or API Key for the request */ @@ -12190,7 +12264,8 @@ export namespace youtube_v3 { } } - export interface Params$Resource$Videoabusereportreasons$List { + export interface Params$Resource$Videoabusereportreasons$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12295,7 +12370,8 @@ export namespace youtube_v3 { } } - export interface Params$Resource$Videocategories$List { + export interface Params$Resource$Videocategories$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -12821,7 +12897,7 @@ export namespace youtube_v3 { } } - export interface Params$Resource$Videos$Delete { + export interface Params$Resource$Videos$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -12847,7 +12923,7 @@ export namespace youtube_v3 { */ onBehalfOfContentOwner?: string; } - export interface Params$Resource$Videos$Getrating { + export interface Params$Resource$Videos$Getrating extends StandardParameters { /** * Auth client or API Key for the request */ @@ -12873,7 +12949,7 @@ export namespace youtube_v3 { */ onBehalfOfContentOwner?: string; } - export interface Params$Resource$Videos$Insert { + export interface Params$Resource$Videos$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -12962,7 +13038,7 @@ export namespace youtube_v3 { body?: any; }; } - export interface Params$Resource$Videos$List { + export interface Params$Resource$Videos$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -13064,7 +13140,7 @@ export namespace youtube_v3 { */ videoCategoryId?: string; } - export interface Params$Resource$Videos$Rate { + export interface Params$Resource$Videos$Rate extends StandardParameters { /** * Auth client or API Key for the request */ @@ -13080,7 +13156,8 @@ export namespace youtube_v3 { */ rating?: string; } - export interface Params$Resource$Videos$Reportabuse { + export interface Params$Resource$Videos$Reportabuse extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -13105,7 +13182,7 @@ export namespace youtube_v3 { */ requestBody?: Schema$VideoAbuseReport; } - export interface Params$Resource$Videos$Update { + export interface Params$Resource$Videos$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -13295,7 +13372,7 @@ export namespace youtube_v3 { } } - export interface Params$Resource$Watermarks$Set { + export interface Params$Resource$Watermarks$Set extends StandardParameters { /** * Auth client or API Key for the request */ @@ -13340,7 +13417,7 @@ export namespace youtube_v3 { body?: any; }; } - export interface Params$Resource$Watermarks$Unset { + export interface Params$Resource$Watermarks$Unset extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/youtubeAnalytics/v1.ts b/src/apis/youtubeAnalytics/v1.ts index 3050ab13f1..0accfc05f5 100644 --- a/src/apis/youtubeAnalytics/v1.ts +++ b/src/apis/youtubeAnalytics/v1.ts @@ -29,6 +29,40 @@ export namespace youtubeAnalytics_v1 { version: 'v1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * YouTube Analytics API * @@ -352,7 +386,8 @@ export namespace youtubeAnalytics_v1 { } } - export interface Params$Resource$Groupitems$Delete { + export interface Params$Resource$Groupitems$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -377,7 +412,8 @@ export namespace youtubeAnalytics_v1 { */ onBehalfOfContentOwner?: string; } - export interface Params$Resource$Groupitems$Insert { + export interface Params$Resource$Groupitems$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -402,7 +438,7 @@ export namespace youtubeAnalytics_v1 { */ requestBody?: Schema$GroupItem; } - export interface Params$Resource$Groupitems$List { + export interface Params$Resource$Groupitems$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -706,7 +742,7 @@ export namespace youtubeAnalytics_v1 { } } - export interface Params$Resource$Groups$Delete { + export interface Params$Resource$Groups$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -731,7 +767,7 @@ export namespace youtubeAnalytics_v1 { */ onBehalfOfContentOwner?: string; } - export interface Params$Resource$Groups$Insert { + export interface Params$Resource$Groups$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -756,7 +792,7 @@ export namespace youtubeAnalytics_v1 { */ requestBody?: Schema$Group; } - export interface Params$Resource$Groups$List { + export interface Params$Resource$Groups$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -793,7 +829,7 @@ export namespace youtubeAnalytics_v1 { */ pageToken?: string; } - export interface Params$Resource$Groups$Update { + export interface Params$Resource$Groups$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -907,7 +943,7 @@ export namespace youtubeAnalytics_v1 { } } - export interface Params$Resource$Reports$Query { + export interface Params$Resource$Reports$Query extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/youtubeAnalytics/v1beta1.ts b/src/apis/youtubeAnalytics/v1beta1.ts index c3ce8a13d0..2638fb6e57 100644 --- a/src/apis/youtubeAnalytics/v1beta1.ts +++ b/src/apis/youtubeAnalytics/v1beta1.ts @@ -29,6 +29,40 @@ export namespace youtubeAnalytics_v1beta1 { version: 'v1beta1'; } + interface StandardParameters { + /** + * Data format for the response. + */ + alt?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * An opaque string that represents a user for quota purposes. Must not + * exceed 40 characters. + */ + quotaUser?: string; + /** + * Deprecated. Please use quotaUser instead. + */ + userIp?: string; + } + /** * YouTube Analytics API * @@ -352,7 +386,8 @@ export namespace youtubeAnalytics_v1beta1 { } } - export interface Params$Resource$Groupitems$Delete { + export interface Params$Resource$Groupitems$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -377,7 +412,8 @@ export namespace youtubeAnalytics_v1beta1 { */ onBehalfOfContentOwner?: string; } - export interface Params$Resource$Groupitems$Insert { + export interface Params$Resource$Groupitems$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -402,7 +438,7 @@ export namespace youtubeAnalytics_v1beta1 { */ requestBody?: Schema$GroupItem; } - export interface Params$Resource$Groupitems$List { + export interface Params$Resource$Groupitems$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -706,7 +742,7 @@ export namespace youtubeAnalytics_v1beta1 { } } - export interface Params$Resource$Groups$Delete { + export interface Params$Resource$Groups$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -731,7 +767,7 @@ export namespace youtubeAnalytics_v1beta1 { */ onBehalfOfContentOwner?: string; } - export interface Params$Resource$Groups$Insert { + export interface Params$Resource$Groups$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -756,7 +792,7 @@ export namespace youtubeAnalytics_v1beta1 { */ requestBody?: Schema$Group; } - export interface Params$Resource$Groups$List { + export interface Params$Resource$Groups$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -793,7 +829,7 @@ export namespace youtubeAnalytics_v1beta1 { */ pageToken?: string; } - export interface Params$Resource$Groups$Update { + export interface Params$Resource$Groups$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -907,7 +943,7 @@ export namespace youtubeAnalytics_v1beta1 { } } - export interface Params$Resource$Reports$Query { + export interface Params$Resource$Reports$Query extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/youtubeAnalytics/v2.ts b/src/apis/youtubeAnalytics/v2.ts index 8f4f9871f5..f1f259e53f 100644 --- a/src/apis/youtubeAnalytics/v2.ts +++ b/src/apis/youtubeAnalytics/v2.ts @@ -29,6 +29,57 @@ export namespace youtubeAnalytics_v2 { version: 'v2'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * YouTube Analytics API * @@ -577,7 +628,8 @@ export namespace youtubeAnalytics_v2 { } } - export interface Params$Resource$Groupitems$Delete { + export interface Params$Resource$Groupitems$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -602,7 +654,8 @@ export namespace youtubeAnalytics_v2 { */ onBehalfOfContentOwner?: string; } - export interface Params$Resource$Groupitems$Insert { + export interface Params$Resource$Groupitems$Insert extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -627,7 +680,7 @@ export namespace youtubeAnalytics_v2 { */ requestBody?: Schema$GroupItem; } - export interface Params$Resource$Groupitems$List { + export interface Params$Resource$Groupitems$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -933,7 +986,7 @@ export namespace youtubeAnalytics_v2 { } } - export interface Params$Resource$Groups$Delete { + export interface Params$Resource$Groups$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -958,7 +1011,7 @@ export namespace youtubeAnalytics_v2 { */ onBehalfOfContentOwner?: string; } - export interface Params$Resource$Groups$Insert { + export interface Params$Resource$Groups$Insert extends StandardParameters { /** * Auth client or API Key for the request */ @@ -983,7 +1036,7 @@ export namespace youtubeAnalytics_v2 { */ requestBody?: Schema$Group; } - export interface Params$Resource$Groups$List { + export interface Params$Resource$Groups$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1024,7 +1077,7 @@ export namespace youtubeAnalytics_v2 { */ pageToken?: string; } - export interface Params$Resource$Groups$Update { + export interface Params$Resource$Groups$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1138,7 +1191,7 @@ export namespace youtubeAnalytics_v2 { } } - export interface Params$Resource$Reports$Query { + export interface Params$Resource$Reports$Query extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/youtubereporting/v1.ts b/src/apis/youtubereporting/v1.ts index b4d47de300..64ab46bfe3 100644 --- a/src/apis/youtubereporting/v1.ts +++ b/src/apis/youtubereporting/v1.ts @@ -29,6 +29,57 @@ export namespace youtubereporting_v1 { version: 'v1'; } + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + /** * YouTube Reporting API * @@ -820,7 +871,7 @@ export namespace youtubereporting_v1 { } } - export interface Params$Resource$Jobs$Create { + export interface Params$Resource$Jobs$Create extends StandardParameters { /** * Auth client or API Key for the request */ @@ -837,7 +888,7 @@ export namespace youtubereporting_v1 { */ requestBody?: Schema$Job; } - export interface Params$Resource$Jobs$Delete { + export interface Params$Resource$Jobs$Delete extends StandardParameters { /** * Auth client or API Key for the request */ @@ -853,7 +904,7 @@ export namespace youtubereporting_v1 { */ onBehalfOfContentOwner?: string; } - export interface Params$Resource$Jobs$Get { + export interface Params$Resource$Jobs$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -869,7 +920,7 @@ export namespace youtubereporting_v1 { */ onBehalfOfContentOwner?: string; } - export interface Params$Resource$Jobs$List { + export interface Params$Resource$Jobs$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1049,7 +1100,7 @@ export namespace youtubereporting_v1 { } } - export interface Params$Resource$Jobs$Reports$Get { + export interface Params$Resource$Jobs$Reports$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1069,7 +1120,8 @@ export namespace youtubereporting_v1 { */ reportId?: string; } - export interface Params$Resource$Jobs$Reports$List { + export interface Params$Resource$Jobs$Reports$List extends + StandardParameters { /** * Auth client or API Key for the request */ @@ -1192,7 +1244,7 @@ export namespace youtubereporting_v1 { } } - export interface Params$Resource$Media$Download { + export interface Params$Resource$Media$Download extends StandardParameters { /** * Auth client or API Key for the request */ @@ -1286,7 +1338,7 @@ export namespace youtubereporting_v1 { } } - export interface Params$Resource$Reporttypes$List { + export interface Params$Resource$Reporttypes$List extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/generator/templates/api-endpoint.njk b/src/generator/templates/api-endpoint.njk index 5a130ba080..19d7ea0d0c 100644 --- a/src/generator/templates/api-endpoint.njk +++ b/src/generator/templates/api-endpoint.njk @@ -40,6 +40,15 @@ export interface Options extends GlobalOptions { version: '{{api.version|replace('\.', '_')}}'; } +interface StandardParameters { + {% for pname, p in api.parameters|dictsort %} + /** + * {{ p.description|oneLine|cleanComments|safe }} + */ + {{ pname|cleanPropertyName|safe }}?: {{ p.type }}; + {% endfor %} +} + /** * {{ api.title }} * @@ -83,15 +92,6 @@ export class {{ Name }} { return this.root; } -interface StandardParameters { - {% for pname, p in api.parameters|dictsort %} - /** - * {{ p.description|oneLine|cleanComments|safe }} - */ - {{ pname|getSafeParamName }}?: {{ p.type }}; - {% endfor %} -} - {% if api.methods %} {% for mname, m in api.methods|dictsort %} {{ method.render(m, mname, api, api) }} diff --git a/src/generator/templates/package.json.njk b/src/generator/templates/package.json.njk index 9574420193..9264d8214d 100644 --- a/src/generator/templates/package.json.njk +++ b/src/generator/templates/package.json.njk @@ -19,6 +19,6 @@ "node": ">=6.0.0" }, "dependencies": { - "googleapis-common": "^0.2.0" + "googleapis-common": "^0.4.0" } } diff --git a/src/index.ts b/src/index.ts index 01eaccae0e..d3ee29d63f 100644 --- a/src/index.ts +++ b/src/index.ts @@ -75,6 +75,7 @@ export {cloudresourcemanager_v1} from './apis/cloudresourcemanager/v1'; export {cloudresourcemanager_v1beta1} from './apis/cloudresourcemanager/v1beta1'; export {cloudresourcemanager_v2} from './apis/cloudresourcemanager/v2'; export {cloudresourcemanager_v2beta1} from './apis/cloudresourcemanager/v2beta1'; +export {cloudsearch_v1} from './apis/cloudsearch/v1'; export {cloudshell_v1} from './apis/cloudshell/v1'; export {cloudshell_v1alpha1} from './apis/cloudshell/v1alpha1'; export {cloudtasks_v2beta2} from './apis/cloudtasks/v2beta2'; @@ -89,7 +90,6 @@ export {compute_v1} from './apis/compute/v1'; export {container_v1} from './apis/container/v1'; export {container_v1beta1} from './apis/container/v1beta1'; export {content_v2} from './apis/content/v2'; -export {content_v2sandbox} from './apis/content/v2sandbox'; export {customsearch_v1} from './apis/customsearch/v1'; export {dataflow_v1b3} from './apis/dataflow/v1b3'; export {dataproc_v1} from './apis/dataproc/v1'; @@ -100,7 +100,6 @@ export {datastore_v1beta3} from './apis/datastore/v1beta3'; export {deploymentmanager_alpha} from './apis/deploymentmanager/alpha'; export {deploymentmanager_v2} from './apis/deploymentmanager/v2'; export {deploymentmanager_v2beta} from './apis/deploymentmanager/v2beta'; -export {dfareporting_v2_8} from './apis/dfareporting/v2.8'; export {dfareporting_v3_0} from './apis/dfareporting/v3.0'; export {dfareporting_v3_1} from './apis/dfareporting/v3.1'; export {dfareporting_v3_2} from './apis/dfareporting/v3.2'; @@ -191,7 +190,6 @@ export {servicemanagement_v1} from './apis/servicemanagement/v1'; export {servicenetworking_v1beta} from './apis/servicenetworking/v1beta'; export {serviceusage_v1} from './apis/serviceusage/v1'; export {serviceusage_v1beta1} from './apis/serviceusage/v1beta1'; -export {serviceuser_v1} from './apis/serviceuser/v1'; export {sheets_v4} from './apis/sheets/v4'; export {siteVerification_v1} from './apis/siteVerification/v1'; export {slides_v1} from './apis/slides/v1';