v1.d.ts
15.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
/**
* Copyright 2019 Google LLC
*
* 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 { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace siteVerification_v1 {
export interface Options extends GlobalOptions {
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
*
* Verifies ownership of websites or domains with Google.
*
* @example
* const {google} = require('googleapis');
* const siteVerification = google.siteVerification('v1');
*
* @namespace siteVerification
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Siteverification
*/
export class Siteverification {
context: APIRequestContext;
webResource: Resource$Webresource;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
export interface Schema$SiteVerificationWebResourceGettokenRequest {
/**
* The site for which a verification token will be generated.
*/
site?: {
identifier?: string;
type?: string;
} | null;
/**
* The verification method that will be used to verify this site. For sites, 'FILE' or 'META' methods may be used. For domains, only 'DNS' may be used.
*/
verificationMethod?: string | null;
}
export interface Schema$SiteVerificationWebResourceGettokenResponse {
/**
* The verification method to use in conjunction with this token. For FILE, the token should be placed in the top-level directory of the site, stored inside a file of the same name. For META, the token should be placed in the HEAD tag of the default page that is loaded for the site. For DNS, the token should be placed in a TXT record of the domain.
*/
method?: string | null;
/**
* The verification token. The token must be placed appropriately in order for verification to succeed.
*/
token?: string | null;
}
export interface Schema$SiteVerificationWebResourceListResponse {
/**
* The list of sites that are owned by the authenticated user.
*/
items?: Schema$SiteVerificationWebResourceResource[];
}
export interface Schema$SiteVerificationWebResourceResource {
/**
* The string used to identify this site. This value should be used in the "id" portion of the REST URL for the Get, Update, and Delete operations.
*/
id?: string | null;
/**
* The email addresses of all verified owners.
*/
owners?: string[] | null;
/**
* The address and type of a site that is verified or will be verified.
*/
site?: {
identifier?: string;
type?: string;
} | null;
}
export class Resource$Webresource {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* siteVerification.webResource.delete
* @desc Relinquish ownership of a website or domain.
* @alias siteVerification.webResource.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id The id of a verified site or domain.
* @param {object} [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$Webresource$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Webresource$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Webresource$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* siteVerification.webResource.get
* @desc Get the most current data for a website or domain.
* @alias siteVerification.webResource.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id The id of a verified site or domain.
* @param {object} [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$Webresource$Get, options?: MethodOptions): GaxiosPromise<Schema$SiteVerificationWebResourceResource>;
get(params: Params$Resource$Webresource$Get, options: MethodOptions | BodyResponseCallback<Schema$SiteVerificationWebResourceResource>, callback: BodyResponseCallback<Schema$SiteVerificationWebResourceResource>): void;
get(params: Params$Resource$Webresource$Get, callback: BodyResponseCallback<Schema$SiteVerificationWebResourceResource>): void;
get(callback: BodyResponseCallback<Schema$SiteVerificationWebResourceResource>): void;
/**
* siteVerification.webResource.getToken
* @desc Get a verification token for placing on a website or domain.
* @alias siteVerification.webResource.getToken
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().SiteVerificationWebResourceGettokenRequest} params.resource Request 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
*/
getToken(params?: Params$Resource$Webresource$Gettoken, options?: MethodOptions): GaxiosPromise<Schema$SiteVerificationWebResourceGettokenResponse>;
getToken(params: Params$Resource$Webresource$Gettoken, options: MethodOptions | BodyResponseCallback<Schema$SiteVerificationWebResourceGettokenResponse>, callback: BodyResponseCallback<Schema$SiteVerificationWebResourceGettokenResponse>): void;
getToken(params: Params$Resource$Webresource$Gettoken, callback: BodyResponseCallback<Schema$SiteVerificationWebResourceGettokenResponse>): void;
getToken(callback: BodyResponseCallback<Schema$SiteVerificationWebResourceGettokenResponse>): void;
/**
* siteVerification.webResource.insert
* @desc Attempt verification of a website or domain.
* @alias siteVerification.webResource.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.verificationMethod The method to use for verifying a site or domain.
* @param {().SiteVerificationWebResourceResource} params.resource Request 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$Webresource$Insert, options?: MethodOptions): GaxiosPromise<Schema$SiteVerificationWebResourceResource>;
insert(params: Params$Resource$Webresource$Insert, options: MethodOptions | BodyResponseCallback<Schema$SiteVerificationWebResourceResource>, callback: BodyResponseCallback<Schema$SiteVerificationWebResourceResource>): void;
insert(params: Params$Resource$Webresource$Insert, callback: BodyResponseCallback<Schema$SiteVerificationWebResourceResource>): void;
insert(callback: BodyResponseCallback<Schema$SiteVerificationWebResourceResource>): void;
/**
* siteVerification.webResource.list
* @desc Get the list of your verified websites and domains.
* @alias siteVerification.webResource.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$Webresource$List, options?: MethodOptions): GaxiosPromise<Schema$SiteVerificationWebResourceListResponse>;
list(params: Params$Resource$Webresource$List, options: MethodOptions | BodyResponseCallback<Schema$SiteVerificationWebResourceListResponse>, callback: BodyResponseCallback<Schema$SiteVerificationWebResourceListResponse>): void;
list(params: Params$Resource$Webresource$List, callback: BodyResponseCallback<Schema$SiteVerificationWebResourceListResponse>): void;
list(callback: BodyResponseCallback<Schema$SiteVerificationWebResourceListResponse>): void;
/**
* siteVerification.webResource.patch
* @desc Modify the list of owners for your website or domain. This method supports patch semantics.
* @alias siteVerification.webResource.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id The id of a verified site or domain.
* @param {().SiteVerificationWebResourceResource} params.resource Request 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$Webresource$Patch, options?: MethodOptions): GaxiosPromise<Schema$SiteVerificationWebResourceResource>;
patch(params: Params$Resource$Webresource$Patch, options: MethodOptions | BodyResponseCallback<Schema$SiteVerificationWebResourceResource>, callback: BodyResponseCallback<Schema$SiteVerificationWebResourceResource>): void;
patch(params: Params$Resource$Webresource$Patch, callback: BodyResponseCallback<Schema$SiteVerificationWebResourceResource>): void;
patch(callback: BodyResponseCallback<Schema$SiteVerificationWebResourceResource>): void;
/**
* siteVerification.webResource.update
* @desc Modify the list of owners for your website or domain.
* @alias siteVerification.webResource.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id The id of a verified site or domain.
* @param {().SiteVerificationWebResourceResource} params.resource Request 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$Webresource$Update, options?: MethodOptions): GaxiosPromise<Schema$SiteVerificationWebResourceResource>;
update(params: Params$Resource$Webresource$Update, options: MethodOptions | BodyResponseCallback<Schema$SiteVerificationWebResourceResource>, callback: BodyResponseCallback<Schema$SiteVerificationWebResourceResource>): void;
update(params: Params$Resource$Webresource$Update, callback: BodyResponseCallback<Schema$SiteVerificationWebResourceResource>): void;
update(callback: BodyResponseCallback<Schema$SiteVerificationWebResourceResource>): void;
}
export interface Params$Resource$Webresource$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The id of a verified site or domain.
*/
id?: string;
}
export interface Params$Resource$Webresource$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The id of a verified site or domain.
*/
id?: string;
}
export interface Params$Resource$Webresource$Gettoken extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$SiteVerificationWebResourceGettokenRequest;
}
export interface Params$Resource$Webresource$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The method to use for verifying a site or domain.
*/
verificationMethod?: string;
/**
* Request body metadata
*/
requestBody?: Schema$SiteVerificationWebResourceResource;
}
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 extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The id of a verified site or domain.
*/
id?: string;
/**
* Request body metadata
*/
requestBody?: Schema$SiteVerificationWebResourceResource;
}
export interface Params$Resource$Webresource$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The id of a verified site or domain.
*/
id?: string;
/**
* Request body metadata
*/
requestBody?: Schema$SiteVerificationWebResourceResource;
}
export {};
}