Books

import { Books } from "https://googleapis.deno.dev/v1/books:v1.ts";

The Google Books API allows clients to access the Google Books repository.

class Books {

constructor(client?: CredentialsClient, baseUrl?: string);

async bookshelvesGet(

shelf: string,

userId: string,

opts?: BookshelvesGetOptions,

): Promise<Bookshelf>;

async bookshelvesList(userId: string, opts?: BookshelvesListOptions): Promise<Bookshelves>;

async bookshelvesVolumesList(

shelf: string,

userId: string,

opts?: BookshelvesVolumesListOptions,

): Promise<Volumes>;

async cloudloadingAddBook(opts?: CloudloadingAddBookOptions): Promise<BooksCloudloadingResource>;

async cloudloadingDeleteBook(opts?: CloudloadingDeleteBookOptions): Promise<Empty>;

async cloudloadingUpdateBook(req: BooksCloudloadingResource): Promise<BooksCloudloadingResource>;

async dictionaryListOfflineMetadata(opts?: DictionaryListOfflineMetadataOptions): Promise<Metadata>;

async familysharingGetFamilyInfo(opts?: FamilysharingGetFamilyInfoOptions): Promise<FamilyInfo>;

async familysharingShare(opts?: FamilysharingShareOptions): Promise<Empty>;

async familysharingUnshare(opts?: FamilysharingUnshareOptions): Promise<Empty>;

async layersAnnotationDataGet(

annotationDataId: string,

layerId: string,

volumeId: string,

opts?: LayersAnnotationDataGetOptions,

): Promise<DictionaryAnnotationdata>;

async layersAnnotationDataList(

layerId: string,

volumeId: string,

opts?: LayersAnnotationDataListOptions,

): Promise<Annotationsdata>;

async layersGet(

summaryId: string,

volumeId: string,

opts?: LayersGetOptions,

): Promise<Layersummary>;

async layersList(volumeId: string, opts?: LayersListOptions): Promise<Layersummaries>;

async layersVolumeAnnotationsGet(

annotationId: string,

layerId: string,

volumeId: string,

opts?: LayersVolumeAnnotationsGetOptions,

): Promise<Volumeannotation>;

async layersVolumeAnnotationsList(

layerId: string,

volumeId: string,

opts?: LayersVolumeAnnotationsListOptions,

): Promise<Volumeannotations>;

async myconfigGetUserSettings(opts?: MyconfigGetUserSettingsOptions): Promise<Usersettings>;

async myconfigReleaseDownloadAccess(opts?: MyconfigReleaseDownloadAccessOptions): Promise<DownloadAccesses>;

async myconfigRequestAccess(opts?: MyconfigRequestAccessOptions): Promise<RequestAccessData>;

async myconfigSyncVolumeLicenses(opts?: MyconfigSyncVolumeLicensesOptions): Promise<Volumes>;

async myconfigUpdateUserSettings(req: Usersettings): Promise<Usersettings>;

async mylibraryAnnotationsDelete(annotationId: string, opts?: MylibraryAnnotationsDeleteOptions): Promise<Empty>;

async mylibraryAnnotationsInsert(req: Annotation, opts?: MylibraryAnnotationsInsertOptions): Promise<Annotation>;

async mylibraryAnnotationsList(opts?: MylibraryAnnotationsListOptions): Promise<Annotations>;

async mylibraryAnnotationsSummary(opts?: MylibraryAnnotationsSummaryOptions): Promise<AnnotationsSummary>;

async mylibraryAnnotationsUpdate(

annotationId: string,

req: Annotation,

opts?: MylibraryAnnotationsUpdateOptions,

): Promise<Annotation>;

async mylibraryBookshelvesAddVolume(shelf: string, opts?: MylibraryBookshelvesAddVolumeOptions): Promise<Empty>;

async mylibraryBookshelvesClearVolumes(shelf: string, opts?: MylibraryBookshelvesClearVolumesOptions): Promise<Empty>;

async mylibraryBookshelvesGet(shelf: string, opts?: MylibraryBookshelvesGetOptions): Promise<Bookshelf>;

async mylibraryBookshelvesList(opts?: MylibraryBookshelvesListOptions): Promise<Bookshelves>;

async mylibraryBookshelvesMoveVolume(shelf: string, opts?: MylibraryBookshelvesMoveVolumeOptions): Promise<Empty>;

async mylibraryBookshelvesRemoveVolume(shelf: string, opts?: MylibraryBookshelvesRemoveVolumeOptions): Promise<Empty>;

async mylibraryBookshelvesVolumesList(shelf: string, opts?: MylibraryBookshelvesVolumesListOptions): Promise<Volumes>;

async mylibraryReadingpositionsGet(volumeId: string, opts?: MylibraryReadingpositionsGetOptions): Promise<ReadingPosition>;

async mylibraryReadingpositionsSetPosition(volumeId: string, opts?: MylibraryReadingpositionsSetPositionOptions): Promise<Empty>;

async notificationGet(opts?: NotificationGetOptions): Promise<Notification>;

async onboardingListCategories(opts?: OnboardingListCategoriesOptions): Promise<Category>;

async onboardingListCategoryVolumes(opts?: OnboardingListCategoryVolumesOptions): Promise<Volume2>;

async personalizedstreamGet(opts?: PersonalizedstreamGetOptions): Promise<Discoveryclusters>;

async promoofferAccept(opts?: PromoofferAcceptOptions): Promise<Empty>;

async promoofferDismiss(opts?: PromoofferDismissOptions): Promise<Empty>;

async promoofferGet(opts?: PromoofferGetOptions): Promise<Offers>;

async seriesGet(opts?: SeriesGetOptions): Promise<Series>;

async seriesMembershipGet(opts?: SeriesMembershipGetOptions): Promise<Seriesmembership>;

async volumesAssociatedList(volumeId: string, opts?: VolumesAssociatedListOptions): Promise<Volumes>;

async volumesGet(volumeId: string, opts?: VolumesGetOptions): Promise<Volume>;

async volumesList(opts?: VolumesListOptions): Promise<Volumes>;

async volumesMybooksList(opts?: VolumesMybooksListOptions): Promise<Volumes>;

async volumesRecommendedList(opts?: VolumesRecommendedListOptions): Promise<Volumes>;

async volumesRecommendedRate(opts?: VolumesRecommendedRateOptions): Promise<BooksVolumesRecommendedRateResponse>;

async volumesUseruploadedList(opts?: VolumesUseruploadedListOptions): Promise<Volumes>;

}

