v1.d.ts
21.5 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
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
/**
* 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 domainsrdap_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;
}
/**
* Domains RDAP API
*
* Read-only public API that lets users search for information about domain names.
*
* @example
* const {google} = require('googleapis');
* const domainsrdap = google.domainsrdap('v1');
*
* @namespace domainsrdap
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Domainsrdap
*/
export class Domainsrdap {
context: APIRequestContext;
autnum: Resource$Autnum;
domain: Resource$Domain;
entity: Resource$Entity;
ip: Resource$Ip;
nameserver: Resource$Nameserver;
v1: Resource$V1;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
*/
export interface Schema$HttpBody {
/**
* The HTTP Content-Type header value specifying the content type of the body.
*/
contentType?: string | null;
/**
* The HTTP request/response body as raw binary.
*/
data?: string | null;
/**
* Application specific response metadata. Must be set in the first response for streaming APIs.
*/
extensions?: Array<{
[key: string]: any;
}> | null;
}
/**
* Links object defined in [section 4.2 of RFC 7483](https://tools.ietf.org/html/rfc7483#section-4.2).
*/
export interface Schema$Link {
/**
* Target URL of a link. Example: "http://example.com/previous".
*/
href?: string | null;
/**
* Language code of a link. Example: "en".
*/
hreflang?: string | null;
/**
* Media type of the link destination. Example: "screen".
*/
media?: string | null;
/**
* Relation type of a link. Example: "previous".
*/
rel?: string | null;
/**
* Title of this link. Example: "title".
*/
title?: string | null;
/**
* Content type of the link. Example: "application/json".
*/
type?: string | null;
/**
* URL giving context for the link. Example: "http://example.com/current".
*/
value?: string | null;
}
/**
* Notices object defined in [section 4.3 of RFC 7483](https://tools.ietf.org/html/rfc7483#section-4.3).
*/
export interface Schema$Notice {
/**
* Description of the notice.
*/
description?: string[] | null;
/**
* Link to a document containing more information.
*/
links?: Schema$Link[];
/**
* Title of a notice. Example: "Terms of Service".
*/
title?: string | null;
/**
* Type values defined in [section 10.2.1 of RFC 7483](https://tools.ietf.org/html/rfc7483#section-10.2.1) specific to a whole response: "result set truncated due to authorization", "result set truncated due to excessive load", "result set truncated due to unexplainable reasons".
*/
type?: string | null;
}
/**
* Response to a general RDAP query.
*/
export interface Schema$RdapResponse {
/**
* Error description.
*/
description?: string[] | null;
/**
* Error HTTP code. Example: "501".
*/
errorCode?: number | null;
/**
* HTTP response with content type set to "application/json+rdap".
*/
jsonResponse?: Schema$HttpBody;
/**
* Error language code. Error response info fields are defined in [section 6 of RFC 7483](https://tools.ietf.org/html/rfc7483#section-6).
*/
lang?: string | null;
/**
* Notices applying to this response.
*/
notices?: Schema$Notice[];
/**
* RDAP conformance level.
*/
rdapConformance?: string[] | null;
/**
* Error title.
*/
title?: string | null;
}
export class Resource$Autnum {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* domainsrdap.autnum.get
* @desc The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error.
* @alias domainsrdap.autnum.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.autnumId
* @param {object} [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$Autnum$Get, options?: MethodOptions): GaxiosPromise<Schema$RdapResponse>;
get(params: Params$Resource$Autnum$Get, options: MethodOptions | BodyResponseCallback<Schema$RdapResponse>, callback: BodyResponseCallback<Schema$RdapResponse>): void;
get(params: Params$Resource$Autnum$Get, callback: BodyResponseCallback<Schema$RdapResponse>): void;
get(callback: BodyResponseCallback<Schema$RdapResponse>): void;
}
export interface Params$Resource$Autnum$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
*
*/
autnumId?: string;
}
export class Resource$Domain {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* domainsrdap.domain.get
* @desc Look up RDAP information for a domain by name.
* @alias domainsrdap.domain.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.domainName Full domain name to look up. Example: "example.com"
* @param {object} [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$Domain$Get, options?: MethodOptions): GaxiosPromise<Schema$HttpBody>;
get(params: Params$Resource$Domain$Get, options: MethodOptions | BodyResponseCallback<Schema$HttpBody>, callback: BodyResponseCallback<Schema$HttpBody>): void;
get(params: Params$Resource$Domain$Get, callback: BodyResponseCallback<Schema$HttpBody>): void;
get(callback: BodyResponseCallback<Schema$HttpBody>): void;
}
export interface Params$Resource$Domain$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Full domain name to look up. Example: "example.com"
*/
domainName?: string;
}
export class Resource$Entity {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* domainsrdap.entity.get
* @desc The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error.
* @alias domainsrdap.entity.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.entityId
* @param {object} [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$Entity$Get, options?: MethodOptions): GaxiosPromise<Schema$RdapResponse>;
get(params: Params$Resource$Entity$Get, options: MethodOptions | BodyResponseCallback<Schema$RdapResponse>, callback: BodyResponseCallback<Schema$RdapResponse>): void;
get(params: Params$Resource$Entity$Get, callback: BodyResponseCallback<Schema$RdapResponse>): void;
get(callback: BodyResponseCallback<Schema$RdapResponse>): void;
}
export interface Params$Resource$Entity$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
*
*/
entityId?: string;
}
export class Resource$Ip {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* domainsrdap.ip.get
* @desc The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error.
* @alias domainsrdap.ip.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.ipId
* @param {string} params.ipId1
* @param {object} [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$Ip$Get, options?: MethodOptions): GaxiosPromise<Schema$RdapResponse>;
get(params: Params$Resource$Ip$Get, options: MethodOptions | BodyResponseCallback<Schema$RdapResponse>, callback: BodyResponseCallback<Schema$RdapResponse>): void;
get(params: Params$Resource$Ip$Get, callback: BodyResponseCallback<Schema$RdapResponse>): void;
get(callback: BodyResponseCallback<Schema$RdapResponse>): void;
}
export interface Params$Resource$Ip$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
*
*/
ipId?: string;
/**
*
*/
ipId1?: string;
}
export class Resource$Nameserver {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* domainsrdap.nameserver.get
* @desc The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error.
* @alias domainsrdap.nameserver.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.nameserverId
* @param {object} [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$Nameserver$Get, options?: MethodOptions): GaxiosPromise<Schema$RdapResponse>;
get(params: Params$Resource$Nameserver$Get, options: MethodOptions | BodyResponseCallback<Schema$RdapResponse>, callback: BodyResponseCallback<Schema$RdapResponse>): void;
get(params: Params$Resource$Nameserver$Get, callback: BodyResponseCallback<Schema$RdapResponse>): void;
get(callback: BodyResponseCallback<Schema$RdapResponse>): void;
}
export interface Params$Resource$Nameserver$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
*
*/
nameserverId?: string;
}
export class Resource$V1 {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* domainsrdap.getDomains
* @desc The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error.
* @alias domainsrdap.getDomains
* @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
*/
getDomains(params?: Params$Resource$V1$Getdomains, options?: MethodOptions): GaxiosPromise<Schema$RdapResponse>;
getDomains(params: Params$Resource$V1$Getdomains, options: MethodOptions | BodyResponseCallback<Schema$RdapResponse>, callback: BodyResponseCallback<Schema$RdapResponse>): void;
getDomains(params: Params$Resource$V1$Getdomains, callback: BodyResponseCallback<Schema$RdapResponse>): void;
getDomains(callback: BodyResponseCallback<Schema$RdapResponse>): void;
/**
* domainsrdap.getEntities
* @desc The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error.
* @alias domainsrdap.getEntities
* @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
*/
getEntities(params?: Params$Resource$V1$Getentities, options?: MethodOptions): GaxiosPromise<Schema$RdapResponse>;
getEntities(params: Params$Resource$V1$Getentities, options: MethodOptions | BodyResponseCallback<Schema$RdapResponse>, callback: BodyResponseCallback<Schema$RdapResponse>): void;
getEntities(params: Params$Resource$V1$Getentities, callback: BodyResponseCallback<Schema$RdapResponse>): void;
getEntities(callback: BodyResponseCallback<Schema$RdapResponse>): void;
/**
* domainsrdap.getHelp
* @desc Get help information for the RDAP API, including links to documentation.
* @alias domainsrdap.getHelp
* @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
*/
getHelp(params?: Params$Resource$V1$Gethelp, options?: MethodOptions): GaxiosPromise<Schema$HttpBody>;
getHelp(params: Params$Resource$V1$Gethelp, options: MethodOptions | BodyResponseCallback<Schema$HttpBody>, callback: BodyResponseCallback<Schema$HttpBody>): void;
getHelp(params: Params$Resource$V1$Gethelp, callback: BodyResponseCallback<Schema$HttpBody>): void;
getHelp(callback: BodyResponseCallback<Schema$HttpBody>): void;
/**
* domainsrdap.getIp
* @desc The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error.
* @alias domainsrdap.getIp
* @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
*/
getIp(params?: Params$Resource$V1$Getip, options?: MethodOptions): GaxiosPromise<Schema$HttpBody>;
getIp(params: Params$Resource$V1$Getip, options: MethodOptions | BodyResponseCallback<Schema$HttpBody>, callback: BodyResponseCallback<Schema$HttpBody>): void;
getIp(params: Params$Resource$V1$Getip, callback: BodyResponseCallback<Schema$HttpBody>): void;
getIp(callback: BodyResponseCallback<Schema$HttpBody>): void;
/**
* domainsrdap.getNameservers
* @desc The RDAP API recognizes this command from the RDAP specification but does not support it. The response is a formatted 501 error.
* @alias domainsrdap.getNameservers
* @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
*/
getNameservers(params?: Params$Resource$V1$Getnameservers, options?: MethodOptions): GaxiosPromise<Schema$RdapResponse>;
getNameservers(params: Params$Resource$V1$Getnameservers, options: MethodOptions | BodyResponseCallback<Schema$RdapResponse>, callback: BodyResponseCallback<Schema$RdapResponse>): void;
getNameservers(params: Params$Resource$V1$Getnameservers, callback: BodyResponseCallback<Schema$RdapResponse>): void;
getNameservers(callback: BodyResponseCallback<Schema$RdapResponse>): void;
}
export interface Params$Resource$V1$Getdomains extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
}
export interface Params$Resource$V1$Getentities extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
}
export interface Params$Resource$V1$Gethelp extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
}
export interface Params$Resource$V1$Getip extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
}
export interface Params$Resource$V1$Getnameservers extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
}
export {};
}