googleapis
Version:
Google APIs Client Library for Node.js
1,463 lines • 152 kB
TypeScript
/**
* 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 books_v1 {
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;
}
/**
* Books API
*
* Searches for books and manages your Google Books library.
*
* @example
* const {google} = require('googleapis');
* const books = google.books('v1');
*
* @namespace books
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Books
*/
class Books {
context: APIRequestContext;
bookshelves: Resource$Bookshelves;
cloudloading: Resource$Cloudloading;
dictionary: Resource$Dictionary;
familysharing: Resource$Familysharing;
layers: Resource$Layers;
myconfig: Resource$Myconfig;
mylibrary: Resource$Mylibrary;
notification: Resource$Notification;
onboarding: Resource$Onboarding;
personalizedstream: Resource$Personalizedstream;
promooffer: Resource$Promooffer;
series: Resource$Series;
volumes: Resource$Volumes;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
interface Schema$Annotation {
/**
* Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
*/
afterSelectedText?: string;
/**
* Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
*/
beforeSelectedText?: string;
/**
* Selection ranges sent from the client.
*/
clientVersionRanges?: {
cfiRange?: Schema$BooksAnnotationsRange;
contentVersion?: string;
gbImageRange?: Schema$BooksAnnotationsRange;
gbTextRange?: Schema$BooksAnnotationsRange;
imageCfiRange?: Schema$BooksAnnotationsRange;
};
/**
* Timestamp for the created time of this annotation.
*/
created?: string;
/**
* Selection ranges for the most recent content version.
*/
currentVersionRanges?: {
cfiRange?: Schema$BooksAnnotationsRange;
contentVersion?: string;
gbImageRange?: Schema$BooksAnnotationsRange;
gbTextRange?: Schema$BooksAnnotationsRange;
imageCfiRange?: Schema$BooksAnnotationsRange;
};
/**
* User-created data for this annotation.
*/
data?: string;
/**
* Indicates that this annotation is deleted.
*/
deleted?: boolean;
/**
* The highlight style for this annotation.
*/
highlightStyle?: string;
/**
* Id of this annotation, in the form of a GUID.
*/
id?: string;
/**
* Resource type.
*/
kind?: string;
/**
* The layer this annotation is for.
*/
layerId?: string;
layerSummary?: {
allowedCharacterCount?: number;
limitType?: string;
remainingCharacterCount?: number;
};
/**
* Pages that this annotation spans.
*/
pageIds?: string[];
/**
* Excerpt from the volume.
*/
selectedText?: string;
/**
* URL to this resource.
*/
selfLink?: string;
/**
* Timestamp for the last time this annotation was modified.
*/
updated?: string;
/**
* The volume that this annotation belongs to.
*/
volumeId?: string;
}
interface Schema$Annotationdata {
/**
* The type of annotation this data is for.
*/
annotationType?: string;
data?: any;
/**
* Base64 encoded data for this annotation data.
*/
encoded_data?: string;
/**
* Unique id for this annotation data.
*/
id?: string;
/**
* Resource Type
*/
kind?: string;
/**
* The Layer id for this data. *
*/
layerId?: string;
/**
* URL for this resource. *
*/
selfLink?: string;
/**
* Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format).
*/
updated?: string;
/**
* The volume id for this data. *
*/
volumeId?: string;
}
interface Schema$Annotations {
/**
* A list of annotations.
*/
items?: Schema$Annotation[];
/**
* Resource type.
*/
kind?: string;
/**
* Token to pass in for pagination for the next page. This will not be present if this request does not have more results.
*/
nextPageToken?: string;
/**
* Total number of annotations found. This may be greater than the number of notes returned in this response if results have been paginated.
*/
totalItems?: number;
}
interface Schema$Annotationsdata {
/**
* A list of Annotation Data.
*/
items?: Schema$Annotationdata[];
/**
* Resource type
*/
kind?: string;
/**
* Token to pass in for pagination for the next page. This will not be present if this request does not have more results.
*/
nextPageToken?: string;
/**
* The total number of volume annotations found.
*/
totalItems?: number;
}
interface Schema$AnnotationsSummary {
kind?: string;
layers?: Array<{
allowedCharacterCount?: number;
layerId?: string;
limitType?: string;
remainingCharacterCount?: number;
updated?: string;
}>;
}
interface Schema$BooksAnnotationsRange {
/**
* The offset from the ending position.
*/
endOffset?: string;
/**
* The ending position for the range.
*/
endPosition?: string;
/**
* The offset from the starting position.
*/
startOffset?: string;
/**
* The starting position for the range.
*/
startPosition?: string;
}
interface Schema$BooksCloudloadingResource {
author?: string;
processingState?: string;
title?: string;
volumeId?: string;
}
interface Schema$Bookshelf {
/**
* Whether this bookshelf is PUBLIC or PRIVATE.
*/
access?: string;
/**
* Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).
*/
created?: string;
/**
* Description of this bookshelf.
*/
description?: string;
/**
* Id of this bookshelf, only unique by user.
*/
id?: number;
/**
* Resource type for bookshelf metadata.
*/
kind?: string;
/**
* URL to this resource.
*/
selfLink?: string;
/**
* Title of this bookshelf.
*/
title?: string;
/**
* Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).
*/
updated?: string;
/**
* Number of volumes in this bookshelf.
*/
volumeCount?: number;
/**
* Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).
*/
volumesLastUpdated?: string;
}
interface Schema$Bookshelves {
/**
* A list of bookshelves.
*/
items?: Schema$Bookshelf[];
/**
* Resource type.
*/
kind?: string;
}
interface Schema$BooksVolumesRecommendedRateResponse {
consistency_token?: string;
}
interface Schema$Category {
/**
* A list of onboarding categories.
*/
items?: Array<{
badgeUrl?: string;
categoryId?: string;
name?: string;
}>;
/**
* Resource type.
*/
kind?: string;
}
interface Schema$ConcurrentAccessRestriction {
/**
* Whether access is granted for this (user, device, volume).
*/
deviceAllowed?: boolean;
/**
* Resource type.
*/
kind?: string;
/**
* The maximum number of concurrent access licenses for this volume.
*/
maxConcurrentDevices?: number;
/**
* Error/warning message.
*/
message?: string;
/**
* Client nonce for verification. Download access and client-validation only.
*/
nonce?: string;
/**
* Error/warning reason code.
*/
reasonCode?: string;
/**
* Whether this volume has any concurrent access restrictions.
*/
restricted?: boolean;
/**
* Response signature.
*/
signature?: string;
/**
* Client app identifier for verification. Download access and client-validation only.
*/
source?: string;
/**
* Time in seconds for license auto-expiration.
*/
timeWindowSeconds?: number;
/**
* Identifies the volume for which this entry applies.
*/
volumeId?: string;
}
interface Schema$Dictlayerdata {
common?: {
title?: string;
};
dict?: {
source?: {
attribution?: string;
url?: string;
};
words?: Array<{
derivatives?: Array<{
source?: {
attribution?: string;
url?: string;
};
text?: string;
}>;
examples?: Array<{
source?: {
attribution?: string;
url?: string;
};
text?: string;
}>;
senses?: Array<{
conjugations?: Array<{
type?: string;
value?: string;
}>;
definitions?: Array<{
definition?: string;
examples?: Array<{
source?: {
attribution?: string;
url?: string;
};
text?: string;
}>;
}>;
partOfSpeech?: string;
pronunciation?: string;
pronunciationUrl?: string;
source?: {
attribution?: string;
url?: string;
};
syllabification?: string;
synonyms?: Array<{
source?: {
attribution?: string;
url?: string;
};
text?: string;
}>;
}>;
source?: {
attribution?: string;
url?: string;
};
}>;
};
kind?: string;
}
interface Schema$Discoveryclusters {
clusters?: Array<{
banner_with_content_container?: {
fillColorArgb?: string;
imageUrl?: string;
maskColorArgb?: string;
moreButtonText?: string;
moreButtonUrl?: string;
textColorArgb?: string;
};
subTitle?: string;
title?: string;
totalVolumes?: number;
uid?: string;
volumes?: Schema$Volume[];
}>;
/**
* Resorce type.
*/
kind?: string;
totalClusters?: number;
}
interface Schema$DownloadAccesses {
/**
* A list of download access responses.
*/
downloadAccessList?: Schema$DownloadAccessRestriction[];
/**
* Resource type.
*/
kind?: string;
}
interface Schema$DownloadAccessRestriction {
/**
* If restricted, whether access is granted for this (user, device, volume).
*/
deviceAllowed?: boolean;
/**
* If restricted, the number of content download licenses already acquired (including the requesting client, if licensed).
*/
downloadsAcquired?: number;
/**
* If deviceAllowed, whether access was just acquired with this request.
*/
justAcquired?: boolean;
/**
* Resource type.
*/
kind?: string;
/**
* If restricted, the maximum number of content download licenses for this volume.
*/
maxDownloadDevices?: number;
/**
* Error/warning message.
*/
message?: string;
/**
* Client nonce for verification. Download access and client-validation only.
*/
nonce?: string;
/**
* Error/warning reason code. Additional codes may be added in the future. 0 OK 100 ACCESS_DENIED_PUBLISHER_LIMIT 101 ACCESS_DENIED_LIMIT 200 WARNING_USED_LAST_ACCESS
*/
reasonCode?: string;
/**
* Whether this volume has any download access restrictions.
*/
restricted?: boolean;
/**
* Response signature.
*/
signature?: string;
/**
* Client app identifier for verification. Download access and client-validation only.
*/
source?: string;
/**
* Identifies the volume for which this entry applies.
*/
volumeId?: string;
}
interface Schema$FamilyInfo {
/**
* Resource type.
*/
kind?: string;
/**
* Family membership info of the user that made the request.
*/
membership?: {
acquirePermission?: string;
ageGroup?: string;
allowedMaturityRating?: string;
isInFamily?: boolean;
role?: string;
};
}
interface Schema$Geolayerdata {
common?: {
lang?: string;
previewImageUrl?: string;
snippet?: string;
snippetUrl?: string;
title?: string;
};
geo?: {
boundary?: Array<Array<{
latitude?: number;
longitude?: number;
}>>;
cachePolicy?: string;
countryCode?: string;
latitude?: number;
longitude?: number;
mapType?: string;
viewport?: {
hi?: {
latitude?: number;
longitude?: number;
};
lo?: {
latitude?: number;
longitude?: number;
};
};
zoom?: number;
};
kind?: string;
}
interface Schema$Layersummaries {
/**
* A list of layer summary items.
*/
items?: Schema$Layersummary[];
/**
* Resource type.
*/
kind?: string;
/**
* The total number of layer summaries found.
*/
totalItems?: number;
}
interface Schema$Layersummary {
/**
* The number of annotations for this layer.
*/
annotationCount?: number;
/**
* Link to get data for this annotation.
*/
annotationsDataLink?: string;
/**
* The link to get the annotations for this layer.
*/
annotationsLink?: string;
/**
* The list of annotation types contained for this layer.
*/
annotationTypes?: string[];
/**
* The content version this resource is for.
*/
contentVersion?: string;
/**
* The number of data items for this layer.
*/
dataCount?: number;
/**
* Unique id of this layer summary.
*/
id?: string;
/**
* Resource Type
*/
kind?: string;
/**
* The layer id for this summary.
*/
layerId?: string;
/**
* URL to this resource.
*/
selfLink?: string;
/**
* Timestamp for the last time an item in this layer was updated. (RFC 3339 UTC date-time format).
*/
updated?: string;
/**
* The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
*/
volumeAnnotationsVersion?: string;
/**
* The volume id this resource is for.
*/
volumeId?: string;
}
interface Schema$Metadata {
/**
* A list of offline dictionary metadata.
*/
items?: Array<{
download_url?: string;
encrypted_key?: string;
language?: string;
size?: string;
version?: string;
}>;
/**
* Resource type.
*/
kind?: string;
}
interface Schema$Notification {
body?: string;
/**
* The list of crm experiment ids.
*/
crmExperimentIds?: string[];
doc_id?: string;
doc_type?: string;
dont_show_notification?: boolean;
iconUrl?: string;
is_document_mature?: boolean;
/**
* Resource type.
*/
kind?: string;
notificationGroup?: string;
notification_type?: string;
pcampaign_id?: string;
reason?: string;
show_notification_settings_action?: boolean;
targetUrl?: string;
timeToExpireMs?: string;
title?: string;
}
interface Schema$Offers {
/**
* A list of offers.
*/
items?: Array<{
artUrl?: string;
gservicesKey?: string;
id?: string;
items?: Array<{
author?: string;
canonicalVolumeLink?: string;
coverUrl?: string;
description?: string;
title?: string;
volumeId?: string;
}>;
}>;
/**
* Resource type.
*/
kind?: string;
}
interface Schema$ReadingPosition {
/**
* Position in an EPUB as a CFI.
*/
epubCfiPosition?: string;
/**
* Position in a volume for image-based content.
*/
gbImagePosition?: string;
/**
* Position in a volume for text-based content.
*/
gbTextPosition?: string;
/**
* Resource type for a reading position.
*/
kind?: string;
/**
* Position in a PDF file.
*/
pdfPosition?: string;
/**
* Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
*/
updated?: string;
/**
* Volume id associated with this reading position.
*/
volumeId?: string;
}
interface Schema$RequestAccess {
/**
* A concurrent access response.
*/
concurrentAccess?: Schema$ConcurrentAccessRestriction;
/**
* A download access response.
*/
downloadAccess?: Schema$DownloadAccessRestriction;
/**
* Resource type.
*/
kind?: string;
}
interface Schema$Review {
/**
* Author of this review.
*/
author?: {
displayName?: string;
};
/**
* Review text.
*/
content?: string;
/**
* Date of this review.
*/
date?: string;
/**
* URL for the full review text, for reviews gathered from the web.
*/
fullTextUrl?: string;
/**
* Resource type for a review.
*/
kind?: string;
/**
* Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
*/
rating?: string;
/**
* Information regarding the source of this review, when the review is not from a Google Books user.
*/
source?: {
description?: string;
extraDescription?: string;
url?: string;
};
/**
* Title for this review.
*/
title?: string;
/**
* Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
*/
type?: string;
/**
* Volume that this review is for.
*/
volumeId?: string;
}
interface Schema$Series {
/**
* Resource type.
*/
kind?: string;
series?: Array<{
bannerImageUrl?: string;
imageUrl?: string;
seriesId?: string;
seriesType?: string;
title?: string;
}>;
}
interface Schema$Seriesmembership {
/**
* Resorce type.
*/
kind?: string;
member?: Schema$Volume[];
nextPageToken?: string;
}
interface Schema$Usersettings {
/**
* Resource type.
*/
kind?: string;
/**
* User settings in sub-objects, each for different purposes.
*/
notesExport?: {
folderName?: string;
isEnabled?: boolean;
};
notification?: {
matchMyInterests?: {
opted_state?: string;
};
moreFromAuthors?: {
opted_state?: string;
};
moreFromSeries?: {
opted_state?: string;
};
priceDrop?: {
opted_state?: string;
};
rewardExpirations?: {
opted_state?: string;
};
};
}
interface Schema$Volume {
/**
* Any information about a volume related to reading or obtaining that volume text. This information can depend on country (books may be public domain in one country but not in another, e.g.).
*/
accessInfo?: {
accessViewStatus?: string;
country?: string;
downloadAccess?: Schema$DownloadAccessRestriction;
driveImportedContentLink?: string;
embeddable?: boolean;
epub?: {
acsTokenLink?: string;
downloadLink?: string;
isAvailable?: boolean;
};
explicitOfflineLicenseManagement?: boolean;
pdf?: {
acsTokenLink?: string;
downloadLink?: string;
isAvailable?: boolean;
};
publicDomain?: boolean;
quoteSharingAllowed?: boolean;
textToSpeechPermission?: string;
viewOrderUrl?: string;
viewability?: string;
webReaderLink?: string;
};
/**
* Opaque identifier for a specific version of a volume resource. (In LITE projection)
*/
etag?: string;
/**
* Unique identifier for a volume. (In LITE projection.)
*/
id?: string;
/**
* Resource type for a volume. (In LITE projection.)
*/
kind?: string;
/**
* What layers exist in this volume and high level information about them.
*/
layerInfo?: {
layers?: Array<{
layerId?: string;
volumeAnnotationsVersion?: string;
}>;
};
/**
* Recommendation related information for this volume.
*/
recommendedInfo?: {
explanation?: string;
};
/**
* Any information about a volume related to the eBookstore and/or purchaseability. This information can depend on the country where the request originates from (i.e. books may not be for sale in certain countries).
*/
saleInfo?: {
buyLink?: string;
country?: string;
isEbook?: boolean;
listPrice?: {
amount?: number;
currencyCode?: string;
};
offers?: Array<{
finskyOfferType?: number;
giftable?: boolean;
listPrice?: {
amountInMicros?: number;
currencyCode?: string;
};
rentalDuration?: {
count?: number;
unit?: string;
};
retailPrice?: {
amountInMicros?: number;
currencyCode?: string;
};
}>;
onSaleDate?: string;
retailPrice?: {
amount?: number;
currencyCode?: string;
};
saleability?: string;
};
/**
* Search result information related to this volume.
*/
searchInfo?: {
textSnippet?: string;
};
/**
* URL to this resource. (In LITE projection.)
*/
selfLink?: string;
/**
* User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
*/
userInfo?: {
acquiredTime?: string;
acquisitionType?: number;
copy?: {
allowedCharacterCount?: number;
limitType?: string;
remainingCharacterCount?: number;
updated?: string;
};
entitlementType?: number;
familySharing?: {
familyRole?: string;
isSharingAllowed?: boolean;
isSharingDisabledByFop?: boolean;
};
isFamilySharedFromUser?: boolean;
isFamilySharedToUser?: boolean;
isFamilySharingAllowed?: boolean;
isFamilySharingDisabledByFop?: boolean;
isInMyBooks?: boolean;
isPreordered?: boolean;
isPurchased?: boolean;
isUploaded?: boolean;
readingPosition?: Schema$ReadingPosition;
rentalPeriod?: {
endUtcSec?: string;
startUtcSec?: string;
};
rentalState?: string;
review?: Schema$Review;
updated?: string;
userUploadedVolumeInfo?: {
processingState?: string;
};
};
/**
* General volume information.
*/
volumeInfo?: {
allowAnonLogging?: boolean;
authors?: string[];
averageRating?: number;
canonicalVolumeLink?: string;
categories?: string[];
comicsContent?: boolean;
contentVersion?: string;
description?: string;
dimensions?: {
height?: string;
thickness?: string;
width?: string;
};
imageLinks?: {
extraLarge?: string;
large?: string;
medium?: string;
small?: string;
smallThumbnail?: string;
thumbnail?: string;
};
industryIdentifiers?: Array<{
identifier?: string;
type?: string;
}>;
infoLink?: string;
language?: string;
mainCategory?: string;
maturityRating?: string;
pageCount?: number;
panelizationSummary?: {
containsEpubBubbles?: boolean;
containsImageBubbles?: boolean;
epubBubbleVersion?: string;
imageBubbleVersion?: string;
};
previewLink?: string;
printType?: string;
printedPageCount?: number;
publishedDate?: string;
publisher?: string;
ratingsCount?: number;
readingModes?: any;
samplePageCount?: number;
seriesInfo?: Schema$Volumeseriesinfo;
subtitle?: string;
title?: string;
};
}
interface Schema$Volume2 {
/**
* A list of volumes.
*/
items?: Schema$Volume[];
/**
* Resource type.
*/
kind?: string;
nextPageToken?: string;
}
interface Schema$Volumeannotation {
/**
* The annotation data id for this volume annotation.
*/
annotationDataId?: string;
/**
* Link to get data for this annotation.
*/
annotationDataLink?: string;
/**
* The type of annotation this is.
*/
annotationType?: string;
/**
* The content ranges to identify the selected text.
*/
contentRanges?: {
cfiRange?: Schema$BooksAnnotationsRange;
contentVersion?: string;
gbImageRange?: Schema$BooksAnnotationsRange;
gbTextRange?: Schema$BooksAnnotationsRange;
};
/**
* Data for this annotation.
*/
data?: string;
/**
* Indicates that this annotation is deleted.
*/
deleted?: boolean;
/**
* Unique id of this volume annotation.
*/
id?: string;
/**
* Resource Type
*/
kind?: string;
/**
* The Layer this annotation is for.
*/
layerId?: string;
/**
* Pages the annotation spans.
*/
pageIds?: string[];
/**
* Excerpt from the volume.
*/
selectedText?: string;
/**
* URL to this resource.
*/
selfLink?: string;
/**
* Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format).
*/
updated?: string;
/**
* The Volume this annotation is for.
*/
volumeId?: string;
}
interface Schema$Volumeannotations {
/**
* A list of volume annotations.
*/
items?: Schema$Volumeannotation[];
/**
* Resource type
*/
kind?: string;
/**
* Token to pass in for pagination for the next page. This will not be present if this request does not have more results.
*/
nextPageToken?: string;
/**
* The total number of volume annotations found.
*/
totalItems?: number;
/**
* The version string for all of the volume annotations in this layer (not just the ones in this response). Note: the version string doesn't apply to the annotation data, just the information in this response (e.g. the location of annotations in the book).
*/
version?: string;
}
interface Schema$Volumes {
/**
* A list of volumes.
*/
items?: Schema$Volume[];
/**
* Resource type.
*/
kind?: string;
/**
* Total number of volumes found. This might be greater than the number of volumes returned in this response if results have been paginated.
*/
totalItems?: number;
}
interface Schema$Volumeseriesinfo {
/**
* The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber.
*/
bookDisplayNumber?: string;
/**
* Resource type.
*/
kind?: string;
/**
* Short book title in the context of the series.
*/
shortSeriesBookTitle?: string;
volumeSeries?: Array<{
issue?: Array<{
issueDisplayNumber?: string;
issueOrderNumber?: number;
}>;
orderNumber?: number;
seriesBookType?: string;
seriesId?: string;
}>;
}
class Resource$Bookshelves {
context: APIRequestContext;
volumes: Resource$Bookshelves$Volumes;
constructor(context: APIRequestContext);
/**
* books.bookshelves.get
* @desc Retrieves metadata for a specific bookshelf for the specified user.
* @alias books.bookshelves.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.shelf ID of bookshelf to retrieve.
* @param {string=} params.source String to identify the originator of this request.
* @param {string} params.userId ID of user for whom to retrieve bookshelves.
* @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$Bookshelves$Get, options?: MethodOptions): GaxiosPromise<Schema$Bookshelf>;
get(params: Params$Resource$Bookshelves$Get, options: MethodOptions | BodyResponseCallback<Schema$Bookshelf>, callback: BodyResponseCallback<Schema$Bookshelf>): void;
get(params: Params$Resource$Bookshelves$Get, callback: BodyResponseCallback<Schema$Bookshelf>): void;
get(callback: BodyResponseCallback<Schema$Bookshelf>): void;
/**
* books.bookshelves.list
* @desc Retrieves a list of public bookshelves for the specified user.
* @alias books.bookshelves.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.source String to identify the originator of this request.
* @param {string} params.userId ID of user for whom to retrieve bookshelves.
* @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$Bookshelves$List, options?: MethodOptions): GaxiosPromise<Schema$Bookshelves>;
list(params: Params$Resource$Bookshelves$List, options: MethodOptions | BodyResponseCallback<Schema$Bookshelves>, callback: BodyResponseCallback<Schema$Bookshelves>): void;
list(params: Params$Resource$Bookshelves$List, callback: BodyResponseCallback<Schema$Bookshelves>): void;
list(callback: BodyResponseCallback<Schema$Bookshelves>): void;
}
interface Params$Resource$Bookshelves$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* ID of bookshelf to retrieve.
*/
shelf?: string;
/**
* String to identify the originator of this request.
*/
source?: string;
/**
* ID of user for whom to retrieve bookshelves.
*/
userId?: string;
}
interface Params$Resource$Bookshelves$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* String to identify the originator of this request.
*/
source?: string;
/**
* ID of user for whom to retrieve bookshelves.
*/
userId?: string;
}
class Resource$Bookshelves$Volumes {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* books.bookshelves.volumes.list
* @desc Retrieves volumes in a specific bookshelf for the specified user.
* @alias books.bookshelves.volumes.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.maxResults Maximum number of results to return
* @param {string} params.shelf ID of bookshelf to retrieve volumes.
* @param {boolean=} params.showPreorders Set to true to show pre-ordered books. Defaults to false.
* @param {string=} params.source String to identify the originator of this request.
* @param {integer=} params.startIndex Index of the first element to return (starts at 0)
* @param {string} params.userId ID of user for whom to retrieve bookshelf volumes.
* @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$Bookshelves$Volumes$List, options?: MethodOptions): GaxiosPromise<Schema$Volumes>;
list(params: Params$Resource$Bookshelves$Volumes$List, options: MethodOptions | BodyResponseCallback<Schema$Volumes>, callback: BodyResponseCallback<Schema$Volumes>): void;
list(params: Params$Resource$Bookshelves$Volumes$List, callback: BodyResponseCallback<Schema$Volumes>): void;
list(callback: BodyResponseCallback<Schema$Volumes>): void;
}
interface Params$Resource$Bookshelves$Volumes$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Maximum number of results to return
*/
maxResults?: number;
/**
* ID of bookshelf to retrieve volumes.
*/
shelf?: string;
/**
* Set to true to show pre-ordered books. Defaults to false.
*/
showPreorders?: boolean;
/**
* String to identify the originator of this request.
*/
source?: string;
/**
* Index of the first element to return (starts at 0)
*/
startIndex?: number;
/**
* ID of user for whom to retrieve bookshelf volumes.
*/
userId?: string;
}
class Resource$Cloudloading {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* books.cloudloading.addBook
* @alias books.cloudloading.addBook
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {string=} params.drive_document_id A drive document id. The upload_client_token must not be set.
* @param {string=} params.mime_type The document MIME type. It can be set only if the drive_document_id is set.
* @param {string=} params.name The document name. It can be set only if the drive_document_id is set.
* @param {string=} params.upload_client_token
* @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
*/
addBook(params?: Params$Resource$Cloudloading$Addbook, options?: MethodOptions): GaxiosPromise<Schema$BooksCloudloadingResource>;
addBook(params: Params$Resource$Cloudloading$Addbook, options: MethodOptions | BodyResponseCallback<Schema$BooksCloudloadingResource>, callback: BodyResponseCallback<Schema$BooksCloudloadingResource>): void;
addBook(params: Params$Resource$Cloudloading$Addbook, callback: BodyResponseCallback<Schema$BooksCloudloadingResource>): void;
addBook(callback: BodyResponseCallback<Schema$BooksCloudloadingResource>): void;
/**
* books.cloudloading.deleteBook
* @desc Remove the book and its contents
* @alias books.cloudloading.deleteBook
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.volumeId The id of the book to be removed.
* @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
*/
deleteBook(params?: Params$Resource$Cloudloading$Deletebook, options?: MethodOptions): GaxiosPromise<void>;
deleteBook(params: Params$Resource$Cloudloading$Deletebook, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
deleteBook(params: Params$Resource$Cloudloading$Deletebook, callback: BodyResponseCallback<void>): void;
deleteBook(callback: BodyResponseCallback<void>): void;
/**
* books.cloudloading.updateBook
* @alias books.cloudloading.updateBook
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().BooksCloudloadingResource} 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
*/
updateBook(params?: Params$Resource$Cloudloading$Updatebook, options?: MethodOptions): GaxiosPromise<Schema$BooksCloudloadingResource>;
updateBook(params: Params$Resource$Cloudloading$Updatebook, options: MethodOptions | BodyResponseCallback<Schema$BooksCloudloadingResource>, callback: BodyResponseCallback<Schema$BooksCloudloadingResource>): void;
updateBook(params: Params$Resource$Cloudloading$Updatebook, callback: BodyResponseCallback<Schema$BooksCloudloadingResource>): void;
updateBook(callback: BodyResponseCallback<Schema$BooksCloudloadingResource>): void;
}
interface Params$Resource$Cloudloading$Addbook extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* A drive document id. The upload_client_token must not be set.
*/
drive_document_id?: string;
/**
* The document MIME type. It can be set only if the drive_document_id is set.
*/
mime_type?: string;
/**
* The document name. It can be set only if the drive_document_id is set.
*/
name?: string;
/**
*
*/
upload_client_token?: string;
}
interface Params$Resource$Cloudloading$Deletebook extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The id of the book to be removed.
*/
volumeId?: string;
}
interface Params$Resource$Cloudloading$Updatebook extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$BooksCloudloadingResource;
}
class Resource$Dictionary {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* books.dictionary.listOfflineMetadata
* @desc Returns a list of offline dictionary metadata available
* @alias books.dictionary.listOfflineMetadata
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.cpksver The device/version ID from which to request the 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
*/
listOfflineMetadata(params?: Params$Resource$Dictionary$Listofflinemetadata, options?: MethodOptions): GaxiosPromise<Schema$Metadata>;
listOfflineMetadata(params: Params$Resource$Dictionary$Listofflinemetadata, options: MethodOptions | BodyResponseCallback<Schema$Metadata>, callback: BodyResponseCallback<Schema$Metadata>): void;
listOfflineMetadata(params: Params$Resource$Dictionary$Listofflinemetadata, callback: BodyResponseCallback<Schema$Metadata>): void;
listOfflineMetadata(callback: BodyResponseCallback<Schema$Metadata>): void;
}
interface Params$Resource$Dictionary$Listofflinemetadata extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The device/version ID from which to request the data.
*/
cpksver?: string;
}
class Resource$Familysharing {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* books.familysharing.getFamilyInfo
* @desc Gets information regarding the family that the user is part of.
* @alias books.familysharing.getFamilyInfo
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {string=} params.source String to identify the originator of this 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
*/
getFamilyInfo(params?: Params$Resource$Familysharing$Getfamilyinfo, options?: MethodOptions): GaxiosPromise<Schema$FamilyInfo>;
getFamilyInfo(params: Params$Resource$Familysharing$Getfamilyinfo, options: MethodOptions | BodyResponseCallback<Schema$FamilyInfo>, callback: BodyResponseCallback<Schema$FamilyInfo>): void;
getFamilyInfo(params: Params$Resource$Familysharing$Getfamilyinfo, callback: BodyResponseCallback<Schema$FamilyInfo>): void;
getFamilyInfo(callback: BodyResponseCallback<Schema$FamilyInfo>): void;
/**
* books.familysharing.share
* @desc Initiates sharing of the content with the user's family. Empty response indicates success.
* @alias books.familysharing.share
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {string=} params.docId The docid to share.
* @param {string=} params.source String to identify the originator of this request.
* @param {string=} params.volumeId The volume to share.
* @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
*/
share(params?: Params$Resource$Familysharing$Share, options?: MethodOptions): GaxiosPromise<void>;
s