googleapis.d.ts
2.19 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
import { GeneratedAPIs } from './apis';
import { AuthPlus, APIEndpoint, Endpoint, GlobalOptions } from 'googleapis-common';
export { AuthPlus };
export declare class GoogleApis extends GeneratedAPIs {
private _discovery;
auth: AuthPlus;
_options: GlobalOptions;
[index: string]: APIEndpoint;
/**
* GoogleApis constructor.
*
* @example
* ```js
* const GoogleApis = require('googleapis').GoogleApis;
* const google = new GoogleApis();
* ```
*
* @param options - Configuration options.
*/
constructor(options?: GlobalOptions);
/**
* Obtain a Map of supported APIs, along with included API versions.
*/
getSupportedAPIs(): {
[index: string]: string[];
};
/**
* Set options.
*
* @param options - Configuration options.
*/
options(options?: GlobalOptions): void;
/**
* Add APIs endpoints to googleapis object
* E.g. googleapis.drive and googleapis.datastore
*
* @param apisToAdd - Apis to be added to this GoogleApis instance.
*/
private addAPIs;
/**
* Dynamically generate an apis object that can provide Endpoint objects for
* the discovered APIs.
*
* @example
* ```js
* const {google} = require('googleapis');
* const discoveryUrl = 'https://myapp.appspot.com/_ah/api/discovery/v1/apis/';
* google.discover(discoveryUrl, function (err) {
* const someapi = google.someapi('v1');
* });
* ```
*
* @param url - Url to the discovery service for a set of APIs. e.g. https://www.googleapis.com/discovery/v1/apis
* @param callback - Callback function.
*/
discover(url: string): Promise<void>;
discover(url: string, callback: (err?: Error) => void): void;
private discoverAsync;
/**
* Dynamically generate an Endpoint object from a discovery doc.
*
* @param path - Url or file path to discover doc for a single API.
* @param options - Options to configure the Endpoint object generated from the discovery doc.
* @returns A promise that resolves with the configured endpoint.
*/
discoverAPI<T = Endpoint>(apiPath: string, options?: {}): Promise<Readonly<T>>;
}