§Constructors

new Books(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

bookshelvesGet(shelf: string, userId: string, opts?: BookshelvesGetOptions): Promise<Bookshelf>

[src]

Retrieves metadata for a specific bookshelf for the specified user.

@param shelf

ID of bookshelf to retrieve.

@param userId

ID of user for whom to retrieve bookshelves.

bookshelvesList(userId: string, opts?: BookshelvesListOptions): Promise<Bookshelves>

[src]

Retrieves a list of public bookshelves for the specified user.

@param userId

ID of user for whom to retrieve bookshelves.

bookshelvesVolumesList(shelf: string, userId: string, opts?: BookshelvesVolumesListOptions): Promise<Volumes>

[src]

Retrieves volumes in a specific bookshelf for the specified user.

@param shelf

ID of bookshelf to retrieve volumes.

@param userId

ID of user for whom to retrieve bookshelf volumes.

cloudloadingAddBook(opts?: CloudloadingAddBookOptions): Promise<BooksCloudloadingResource>

[src]

Add a user-upload volume and triggers processing.

cloudloadingDeleteBook(opts?: CloudloadingDeleteBookOptions): Promise<Empty>

[src]

Remove the book and its contents

cloudloadingUpdateBook(req: BooksCloudloadingResource): Promise<BooksCloudloadingResource>

[src]

Updates a user-upload volume.

dictionaryListOfflineMetadata(opts?: DictionaryListOfflineMetadataOptions): Promise<Metadata>

[src]

Returns a list of offline dictionary metadata available

familysharingGetFamilyInfo(opts?: FamilysharingGetFamilyInfoOptions): Promise<FamilyInfo>

[src]

Gets information regarding the family that the user is part of.

familysharingShare(opts?: FamilysharingShareOptions): Promise<Empty>

[src]

Initiates sharing of the content with the user's family. Empty response indicates success.

familysharingUnshare(opts?: FamilysharingUnshareOptions): Promise<Empty>

[src]

Initiates revoking content that has already been shared with the user's family. Empty response indicates success.

layersAnnotationDataGet(annotationDataId: string, layerId: string, volumeId: string, opts?: LayersAnnotationDataGetOptions): Promise<DictionaryAnnotationdata>

[src]

Gets the annotation data.

@param annotationDataId

The ID of the annotation data to retrieve.

@param layerId

The ID for the layer to get the annotations.

@param volumeId

The volume to retrieve annotations for.

layersAnnotationDataList(layerId: string, volumeId: string, opts?: LayersAnnotationDataListOptions): Promise<Annotationsdata>

[src]

Gets the annotation data for a volume and layer.

@param layerId

The ID for the layer to get the annotation data.

@param volumeId

The volume to retrieve annotation data for.

layersGet(summaryId: string, volumeId: string, opts?: LayersGetOptions): Promise<Layersummary>

[src]

Gets the layer summary for a volume.

@param summaryId

The ID for the layer to get the summary for.

@param volumeId

The volume to retrieve layers for.

layersList(volumeId: string, opts?: LayersListOptions): Promise<Layersummaries>

[src]

List the layer summaries for a volume.

@param volumeId

The volume to retrieve layers for.

layersVolumeAnnotationsGet(annotationId: string, layerId: string, volumeId: string, opts?: LayersVolumeAnnotationsGetOptions): Promise<Volumeannotation>

[src]

Gets the volume annotation.

@param annotationId

The ID of the volume annotation to retrieve.

@param layerId

The ID for the layer to get the annotations.

@param volumeId

The volume to retrieve annotations for.

layersVolumeAnnotationsList(layerId: string, volumeId: string, opts?: LayersVolumeAnnotationsListOptions): Promise<Volumeannotations>

[src]

Gets the volume annotations for a volume and layer.

@param layerId

The ID for the layer to get the annotations.

@param volumeId

The volume to retrieve annotations for.

myconfigGetUserSettings(opts?: MyconfigGetUserSettingsOptions): Promise<Usersettings>

[src]

Gets the current settings for the user.

myconfigReleaseDownloadAccess(opts?: MyconfigReleaseDownloadAccessOptions): Promise<DownloadAccesses>

[src]

Release downloaded content access restriction.

myconfigRequestAccess(opts?: MyconfigRequestAccessOptions): Promise<RequestAccessData>

[src]

Request concurrent and download access restrictions.

myconfigSyncVolumeLicenses(opts?: MyconfigSyncVolumeLicensesOptions): Promise<Volumes>

[src]

Request downloaded content access for specified volumes on the My eBooks shelf.

myconfigUpdateUserSettings(req: Usersettings): Promise<Usersettings>

[src]

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.

mylibraryAnnotationsDelete(annotationId: string, opts?: MylibraryAnnotationsDeleteOptions): Promise<Empty>

[src]

Deletes an annotation.

@param annotationId

The ID for the annotation to delete.

mylibraryAnnotationsInsert(req: Annotation, opts?: MylibraryAnnotationsInsertOptions): Promise<Annotation>

[src]

Inserts a new annotation.

mylibraryAnnotationsList(opts?: MylibraryAnnotationsListOptions): Promise<Annotations>

[src]

Retrieves a list of annotations, possibly filtered.

mylibraryAnnotationsSummary(opts?: MylibraryAnnotationsSummaryOptions): Promise<AnnotationsSummary>

[src]

Gets the summary of specified layers.

mylibraryAnnotationsUpdate(annotationId: string, req: Annotation, opts?: MylibraryAnnotationsUpdateOptions): Promise<Annotation>

[src]

Updates an existing annotation.

@param annotationId

The ID for the annotation to update.

mylibraryBookshelvesAddVolume(shelf: string, opts?: MylibraryBookshelvesAddVolumeOptions): Promise<Empty>

[src]

Adds a volume to a bookshelf.

@param shelf

ID of bookshelf to which to add a volume.

mylibraryBookshelvesClearVolumes(shelf: string, opts?: MylibraryBookshelvesClearVolumesOptions): Promise<Empty>

[src]

Clears all volumes from a bookshelf.

@param shelf

ID of bookshelf from which to remove a volume.

mylibraryBookshelvesGet(shelf: string, opts?: MylibraryBookshelvesGetOptions): Promise<Bookshelf>

[src]

Retrieves metadata for a specific bookshelf belonging to the authenticated user.

@param shelf

ID of bookshelf to retrieve.

mylibraryBookshelvesList(opts?: MylibraryBookshelvesListOptions): Promise<Bookshelves>

[src]

Retrieves a list of bookshelves belonging to the authenticated user.

mylibraryBookshelvesMoveVolume(shelf: string, opts?: MylibraryBookshelvesMoveVolumeOptions): Promise<Empty>

[src]

Moves a volume within a bookshelf.

@param shelf

ID of bookshelf with the volume.

mylibraryBookshelvesRemoveVolume(shelf: string, opts?: MylibraryBookshelvesRemoveVolumeOptions): Promise<Empty>

[src]

Removes a volume from a bookshelf.

@param shelf

ID of bookshelf from which to remove a volume.

mylibraryBookshelvesVolumesList(shelf: string, opts?: MylibraryBookshelvesVolumesListOptions): Promise<Volumes>

[src]

Gets volume information for volumes on a bookshelf.

@param shelf

The bookshelf ID or name retrieve volumes for.

mylibraryReadingpositionsGet(volumeId: string, opts?: MylibraryReadingpositionsGetOptions): Promise<ReadingPosition>

[src]

Retrieves my reading position information for a volume.

@param volumeId

ID of volume for which to retrieve a reading position.

mylibraryReadingpositionsSetPosition(volumeId: string, opts?: MylibraryReadingpositionsSetPositionOptions): Promise<Empty>

[src]

Sets my reading position information for a volume.

@param volumeId

ID of volume for which to update the reading position.

notificationGet(opts?: NotificationGetOptions): Promise<Notification>

[src]

Returns notification details for a given notification id.

onboardingListCategories(opts?: OnboardingListCategoriesOptions): Promise<Category>

[src]

List categories for onboarding experience.

onboardingListCategoryVolumes(opts?: OnboardingListCategoryVolumesOptions): Promise<Volume2>

[src]

List available volumes under categories for onboarding experience.

personalizedstreamGet(opts?: PersonalizedstreamGetOptions): Promise<Discoveryclusters>

[src]

Returns a stream of personalized book clusters

promoofferAccept(opts?: PromoofferAcceptOptions): Promise<Empty>

[src]

Accepts the promo offer.

promoofferDismiss(opts?: PromoofferDismissOptions): Promise<Empty>

[src]

Marks the promo offer as dismissed.

promoofferGet(opts?: PromoofferGetOptions): Promise<Offers>

[src]

Returns a list of promo offers available to the user

seriesGet(opts?: SeriesGetOptions): Promise<Series>

[src]

Returns Series metadata for the given series ids.

seriesMembershipGet(opts?: SeriesMembershipGetOptions): Promise<Seriesmembership>

[src]

Returns Series membership data given the series id.

volumesAssociatedList(volumeId: string, opts?: VolumesAssociatedListOptions): Promise<Volumes>

[src]

Return a list of associated books.

@param volumeId

ID of the source volume.

volumesGet(volumeId: string, opts?: VolumesGetOptions): Promise<Volume>

[src]

Gets volume information for a single volume.

@param volumeId

ID of volume to retrieve.

volumesList(opts?: VolumesListOptions): Promise<Volumes>

[src]

Performs a book search.

volumesMybooksList(opts?: VolumesMybooksListOptions): Promise<Volumes>

[src]

Return a list of books in My Library.

volumesRecommendedList(opts?: VolumesRecommendedListOptions): Promise<Volumes>

[src]

Return a list of recommended books for the current user.

volumesRecommendedRate(opts?: VolumesRecommendedRateOptions): Promise<BooksVolumesRecommendedRateResponse>

[src]

Rate a recommended book for the current user.

volumesUseruploadedList(opts?: VolumesUseruploadedListOptions): Promise<Volumes>

[src]

Return a list of books uploaded by the current user.