Package googleapis-common (6.0.3)

Stay organized with collections Save and categorize content based on your preferences.

Classes

AuthPlus

Discovery

Endpoint

Interfaces

APIRequestContext

APIRequestParams

DiscoveryOptions

FragmentResponse

GlobalOptions

This interface is a mix of the AxiosRequestConfig options and our auth options.

GoogleConfigurable

MethodOptions

Schema

SchemaItem

SchemaItems

SchemaMethod

SchemaMethods

SchemaParameter

SchemaParameters

SchemaResource

SchemaResources

Schemas

These are a collection of interfaces that represent the GoogleApis Discovery json formats.

ServiceOptions

StreamMethodOptions

Target

Functions

createAPIRequest(parameters)

export declare function createAPIRequest

Create and send request to Google API

Parameter
NameDescription
parametersAPIRequestParams

Parameters used to form request

Returns
TypeDescription
GaxiosPromise<T>
Type Parameter
TypeDescription
T

createAPIRequest(parameters, callback)

export declare function createAPIRequest
Parameters
NameDescription
parametersAPIRequestParams
callbackBodyResponseCallback<T>
Returns
TypeDescription
void
Type Parameter
TypeDescription
T

getAPI(api, options, versions, context)

export declare function getAPI
Parameters
NameDescription
apistring
optionsServiceOptions | string
versions{ [index: string]: any; }
contextGoogleConfigurable
Returns
TypeDescription
T
Type Parameter
TypeDescription
T

Type Aliases

APIEndpoint

export declare type APIEndpoint = Readonly

BodyResponseCallback

export declare type BodyResponseCallback
Type Parameter
TypeDescription
T

EndpointCreator

export declare type EndpointCreator = (options: GlobalOptions, google: {}) => Endpoint;

HttpMethod

export declare type HttpMethod = 'GET' | 'PATCH' | 'PUT';

ParameterFormat

export declare type ParameterFormat = 'int32';

SchemaType

export declare type SchemaType = 'object' | 'integer' | 'string' | 'array' | 'boolean';