Package googleapis-common (7.1.0)

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
Name Description
parameters APIRequestParams

Parameters used to form request
Returns
Type Description
GaxiosPromise<T>
Type Parameter
Type Description
T

createAPIRequest(parameters, callback)

export declare function createAPIRequest
Parameters
Name Description
parameters APIRequestParams
callback BodyResponseCallback<T>
Returns
Type Description
void
Type Parameter
Type Description
T

getAPI(api, options, versions, context)

export declare function getAPI
Parameters
Name Description
api string
options ServiceOptions | string
versions { [index: string]: any; }
context GoogleConfigurable
Returns
Type Description
T
Type Parameter
Type Description
T

Type Aliases

APIEndpoint

export type APIEndpoint = Readonly

BodyResponseCallback

export type BodyResponseCallback
Type Parameter
Type Description
T

EndpointCreator

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

HttpMethod

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

ParameterFormat

export type ParameterFormat = 'int32';

SchemaType

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