googleapis
Version:
Google APIs Client Library for Node.js
1,344 lines • 80.9 kB
TypeScript
/**
* Copyright 2015 Google Inc. All Rights Reserved.
*
* 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 { AxiosPromise } from 'axios';
import { GoogleApis } from '../..';
import { BodyResponseCallback, GlobalOptions, MethodOptions } from '../../lib/api';
/**
* 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
*/
export declare class Books {
_options: GlobalOptions;
google: GoogleApis;
root: this;
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: GoogleApis);
getRoot(): this;
}
export 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: any;
/**
* Timestamp for the created time of this annotation.
*/
created: string;
/**
* Selection ranges for the most recent content version.
*/
currentVersionRanges: any;
/**
* 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: any;
/**
* 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;
}
export 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;
}
export 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;
}
export 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;
}
export interface Schema$AnnotationsSummary {
kind: string;
layers: any[];
}
export 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;
}
export interface Schema$BooksCloudloadingResource {
author: string;
processingState: string;
title: string;
volumeId: string;
}
export 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;
}
export interface Schema$Bookshelves {
/**
* A list of bookshelves.
*/
items: Schema$Bookshelf[];
/**
* Resource type.
*/
kind: string;
}
export interface Schema$BooksVolumesRecommendedRateResponse {
consistency_token: string;
}
export interface Schema$Category {
/**
* A list of onboarding categories.
*/
items: any[];
/**
* Resource type.
*/
kind: string;
}
export 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;
}
export interface Schema$Dictlayerdata {
common: any;
dict: any;
kind: string;
}
export interface Schema$Discoveryclusters {
clusters: any[];
/**
* Resorce type.
*/
kind: string;
totalClusters: number;
}
export interface Schema$DownloadAccesses {
/**
* A list of download access responses.
*/
downloadAccessList: Schema$DownloadAccessRestriction[];
/**
* Resource type.
*/
kind: string;
}
export 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;
}
export interface Schema$FamilyInfo {
/**
* Resource type.
*/
kind: string;
/**
* Family membership info of the user that made the request.
*/
membership: any;
}
export interface Schema$Geolayerdata {
common: any;
geo: any;
kind: string;
}
export 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;
}
export 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;
}
export interface Schema$Metadata {
/**
* A list of offline dictionary metadata.
*/
items: any[];
/**
* Resource type.
*/
kind: string;
}
export 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;
/**
* Resource type.
*/
kind: string;
notificationGroup: string;
notification_type: string;
pcampaign_id: string;
reason: string;
show_notification_settings_action: boolean;
targetUrl: string;
title: string;
}
export interface Schema$Offers {
/**
* A list of offers.
*/
items: any[];
/**
* Resource type.
*/
kind: string;
}
export 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;
}
export interface Schema$RequestAccess {
/**
* A concurrent access response.
*/
concurrentAccess: Schema$ConcurrentAccessRestriction;
/**
* A download access response.
*/
downloadAccess: Schema$DownloadAccessRestriction;
/**
* Resource type.
*/
kind: string;
}
export interface Schema$Review {
/**
* Author of this review.
*/
author: any;
/**
* 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: any;
/**
* 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;
}
export interface Schema$Series {
/**
* Resource type.
*/
kind: string;
series: any[];
}
export interface Schema$Seriesmembership {
/**
* Resorce type.
*/
kind: string;
member: Schema$Volume[];
nextPageToken: string;
}
export interface Schema$Usersettings {
/**
* Resource type.
*/
kind: string;
/**
* User settings in sub-objects, each for different purposes.
*/
notesExport: any;
notification: any;
}
export 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: any;
/**
* 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: any;
/**
* Recommendation related information for this volume.
*/
recommendedInfo: any;
/**
* 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: any;
/**
* Search result information related to this volume.
*/
searchInfo: any;
/**
* 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: any;
/**
* General volume information.
*/
volumeInfo: any;
}
export interface Schema$Volume2 {
/**
* A list of volumes.
*/
items: Schema$Volume[];
/**
* Resource type.
*/
kind: string;
nextPageToken: string;
}
export 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: any;
/**
* 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;
}
export 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;
}
export 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;
}
export 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: any[];
}
export declare class Resource$Bookshelves {
root: Books;
volumes: Resource$Bookshelves$Volumes;
constructor(root: Books);
getRoot(): Books;
/**
* 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?: any, options?: MethodOptions): AxiosPromise<Schema$Bookshelf>;
get(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Bookshelf>, 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?: any, options?: MethodOptions): AxiosPromise<Schema$Bookshelves>;
list(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Bookshelves>, callback?: BodyResponseCallback<Schema$Bookshelves>): void;
}
export declare class Resource$Bookshelves$Volumes {
root: Books;
constructor(root: Books);
getRoot(): Books;
/**
* 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?: any, options?: MethodOptions): AxiosPromise<Schema$Volumes>;
list(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Volumes>, callback?: BodyResponseCallback<Schema$Volumes>): void;
}
export declare class Resource$Cloudloading {
root: Books;
constructor(root: Books);
getRoot(): Books;
/**
* 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?: any, options?: MethodOptions): AxiosPromise<Schema$BooksCloudloadingResource>;
addBook(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$BooksCloudloadingResource>, 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?: any, options?: MethodOptions): AxiosPromise<void>;
deleteBook(params?: any, options?: MethodOptions | BodyResponseCallback<void>, 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?: any, options?: MethodOptions): AxiosPromise<Schema$BooksCloudloadingResource>;
updateBook(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$BooksCloudloadingResource>, callback?: BodyResponseCallback<Schema$BooksCloudloadingResource>): void;
}
export declare class Resource$Dictionary {
root: Books;
constructor(root: Books);
getRoot(): Books;
/**
* 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?: any, options?: MethodOptions): AxiosPromise<Schema$Metadata>;
listOfflineMetadata(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Metadata>, callback?: BodyResponseCallback<Schema$Metadata>): void;
}
export declare class Resource$Familysharing {
root: Books;
constructor(root: Books);
getRoot(): Books;
/**
* 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?: any, options?: MethodOptions): AxiosPromise<Schema$FamilyInfo>;
getFamilyInfo(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$FamilyInfo>, 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?: any, options?: MethodOptions): AxiosPromise<void>;
share(params?: any, options?: MethodOptions | BodyResponseCallback<void>, callback?: BodyResponseCallback<void>): void;
/**
* books.familysharing.unshare
* @desc Initiates revoking content that has already been shared with the
* user's family. Empty response indicates success.
* @alias books.familysharing.unshare
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {string=} params.docId The docid to unshare.
* @param {string=} params.source String to identify the originator of this request.
* @param {string=} params.volumeId The volume to unshare.
* @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
*/
unshare(params?: any, options?: MethodOptions): AxiosPromise<void>;
unshare(params?: any, options?: MethodOptions | BodyResponseCallback<void>, callback?: BodyResponseCallback<void>): void;
}
export declare class Resource$Layers {
root: Books;
annotationData: Resource$Layers$Annotationdata;
volumeAnnotations: Resource$Layers$Volumeannotations;
constructor(root: Books);
getRoot(): Books;
/**
* books.layers.get
* @desc Gets the layer summary for a volume.
* @alias books.layers.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.contentVersion The content version for the requested volume.
* @param {string=} params.source String to identify the originator of this request.
* @param {string} params.summaryId The ID for the layer to get the summary for.
* @param {string} params.volumeId The volume to retrieve layers for.
* @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?: any, options?: MethodOptions): AxiosPromise<Schema$Layersummary>;
get(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Layersummary>, callback?: BodyResponseCallback<Schema$Layersummary>): void;
/**
* books.layers.list
* @desc List the layer summaries for a volume.
* @alias books.layers.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.contentVersion The content version for the requested volume.
* @param {integer=} params.maxResults Maximum number of results to return
* @param {string=} params.pageToken The value of the nextToken from the previous page.
* @param {string=} params.source String to identify the originator of this request.
* @param {string} params.volumeId The volume to retrieve layers for.
* @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?: any, options?: MethodOptions): AxiosPromise<Schema$Layersummaries>;
list(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Layersummaries>, callback?: BodyResponseCallback<Schema$Layersummaries>): void;
}
export declare class Resource$Layers$Annotationdata {
root: Books;
constructor(root: Books);
getRoot(): Books;
/**
* books.layers.annotationData.get
* @desc Gets the annotation data.
* @alias books.layers.annotationData.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.allowWebDefinitions For the dictionary layer. Whether or not to allow web definitions.
* @param {string} params.annotationDataId The ID of the annotation data to retrieve.
* @param {string} params.contentVersion The content version for the volume you are trying to retrieve.
* @param {integer=} params.h The requested pixel height for any images. If height is provided width must also be provided.
* @param {string} params.layerId The ID for the layer to get the annotations.
* @param {string=} params.locale The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
* @param {integer=} params.scale The requested scale for the image.
* @param {string=} params.source String to identify the originator of this request.
* @param {string} params.volumeId The volume to retrieve annotations for.
* @param {integer=} params.w The requested pixel width for any images. If width is provided height must also be provided.
* @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?: any, options?: MethodOptions): AxiosPromise<Schema$Annotationdata>;
get(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Annotationdata>, callback?: BodyResponseCallback<Schema$Annotationdata>): void;
/**
* books.layers.annotationData.list
* @desc Gets the annotation data for a volume and layer.
* @alias books.layers.annotationData.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.annotationDataId The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set.
* @param {string} params.contentVersion The content version for the requested volume.
* @param {integer=} params.h The requested pixel height for any images. If height is provided width must also be provided.
* @param {string} params.layerId The ID for the layer to get the annotation data.
* @param {string=} params.locale The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
* @param {integer=} params.maxResults Maximum number of results to return
* @param {string=} params.pageToken The value of the nextToken from the previous page.
* @param {integer=} params.scale The requested scale for the image.
* @param {string=} params.source String to identify the originator of this request.
* @param {string=} params.updatedMax RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
* @param {string=} params.updatedMin RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
* @param {string} params.volumeId The volume to retrieve annotation data for.
* @param {integer=} params.w The requested pixel width for any images. If width is provided height must also be provided.
* @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?: any, options?: MethodOptions): AxiosPromise<Schema$Annotationsdata>;
list(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Annotationsdata>, callback?: BodyResponseCallback<Schema$Annotationsdata>): void;
}
export declare class Resource$Layers$Volumeannotations {
root: Books;
constructor(root: Books);
getRoot(): Books;
/**
* books.layers.volumeAnnotations.get
* @desc Gets the volume annotation.
* @alias books.layers.volumeAnnotations.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.annotationId The ID of the volume annotation to retrieve.
* @param {string} params.layerId The ID for the layer to get the annotations.
* @param {string=} params.locale The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
* @param {string=} params.source String to identify the originator of this request.
* @param {string} params.volumeId The volume to retrieve annotations for.
* @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?: any, options?: MethodOptions): AxiosPromise<Schema$Volumeannotation>;
get(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Volumeannotation>, callback?: BodyResponseCallback<Schema$Volumeannotation>): void;
/**
* books.layers.volumeAnnotations.list
* @desc Gets the volume annotations for a volume and layer.
* @alias books.layers.volumeAnnotations.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.contentVersion The content version for the requested volume.
* @param {string=} params.endOffset The end offset to end retrieving data from.
* @param {string=} params.endPosition The end position to end retrieving data from.
* @param {string} params.layerId The ID for the layer to get the annotations.
* @param {string=} params.locale The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
* @param {integer=} params.maxResults Maximum number of results to return
* @param {string=} params.pageToken The value of the nextToken from the previous page.
* @param {boolean=} params.showDeleted Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.
* @param {string=} params.source String to identify the originator of this request.
* @param {string=} params.startOffset The start offset to start retrieving data from.
* @param {string=} params.startPosition The start position to start retrieving data from.
* @param {string=} params.updatedMax RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
* @param {string=} params.updatedMin RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
* @param {string=} params.volumeAnnotationsVersion The version of the volume annotations that you are requesting.
* @param {string} params.volumeId The volume to retrieve annotations for.
* @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?: any, options?: MethodOptions): AxiosPromise<Schema$Volumeannotations>;
list(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Volumeannotations>, callback?: BodyResponseCallback<Schema$Volumeannotations>): void;
}
export declare class Resource$Myconfig {
root: Books;
constructor(root: Books);
getRoot(): Books;
/**
* books.myconfig.getUserSettings
* @desc Gets the current settings for the user.
* @alias books.myconfig.getUserSettings
* @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
*/
getUserSettings(params?: any, options?: MethodOptions): AxiosPromise<Schema$Usersettings>;
getUserSettings(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Usersettings>, callback?: BodyResponseCallback<Schema$Usersettings>): void;
/**
* books.myconfig.releaseDownloadAccess
* @desc Release downloaded content access restriction.
* @alias books.myconfig.releaseDownloadAccess
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.cpksver The device/version ID from which to release the restriction.
* @param {string=} params.locale ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.
* @param {string=} params.source String to identify the originator of this request.
* @param {string} params.volumeIds The volume(s) to release restrictions for.
* @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
*/
releaseDownloadAccess(params?: any, options?: MethodOptions): AxiosPromise<Schema$DownloadAccesses>;
releaseDownloadAccess(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$DownloadAccesses>, callback?: BodyResponseCallback<Schema$DownloadAccesses>): void;
/**
* books.myconfig.requestAccess
* @desc Request concurrent and download access restrictions.
* @alias books.myconfig.requestAccess
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.cpksver The device/version ID from which to request the restrictions.
* @param {string=} params.licenseTypes The type of access license to request. If not specified, the default is BOTH.
* @param {string=} params.locale ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.
* @param {string} params.nonce The client nonce value.
* @param {string} params.source String to identify the originator of this request.
* @param {string} params.volumeId The volume to request concurrent/download restrictions for.
* @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
*/
requestAccess(params?: any, options?: MethodOptions): AxiosPromise<Schema$RequestAccess>;
requestAccess(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$RequestAccess>, callback?: BodyResponseCallback<Schema$RequestAccess>): void;
/**
* books.myconfig.syncVolumeLicenses
* @desc Request downloaded content access for specified volumes on the My
* eBooks shelf.
* @alias books.myconfig.syncVolumeLicenses
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.cpksver The device/version ID from which to release the restriction.
* @param {string=} params.features List of features supported by the client, i.e., 'RENTALS'
* @param {boolean=} params.includeNonComicsSeries Set to true to include non-comics series. Defaults to false.
* @param {string=} params.locale ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.
* @param {string} params.nonce The client nonce value.
* @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 {string=} params.volumeIds The volume(s) to request download restrictions for.
* @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
*/
syncVolumeLicenses(params?: any, options?: MethodOptions): AxiosPromise<Schema$Volumes>;
syncVolumeLicenses(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Volumes>, callback?: BodyResponseCallback<Schema$Volumes>): void;
/**
* books.myconfig.updateUserSettings
* @desc Sets the settings for the user. If a sub-object is specified, it will
* overwrite the existing sub-object stored in the server. Unspecified
* sub-objects will retain the existing value.
* @alias books.myconfig.updateUserSettings
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().Usersettings} 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
*/
updateUserSettings(params?: any, options?: MethodOptions): AxiosPromise<Schema$Usersettings>;
updateUserSettings(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Usersettings>, callback?: BodyResponseCallback<Schema$Usersettings>): void;
}
export declare class Resource$Mylibrary {
root: Books;
annotations: Resource$Mylibrary$Annotations;
bookshelves: Resource$Mylibrary$Bookshelves;
readingpositions: Resource$Mylibrary$Readingpositions;
constructor(root: Books);
getRoot(): Books;
}
export declare class Resource$Mylibrary$Annotations {
root: Books;
constructor(root: Books);
getRoot(): Books;
/**
* books.mylibrary.annotations.delete
* @desc Deletes an annotation.
* @alias books.mylibrary.annotations.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.annotationId The ID for the annotation to delete.
* @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
*/
delete(params?: any, options?: MethodOptions): AxiosPromise<void>;
delete(params?: any, options?: MethodOptions | BodyResponseCallback<void>, callback?: BodyResponseCallback<void>): void;
/**
* books.mylibrary.annotations.insert
* @desc Inserts a new annotation.
* @alias books.mylibrary.annotations.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.annotationId The ID for the annotation to insert.
* @param {string=} params.country ISO-3166-1 code to override the IP-based location.
* @param {boolean=} params.showOnlySummaryInResponse Requests that only the summary of the specified layer be provided in the response.
* @param {string=} params.source String to identify the originator of this request.
* @param {().Annotation} 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
*/
insert(params?: any, options?: MethodOptions): AxiosPromise<Schema$Annotation>;
insert(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Annotation>, callback?: BodyResponseCallback<Schema$Annotation>): void;
/**
* books.mylibrary.annotations.list
* @desc Retrieves a list of annotations, possibly filtered.
* @alias books.mylibrary.annotations.list
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {string=} params.contentVersion The content version for the requested volume.
* @param {string=} params.layerId The layer ID to limit annotation by.
* @param {string=} params.layerIds The layer ID(s) to limit annotation by.
* @param {integer=} params.maxResults Maximum number of results to return
* @param {string=} params.pageToken The value of the nextToken from the previous page.
* @param {boolean=} params.showDeleted Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.
* @param {string=} params.source String to identify the originator of this request.
* @param {string=} params.updatedMax RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
* @param {string=} params.updatedMin RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
* @param {string=} params.volumeId The volume to restrict annotations to.
* @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?: any, options?: MethodOptions): AxiosPromise<Schema$Annotations>;
list(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Annotations>, callback?: BodyResponseCallback<Schema$Annotations>): void;
/**
* books.mylibrary.annotations.summary
* @desc Gets the summary of specified layers.
* @alias books.mylibrary.annotations.summary
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.layerIds Array of layer IDs to get the summary for.
* @param {string} params.volumeId Volume id to get the summary for.
* @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
*/
summ