From 124978c872983e2cb9c3ad2c236f7dcf9cc00b74 Mon Sep 17 00:00:00 2001 From: yoshi-automation Date: Thu, 11 Jun 2020 04:36:18 -0700 Subject: [PATCH] feat(books)!: update the API BREAKING CHANGE: This release has breaking changes. #### books:v1 The following keys were deleted: - etag - parameters.oauth_token.description - parameters.oauth_token.location - parameters.oauth_token.type - parameters.userIp.description - parameters.userIp.location - parameters.userIp.type - resources.bookshelves.resources.volumes.methods.list.parameters.maxResults.minimum - resources.bookshelves.resources.volumes.methods.list.parameters.startIndex.minimum - resources.cloudloading.methods.deleteBook.parameters.volumeId.required - resources.dictionary.methods.listOfflineMetadata.parameters.cpksver.required - resources.layers.methods.list.parameters.maxResults.maximum - resources.layers.methods.list.parameters.maxResults.minimum - resources.layers.resources.annotationData.methods.get.parameters.contentVersion.required - resources.layers.resources.annotationData.methods.get.parameters.scale.minimum - resources.layers.resources.annotationData.methods.list.parameters.contentVersion.required - resources.layers.resources.annotationData.methods.list.parameters.maxResults.maximum - resources.layers.resources.annotationData.methods.list.parameters.maxResults.minimum - resources.layers.resources.annotationData.methods.list.parameters.scale.minimum - resources.layers.resources.volumeAnnotations.methods.list.parameters.contentVersion.required - resources.layers.resources.volumeAnnotations.methods.list.parameters.maxResults.maximum - resources.layers.resources.volumeAnnotations.methods.list.parameters.maxResults.minimum - resources.myconfig.methods.releaseDownloadAccess.parameters.cpksver.required - resources.myconfig.methods.releaseDownloadAccess.parameters.volumeIds.required - resources.myconfig.methods.requestAccess.parameters.cpksver.required - resources.myconfig.methods.requestAccess.parameters.licenseTypes.enumDescriptions - resources.myconfig.methods.requestAccess.parameters.nonce.required - resources.myconfig.methods.requestAccess.parameters.source.required - resources.myconfig.methods.requestAccess.parameters.volumeId.required - resources.myconfig.methods.syncVolumeLicenses.parameters.cpksver.required - resources.myconfig.methods.syncVolumeLicenses.parameters.features.enumDescriptions - resources.myconfig.methods.syncVolumeLicenses.parameters.nonce.required - resources.myconfig.methods.syncVolumeLicenses.parameters.source.required - resources.mylibrary.resources.annotations.methods.list.parameters.maxResults.maximum - resources.mylibrary.resources.annotations.methods.list.parameters.maxResults.minimum - resources.mylibrary.resources.annotations.methods.summary.parameters.layerIds.required - resources.mylibrary.resources.annotations.methods.summary.parameters.volumeId.required - resources.mylibrary.resources.bookshelves.methods.addVolume.parameters.reason.enumDescriptions - resources.mylibrary.resources.bookshelves.methods.addVolume.parameters.volumeId.required - resources.mylibrary.resources.bookshelves.methods.moveVolume.parameters.volumeId.required - resources.mylibrary.resources.bookshelves.methods.moveVolume.parameters.volumePosition.required - resources.mylibrary.resources.bookshelves.methods.removeVolume.parameters.reason.enumDescriptions - resources.mylibrary.resources.bookshelves.methods.removeVolume.parameters.volumeId.required - resources.mylibrary.resources.bookshelves.resources.volumes.methods.list.parameters.maxResults.minimum - resources.mylibrary.resources.bookshelves.resources.volumes.methods.list.parameters.projection.enumDescriptions - resources.mylibrary.resources.bookshelves.resources.volumes.methods.list.parameters.startIndex.minimum - resources.mylibrary.resources.readingpositions.methods.setPosition.parameters.action.enumDescriptions - resources.mylibrary.resources.readingpositions.methods.setPosition.parameters.position.required - resources.mylibrary.resources.readingpositions.methods.setPosition.parameters.timestamp.required - resources.notification.methods.get.parameters.notification_id.required - resources.onboarding.methods.listCategoryVolumes.parameters.maxAllowedMaturityRating.enumDescriptions - resources.personalizedstream.methods.get.parameters.maxAllowedMaturityRating.enumDescriptions - resources.series.methods.get.parameters.series_id.required - resources.series.resources.membership.methods.get.parameters.series_id.required - resources.volumes.methods.get.parameters.projection.enumDescriptions - resources.volumes.methods.list.parameters.download.enumDescriptions - resources.volumes.methods.list.parameters.filter.enumDescriptions - resources.volumes.methods.list.parameters.libraryRestrict.enumDescriptions - resources.volumes.methods.list.parameters.maxAllowedMaturityRating.enumDescriptions - resources.volumes.methods.list.parameters.maxResults.maximum - resources.volumes.methods.list.parameters.maxResults.minimum - resources.volumes.methods.list.parameters.orderBy.enumDescriptions - resources.volumes.methods.list.parameters.printType.enumDescriptions - resources.volumes.methods.list.parameters.projection.enumDescriptions - resources.volumes.methods.list.parameters.q.required - resources.volumes.methods.list.parameters.startIndex.minimum - resources.volumes.resources.associated.methods.list.parameters.association.enumDescriptions - resources.volumes.resources.associated.methods.list.parameters.maxAllowedMaturityRating.enumDescriptions - resources.volumes.resources.mybooks.methods.list.parameters.acquireMethod.enumDescriptions - resources.volumes.resources.mybooks.methods.list.parameters.maxResults.maximum - resources.volumes.resources.mybooks.methods.list.parameters.maxResults.minimum - resources.volumes.resources.mybooks.methods.list.parameters.processingState.enumDescriptions - resources.volumes.resources.mybooks.methods.list.parameters.startIndex.minimum - resources.volumes.resources.recommended.methods.list.parameters.maxAllowedMaturityRating.enumDescriptions - resources.volumes.resources.recommended.methods.rate.parameters.rating.enumDescriptions - resources.volumes.resources.recommended.methods.rate.parameters.rating.required - resources.volumes.resources.recommended.methods.rate.parameters.volumeId.required - resources.volumes.resources.useruploaded.methods.list.parameters.maxResults.maximum - resources.volumes.resources.useruploaded.methods.list.parameters.maxResults.minimum - resources.volumes.resources.useruploaded.methods.list.parameters.processingState.enumDescriptions - resources.volumes.resources.useruploaded.methods.list.parameters.startIndex.minimum - schemas.Annotation.properties.created.format - schemas.Annotation.properties.kind.default - schemas.Annotation.properties.updated.format - schemas.Annotationdata.id - schemas.Annotationdata.properties.annotationType.description - schemas.Annotationdata.properties.annotationType.type - schemas.Annotationdata.properties.data.type - schemas.Annotationdata.properties.encoded_data.description - schemas.Annotationdata.properties.encoded_data.format - schemas.Annotationdata.properties.encoded_data.type - schemas.Annotationdata.properties.id.description - schemas.Annotationdata.properties.id.type - schemas.Annotationdata.properties.kind.default - schemas.Annotationdata.properties.kind.description - schemas.Annotationdata.properties.kind.type - schemas.Annotationdata.properties.layerId.description - schemas.Annotationdata.properties.layerId.type - schemas.Annotationdata.properties.selfLink.description - schemas.Annotationdata.properties.selfLink.type - schemas.Annotationdata.properties.updated.description - schemas.Annotationdata.properties.updated.format - schemas.Annotationdata.properties.updated.type - schemas.Annotationdata.properties.volumeId.description - schemas.Annotationdata.properties.volumeId.type - schemas.Annotationdata.type - schemas.Annotations.properties.kind.default - schemas.AnnotationsSummary.properties.kind.default - schemas.AnnotationsSummary.properties.layers.items.properties.updated.format - schemas.Annotationsdata.properties.kind.default - schemas.BooksSubscriptionReleaseInfo.id - schemas.BooksSubscriptionReleaseInfo.properties.amountInMicros.description - schemas.BooksSubscriptionReleaseInfo.properties.amountInMicros.format - schemas.BooksSubscriptionReleaseInfo.properties.amountInMicros.type - schemas.BooksSubscriptionReleaseInfo.properties.currencyCode.description - schemas.BooksSubscriptionReleaseInfo.properties.currencyCode.type - schemas.BooksSubscriptionReleaseInfo.properties.releaseNumber.description - schemas.BooksSubscriptionReleaseInfo.properties.releaseNumber.type - schemas.BooksSubscriptionReleaseInfo.properties.releaseTimestampUs.description - schemas.BooksSubscriptionReleaseInfo.properties.releaseTimestampUs.format - schemas.BooksSubscriptionReleaseInfo.properties.releaseTimestampUs.type - schemas.BooksSubscriptionReleaseInfo.type - schemas.Bookshelf.properties.created.format - schemas.Bookshelf.properties.kind.default - schemas.Bookshelf.properties.updated.format - schemas.Bookshelf.properties.volumesLastUpdated.format - schemas.Bookshelves.properties.kind.default - schemas.Category.properties.kind.default - schemas.ConcurrentAccessRestriction.properties.kind.default - schemas.Dictlayerdata.properties.kind.default - schemas.Discoveryclusters.properties.kind.default - schemas.DownloadAccessRestriction.properties.kind.default - schemas.DownloadAccesses.properties.kind.default - schemas.FamilyInfo.properties.kind.default - schemas.Geolayerdata.properties.geo.properties.boundary.items.items.properties.latitude.format - schemas.Geolayerdata.properties.geo.properties.boundary.items.items.properties.latitude.type - schemas.Geolayerdata.properties.geo.properties.boundary.items.items.properties.longitude.format - schemas.Geolayerdata.properties.geo.properties.boundary.items.items.properties.longitude.type - schemas.Geolayerdata.properties.geo.properties.boundary.items.items.type - schemas.Geolayerdata.properties.kind.default - schemas.Layersummaries.properties.kind.default - schemas.Layersummary.properties.kind.default - schemas.Layersummary.properties.updated.format - schemas.Metadata.properties.kind.default - schemas.Notification.properties.kind.default - schemas.Offers.properties.kind.default - schemas.ReadingPosition.properties.kind.default - schemas.ReadingPosition.properties.updated.format - schemas.RequestAccess.id - schemas.RequestAccess.properties.concurrentAccess.$ref - schemas.RequestAccess.properties.concurrentAccess.description - schemas.RequestAccess.properties.downloadAccess.$ref - schemas.RequestAccess.properties.downloadAccess.description - schemas.RequestAccess.properties.kind.default - schemas.RequestAccess.properties.kind.description - schemas.RequestAccess.properties.kind.type - schemas.RequestAccess.type - schemas.Review.properties.kind.default - schemas.Series.properties.kind.default - schemas.Series.properties.series.items.properties.seriesSubscriptionReleaseInfo.properties.cancellationTimestampUs.description - schemas.Series.properties.series.items.properties.seriesSubscriptionReleaseInfo.properties.cancellationTimestampUs.format - schemas.Series.properties.series.items.properties.seriesSubscriptionReleaseInfo.properties.cancellationTimestampUs.type - schemas.Series.properties.series.items.properties.seriesSubscriptionReleaseInfo.properties.currentReleaseInfo.$ref - schemas.Series.properties.series.items.properties.seriesSubscriptionReleaseInfo.properties.currentReleaseInfo.description - schemas.Series.properties.series.items.properties.seriesSubscriptionReleaseInfo.properties.nextReleaseInfo.$ref - schemas.Series.properties.series.items.properties.seriesSubscriptionReleaseInfo.properties.nextReleaseInfo.description - schemas.Series.properties.series.items.properties.seriesSubscriptionReleaseInfo.properties.seriesSubscriptionType.description - schemas.Seriesmembership.properties.kind.default - schemas.Usersettings.properties.kind.default - schemas.Volume.properties.kind.default - schemas.Volume.properties.saleInfo.properties.onSaleDate.format - schemas.Volume.properties.userInfo.properties.acquiredTime.format - schemas.Volume.properties.userInfo.properties.copy.properties.updated.format - schemas.Volume.properties.userInfo.properties.updated.format - schemas.Volume2.properties.kind.default - schemas.Volumeannotation.properties.kind.default - schemas.Volumeannotation.properties.updated.format - schemas.Volumeannotations.properties.kind.default - schemas.Volumes.properties.kind.default - schemas.Volumeseriesinfo.properties.kind.default The following keys were added: - mtlsRootUrl - parameters.$.xgafv.description - parameters.$.xgafv.enum - parameters.$.xgafv.enumDescriptions - parameters.$.xgafv.location - parameters.$.xgafv.type - parameters.callback.description - parameters.callback.location - parameters.callback.type - parameters.uploadType.description - parameters.uploadType.location - parameters.uploadType.type - parameters.upload_protocol.description - parameters.upload_protocol.location - parameters.upload_protocol.type - resources.bookshelves.methods.get.flatPath - resources.bookshelves.methods.list.flatPath - resources.bookshelves.resources.volumes.methods.list.flatPath - resources.cloudloading.methods.addBook.flatPath - resources.cloudloading.methods.addBook.parameterOrder - resources.cloudloading.methods.addBook.parameters.upload_client_token.description - resources.cloudloading.methods.deleteBook.flatPath - resources.cloudloading.methods.deleteBook.response.$ref - resources.cloudloading.methods.updateBook.flatPath - resources.cloudloading.methods.updateBook.parameterOrder - resources.dictionary.methods.listOfflineMetadata.flatPath - resources.familysharing.methods.getFamilyInfo.flatPath - resources.familysharing.methods.getFamilyInfo.parameterOrder - resources.familysharing.methods.share.flatPath - resources.familysharing.methods.share.parameterOrder - resources.familysharing.methods.share.response.$ref - resources.familysharing.methods.unshare.flatPath - resources.familysharing.methods.unshare.parameterOrder - resources.familysharing.methods.unshare.response.$ref - resources.layers.methods.get.flatPath - resources.layers.methods.list.flatPath - resources.layers.resources.annotationData.methods.get.flatPath - resources.layers.resources.annotationData.methods.list.flatPath - resources.layers.resources.volumeAnnotations.methods.get.flatPath - resources.layers.resources.volumeAnnotations.methods.list.flatPath - resources.myconfig.methods.getUserSettings.flatPath - resources.myconfig.methods.getUserSettings.parameterOrder - resources.myconfig.methods.getUserSettings.parameters.country.description - resources.myconfig.methods.getUserSettings.parameters.country.location - resources.myconfig.methods.getUserSettings.parameters.country.type - resources.myconfig.methods.releaseDownloadAccess.flatPath - resources.myconfig.methods.requestAccess.flatPath - resources.myconfig.methods.syncVolumeLicenses.flatPath - resources.myconfig.methods.updateUserSettings.flatPath - resources.myconfig.methods.updateUserSettings.parameterOrder - resources.mylibrary.resources.annotations.methods.delete.flatPath - resources.mylibrary.resources.annotations.methods.delete.response.$ref - resources.mylibrary.resources.annotations.methods.insert.flatPath - resources.mylibrary.resources.annotations.methods.insert.parameterOrder - resources.mylibrary.resources.annotations.methods.list.flatPath - resources.mylibrary.resources.annotations.methods.list.parameterOrder - resources.mylibrary.resources.annotations.methods.summary.flatPath - resources.mylibrary.resources.annotations.methods.update.flatPath - resources.mylibrary.resources.bookshelves.methods.addVolume.flatPath - resources.mylibrary.resources.bookshelves.methods.addVolume.response.$ref - resources.mylibrary.resources.bookshelves.methods.clearVolumes.flatPath - resources.mylibrary.resources.bookshelves.methods.clearVolumes.response.$ref - resources.mylibrary.resources.bookshelves.methods.get.flatPath - resources.mylibrary.resources.bookshelves.methods.list.flatPath - resources.mylibrary.resources.bookshelves.methods.list.parameterOrder - resources.mylibrary.resources.bookshelves.methods.moveVolume.flatPath - resources.mylibrary.resources.bookshelves.methods.moveVolume.response.$ref - resources.mylibrary.resources.bookshelves.methods.removeVolume.flatPath - resources.mylibrary.resources.bookshelves.methods.removeVolume.response.$ref - resources.mylibrary.resources.bookshelves.resources.volumes.methods.list.flatPath - resources.mylibrary.resources.readingpositions.methods.get.flatPath - resources.mylibrary.resources.readingpositions.methods.setPosition.flatPath - resources.mylibrary.resources.readingpositions.methods.setPosition.response.$ref - resources.notification.methods.get.flatPath - resources.onboarding.methods.listCategories.flatPath - resources.onboarding.methods.listCategories.parameterOrder - resources.onboarding.methods.listCategoryVolumes.flatPath - resources.onboarding.methods.listCategoryVolumes.parameterOrder - resources.personalizedstream.methods.get.flatPath - resources.personalizedstream.methods.get.parameterOrder - resources.promooffer.methods.accept.flatPath - resources.promooffer.methods.accept.parameterOrder - resources.promooffer.methods.accept.response.$ref - resources.promooffer.methods.dismiss.flatPath - resources.promooffer.methods.dismiss.parameterOrder - resources.promooffer.methods.dismiss.response.$ref - resources.promooffer.methods.get.flatPath - resources.promooffer.methods.get.parameterOrder - resources.series.methods.get.flatPath - resources.series.resources.membership.methods.get.flatPath - resources.volumes.methods.get.flatPath - resources.volumes.methods.list.flatPath - resources.volumes.resources.associated.methods.list.flatPath - resources.volumes.resources.mybooks.methods.list.flatPath - resources.volumes.resources.mybooks.methods.list.parameterOrder - resources.volumes.resources.recommended.methods.list.flatPath - resources.volumes.resources.recommended.methods.list.parameterOrder - resources.volumes.resources.recommended.methods.rate.flatPath - resources.volumes.resources.useruploaded.methods.list.flatPath - resources.volumes.resources.useruploaded.methods.list.parameterOrder - schemas.DictionaryAnnotationdata.id - schemas.DictionaryAnnotationdata.properties.annotationType.description - schemas.DictionaryAnnotationdata.properties.annotationType.type - schemas.DictionaryAnnotationdata.properties.data.$ref - schemas.DictionaryAnnotationdata.properties.data.description - schemas.DictionaryAnnotationdata.properties.encodedData.description - schemas.DictionaryAnnotationdata.properties.encodedData.format - schemas.DictionaryAnnotationdata.properties.encodedData.type - schemas.DictionaryAnnotationdata.properties.id.description - schemas.DictionaryAnnotationdata.properties.id.type - schemas.DictionaryAnnotationdata.properties.kind.description - schemas.DictionaryAnnotationdata.properties.kind.type - schemas.DictionaryAnnotationdata.properties.layerId.description - schemas.DictionaryAnnotationdata.properties.layerId.type - schemas.DictionaryAnnotationdata.properties.selfLink.description - schemas.DictionaryAnnotationdata.properties.selfLink.type - schemas.DictionaryAnnotationdata.properties.updated.description - schemas.DictionaryAnnotationdata.properties.updated.type - schemas.DictionaryAnnotationdata.properties.volumeId.description - schemas.DictionaryAnnotationdata.properties.volumeId.type - schemas.DictionaryAnnotationdata.type - schemas.Empty.description - schemas.Empty.id - schemas.Empty.type - schemas.GeoAnnotationdata.id - schemas.GeoAnnotationdata.properties.annotationType.description - schemas.GeoAnnotationdata.properties.annotationType.type - schemas.GeoAnnotationdata.properties.data.$ref - schemas.GeoAnnotationdata.properties.data.description - schemas.GeoAnnotationdata.properties.encodedData.description - schemas.GeoAnnotationdata.properties.encodedData.format - schemas.GeoAnnotationdata.properties.encodedData.type - schemas.GeoAnnotationdata.properties.id.description - schemas.GeoAnnotationdata.properties.id.type - schemas.GeoAnnotationdata.properties.kind.description - schemas.GeoAnnotationdata.properties.kind.type - schemas.GeoAnnotationdata.properties.layerId.description - schemas.GeoAnnotationdata.properties.layerId.type - schemas.GeoAnnotationdata.properties.selfLink.description - schemas.GeoAnnotationdata.properties.selfLink.type - schemas.GeoAnnotationdata.properties.updated.description - schemas.GeoAnnotationdata.properties.updated.type - schemas.GeoAnnotationdata.properties.volumeId.description - schemas.GeoAnnotationdata.properties.volumeId.type - schemas.GeoAnnotationdata.type - schemas.RequestAccessData.id - schemas.RequestAccessData.properties.concurrentAccess.$ref - schemas.RequestAccessData.properties.concurrentAccess.description - schemas.RequestAccessData.properties.downloadAccess.$ref - schemas.RequestAccessData.properties.downloadAccess.description - schemas.RequestAccessData.properties.kind.description - schemas.RequestAccessData.properties.kind.type - schemas.RequestAccessData.type - schemas.Series.properties.series.items.properties.seriesSubscriptionReleaseInfo.properties.cancelTime.type - schemas.Series.properties.series.items.properties.seriesSubscriptionReleaseInfo.properties.currentReleaseInfo.properties.amountInMicros.format - schemas.Series.properties.series.items.properties.seriesSubscriptionReleaseInfo.properties.currentReleaseInfo.properties.amountInMicros.type - schemas.Series.properties.series.items.properties.seriesSubscriptionReleaseInfo.properties.currentReleaseInfo.properties.currencyCode.type - schemas.Series.properties.series.items.properties.seriesSubscriptionReleaseInfo.properties.currentReleaseInfo.properties.releaseNumber.type - schemas.Series.properties.series.items.properties.seriesSubscriptionReleaseInfo.properties.currentReleaseInfo.properties.releaseTime.type - schemas.Series.properties.series.items.properties.seriesSubscriptionReleaseInfo.properties.currentReleaseInfo.type - schemas.Series.properties.series.items.properties.seriesSubscriptionReleaseInfo.properties.nextReleaseInfo.properties.amountInMicros.format - schemas.Series.properties.series.items.properties.seriesSubscriptionReleaseInfo.properties.nextReleaseInfo.properties.amountInMicros.type - schemas.Series.properties.series.items.properties.seriesSubscriptionReleaseInfo.properties.nextReleaseInfo.properties.currencyCode.type - schemas.Series.properties.series.items.properties.seriesSubscriptionReleaseInfo.properties.nextReleaseInfo.properties.releaseNumber.type - schemas.Series.properties.series.items.properties.seriesSubscriptionReleaseInfo.properties.nextReleaseInfo.properties.releaseTime.type - schemas.Series.properties.series.items.properties.seriesSubscriptionReleaseInfo.properties.nextReleaseInfo.type - schemas.Volume.properties.volumeInfo.properties.readingModes.properties.image.type - schemas.Volume.properties.volumeInfo.properties.readingModes.properties.text.type - version_module The following keys were changed: - baseUrl - description - documentationLink - icons.x16 - icons.x32 - parameters.alt.description - parameters.alt.enum - parameters.alt.enumDescriptions - parameters.quotaUser.description - resources.bookshelves.methods.get.path - resources.bookshelves.methods.list.path - resources.bookshelves.resources.volumes.methods.list.path - resources.cloudloading.methods.addBook.description - resources.cloudloading.methods.addBook.path - resources.cloudloading.methods.deleteBook.parameterOrder - resources.cloudloading.methods.deleteBook.path - resources.cloudloading.methods.updateBook.description - resources.cloudloading.methods.updateBook.path - resources.dictionary.methods.listOfflineMetadata.parameterOrder - resources.dictionary.methods.listOfflineMetadata.path - resources.familysharing.methods.getFamilyInfo.path - resources.familysharing.methods.share.description - resources.familysharing.methods.share.path - resources.familysharing.methods.unshare.description - resources.familysharing.methods.unshare.path - resources.layers.methods.get.path - resources.layers.methods.list.path - resources.layers.resources.annotationData.methods.get.parameterOrder - resources.layers.resources.annotationData.methods.get.parameters.h.description - resources.layers.resources.annotationData.methods.get.parameters.locale.description - resources.layers.resources.annotationData.methods.get.parameters.w.description - resources.layers.resources.annotationData.methods.get.path - resources.layers.resources.annotationData.methods.get.response.$ref - resources.layers.resources.annotationData.methods.list.parameterOrder - resources.layers.resources.annotationData.methods.list.parameters.annotationDataId.description - resources.layers.resources.annotationData.methods.list.parameters.h.description - resources.layers.resources.annotationData.methods.list.parameters.locale.description - resources.layers.resources.annotationData.methods.list.parameters.updatedMax.description - resources.layers.resources.annotationData.methods.list.parameters.updatedMin.description - resources.layers.resources.annotationData.methods.list.parameters.w.description - resources.layers.resources.annotationData.methods.list.path - resources.layers.resources.volumeAnnotations.methods.get.parameters.locale.description - resources.layers.resources.volumeAnnotations.methods.get.path - resources.layers.resources.volumeAnnotations.methods.list.parameterOrder - resources.layers.resources.volumeAnnotations.methods.list.parameters.locale.description - resources.layers.resources.volumeAnnotations.methods.list.parameters.showDeleted.description - resources.layers.resources.volumeAnnotations.methods.list.parameters.updatedMax.description - resources.layers.resources.volumeAnnotations.methods.list.parameters.updatedMin.description - resources.layers.resources.volumeAnnotations.methods.list.path - resources.myconfig.methods.getUserSettings.path - resources.myconfig.methods.releaseDownloadAccess.parameterOrder - resources.myconfig.methods.releaseDownloadAccess.path - resources.myconfig.methods.requestAccess.parameterOrder - resources.myconfig.methods.requestAccess.parameters.licenseTypes.description - resources.myconfig.methods.requestAccess.parameters.licenseTypes.enum - resources.myconfig.methods.requestAccess.path - resources.myconfig.methods.requestAccess.response.$ref - resources.myconfig.methods.syncVolumeLicenses.description - resources.myconfig.methods.syncVolumeLicenses.parameterOrder - resources.myconfig.methods.syncVolumeLicenses.parameters.features.enum - resources.myconfig.methods.syncVolumeLicenses.path - resources.myconfig.methods.updateUserSettings.description - resources.myconfig.methods.updateUserSettings.path - resources.mylibrary.resources.annotations.methods.delete.path - resources.mylibrary.resources.annotations.methods.insert.parameters.showOnlySummaryInResponse.description - resources.mylibrary.resources.annotations.methods.insert.path - resources.mylibrary.resources.annotations.methods.list.parameters.showDeleted.description - resources.mylibrary.resources.annotations.methods.list.parameters.updatedMax.description - resources.mylibrary.resources.annotations.methods.list.parameters.updatedMin.description - resources.mylibrary.resources.annotations.methods.list.path - resources.mylibrary.resources.annotations.methods.summary.parameterOrder - resources.mylibrary.resources.annotations.methods.summary.path - resources.mylibrary.resources.annotations.methods.update.path - resources.mylibrary.resources.bookshelves.methods.addVolume.parameterOrder - resources.mylibrary.resources.bookshelves.methods.addVolume.parameters.reason.enum - resources.mylibrary.resources.bookshelves.methods.addVolume.path - resources.mylibrary.resources.bookshelves.methods.clearVolumes.path - resources.mylibrary.resources.bookshelves.methods.get.description - resources.mylibrary.resources.bookshelves.methods.get.path - resources.mylibrary.resources.bookshelves.methods.list.path - resources.mylibrary.resources.bookshelves.methods.moveVolume.parameterOrder - resources.mylibrary.resources.bookshelves.methods.moveVolume.parameters.volumePosition.description - resources.mylibrary.resources.bookshelves.methods.moveVolume.path - resources.mylibrary.resources.bookshelves.methods.removeVolume.parameterOrder - resources.mylibrary.resources.bookshelves.methods.removeVolume.parameters.reason.enum - resources.mylibrary.resources.bookshelves.methods.removeVolume.path - resources.mylibrary.resources.bookshelves.resources.volumes.methods.list.parameters.projection.enum - resources.mylibrary.resources.bookshelves.resources.volumes.methods.list.path - resources.mylibrary.resources.readingpositions.methods.get.path - resources.mylibrary.resources.readingpositions.methods.setPosition.parameterOrder - resources.mylibrary.resources.readingpositions.methods.setPosition.parameters.action.enum - resources.mylibrary.resources.readingpositions.methods.setPosition.path - resources.notification.methods.get.parameterOrder - resources.notification.methods.get.parameters.locale.description - resources.notification.methods.get.path - resources.onboarding.methods.listCategories.path - resources.onboarding.methods.listCategoryVolumes.parameters.maxAllowedMaturityRating.description - resources.onboarding.methods.listCategoryVolumes.parameters.maxAllowedMaturityRating.enum - resources.onboarding.methods.listCategoryVolumes.path - resources.personalizedstream.methods.get.parameters.locale.description - resources.personalizedstream.methods.get.parameters.maxAllowedMaturityRating.description - resources.personalizedstream.methods.get.parameters.maxAllowedMaturityRating.enum - resources.personalizedstream.methods.get.path - resources.promooffer.methods.accept.description - resources.promooffer.methods.accept.path - resources.promooffer.methods.dismiss.description - resources.promooffer.methods.dismiss.path - resources.promooffer.methods.get.path - resources.series.methods.get.parameterOrder - resources.series.methods.get.path - resources.series.resources.membership.methods.get.parameterOrder - resources.series.resources.membership.methods.get.path - resources.volumes.methods.get.parameters.projection.enum - resources.volumes.methods.get.parameters.source.description - resources.volumes.methods.get.path - resources.volumes.methods.list.parameterOrder - resources.volumes.methods.list.parameters.download.enum - resources.volumes.methods.list.parameters.filter.enum - resources.volumes.methods.list.parameters.libraryRestrict.enum - resources.volumes.methods.list.parameters.maxAllowedMaturityRating.description - resources.volumes.methods.list.parameters.maxAllowedMaturityRating.enum - resources.volumes.methods.list.parameters.orderBy.enum - resources.volumes.methods.list.parameters.printType.enum - resources.volumes.methods.list.parameters.projection.enum - resources.volumes.methods.list.path - resources.volumes.resources.associated.methods.list.parameters.association.enum - resources.volumes.resources.associated.methods.list.parameters.locale.description - resources.volumes.resources.associated.methods.list.parameters.maxAllowedMaturityRating.description - resources.volumes.resources.associated.methods.list.parameters.maxAllowedMaturityRating.enum - resources.volumes.resources.associated.methods.list.path - resources.volumes.resources.mybooks.methods.list.parameters.acquireMethod.enum - resources.volumes.resources.mybooks.methods.list.parameters.locale.description - resources.volumes.resources.mybooks.methods.list.parameters.processingState.description - resources.volumes.resources.mybooks.methods.list.parameters.processingState.enum - resources.volumes.resources.mybooks.methods.list.path - resources.volumes.resources.recommended.methods.list.parameters.locale.description - resources.volumes.resources.recommended.methods.list.parameters.maxAllowedMaturityRating.description - resources.volumes.resources.recommended.methods.list.parameters.maxAllowedMaturityRating.enum - resources.volumes.resources.recommended.methods.list.path - resources.volumes.resources.recommended.methods.rate.parameterOrder - resources.volumes.resources.recommended.methods.rate.parameters.locale.description - resources.volumes.resources.recommended.methods.rate.parameters.rating.enum - resources.volumes.resources.recommended.methods.rate.path - resources.volumes.resources.useruploaded.methods.list.parameters.locale.description - resources.volumes.resources.useruploaded.methods.list.parameters.processingState.enum - resources.volumes.resources.useruploaded.methods.list.parameters.volumeId.description - resources.volumes.resources.useruploaded.methods.list.path - schemas.Annotation.properties.afterSelectedText.description - schemas.Annotation.properties.beforeSelectedText.description - schemas.Annotation.properties.layerSummary.properties.allowedCharacterCount.description - schemas.Annotation.properties.layerSummary.properties.limitType.description - schemas.Annotation.properties.layerSummary.properties.remainingCharacterCount.description - schemas.Annotations.properties.nextPageToken.description - schemas.Annotations.properties.totalItems.description - schemas.Annotationsdata.properties.items.items.$ref - schemas.Annotationsdata.properties.nextPageToken.description - schemas.Bookshelf.properties.created.description - schemas.Bookshelf.properties.updated.description - schemas.Bookshelf.properties.volumesLastUpdated.description - schemas.ConcurrentAccessRestriction.properties.source.description - schemas.Dictlayerdata.properties.common.properties.title.description - schemas.Dictlayerdata.properties.dict.properties.words.items.properties.source.description - schemas.DownloadAccessRestriction.properties.downloadsAcquired.description - schemas.DownloadAccessRestriction.properties.maxDownloadDevices.description - schemas.DownloadAccessRestriction.properties.reasonCode.description - schemas.DownloadAccessRestriction.properties.source.description - schemas.Geolayerdata.properties.common.properties.title.description - schemas.Geolayerdata.properties.geo.properties.boundary.description - schemas.Geolayerdata.properties.geo.properties.boundary.items.type - schemas.Geolayerdata.properties.geo.properties.cachePolicy.description - schemas.Geolayerdata.properties.geo.properties.mapType.description - schemas.Geolayerdata.properties.geo.properties.viewport.description - schemas.Geolayerdata.properties.geo.properties.zoom.description - schemas.Layersummary.properties.updated.description - schemas.Layersummary.properties.volumeAnnotationsVersion.description - schemas.ReadingPosition.properties.updated.description - schemas.Review.properties.rating.description - schemas.Review.properties.source.description - schemas.Review.properties.type.description - schemas.Volume.properties.accessInfo.description - schemas.Volume.properties.accessInfo.properties.accessViewStatus.description - schemas.Volume.properties.accessInfo.properties.country.description - schemas.Volume.properties.accessInfo.properties.driveImportedContentLink.description - schemas.Volume.properties.accessInfo.properties.embeddable.description - schemas.Volume.properties.accessInfo.properties.epub.properties.isAvailable.description - schemas.Volume.properties.accessInfo.properties.explicitOfflineLicenseManagement.description - schemas.Volume.properties.accessInfo.properties.pdf.properties.isAvailable.description - schemas.Volume.properties.accessInfo.properties.textToSpeechPermission.description - schemas.Volume.properties.accessInfo.properties.viewOrderUrl.description - schemas.Volume.properties.accessInfo.properties.viewability.description - schemas.Volume.properties.accessInfo.properties.webReaderLink.description - schemas.Volume.properties.etag.description - schemas.Volume.properties.layerInfo.properties.layers.items.properties.volumeAnnotationsVersion.description - schemas.Volume.properties.saleInfo.description - schemas.Volume.properties.saleInfo.properties.buyLink.description - schemas.Volume.properties.saleInfo.properties.country.description - schemas.Volume.properties.saleInfo.properties.isEbook.description - schemas.Volume.properties.saleInfo.properties.retailPrice.description - schemas.Volume.properties.saleInfo.properties.saleability.description - schemas.Volume.properties.userInfo.description - schemas.Volume.properties.userInfo.properties.acquiredTime.description - schemas.Volume.properties.userInfo.properties.familySharing.properties.isSharingAllowed.description - schemas.Volume.properties.userInfo.properties.familySharing.properties.isSharingDisabledByFop.description - schemas.Volume.properties.userInfo.properties.isPreordered.description - schemas.Volume.properties.userInfo.properties.isPurchased.description - schemas.Volume.properties.userInfo.properties.readingPosition.description - schemas.Volume.properties.userInfo.properties.updated.description - schemas.Volume.properties.volumeInfo.properties.authors.description - schemas.Volume.properties.volumeInfo.properties.contentVersion.description - schemas.Volume.properties.volumeInfo.properties.description.description - schemas.Volume.properties.volumeInfo.properties.imageLinks.description - schemas.Volume.properties.volumeInfo.properties.imageLinks.properties.extraLarge.description - schemas.Volume.properties.volumeInfo.properties.imageLinks.properties.smallThumbnail.description - schemas.Volume.properties.volumeInfo.properties.imageLinks.properties.thumbnail.description - schemas.Volume.properties.volumeInfo.properties.infoLink.description - schemas.Volume.properties.volumeInfo.properties.language.description - schemas.Volume.properties.volumeInfo.properties.mainCategory.description - schemas.Volume.properties.volumeInfo.properties.readingModes.type - schemas.Volumeannotation.properties.updated.description - schemas.Volumeannotations.properties.nextPageToken.description - schemas.Volumeannotations.properties.version.description - schemas.Volumes.properties.totalItems.description - schemas.Volumeseriesinfo.properties.bookDisplayNumber.description - schemas.Volumeseriesinfo.properties.volumeSeries.items.properties.seriesBookType.description --- discovery/books-v1.json | 1083 +++++++++++++++++++-------------------- src/apis/books/v1.ts | 798 +++++++++++++++++------------ 2 files changed, 997 insertions(+), 884 deletions(-) diff --git a/discovery/books-v1.json b/discovery/books-v1.json index cefc8234df..dfaf50e025 100644 --- a/discovery/books-v1.json +++ b/discovery/books-v1.json @@ -8,35 +8,57 @@ } } }, - "basePath": "/books/v1/", - "baseUrl": "https://www.googleapis.com/books/v1/", + "basePath": "", + "baseUrl": "https://www.googleapis.com/", "batchPath": "batch/books/v1", - "description": "Searches for books and manages your Google Books library.", + "description": "The Google Books API allows clients to access the Google Books repository.", "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/books/docs/v1/getting_started", - "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/FivGHh5u6W1RctbrVrrDR-2aAQM\"", + "documentationLink": "https://code.google.com/apis/books/docs/v1/getting_started.html", "icons": { - "x16": "https://www.google.com/images/icons/product/ebooks-16.png", - "x32": "https://www.google.com/images/icons/product/ebooks-32.png" + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "id": "books:v1", "kind": "discovery#restDescription", + "mtlsRootUrl": "https://www.mtls.googleapis.com/", "name": "books", "ownerDomain": "google.com", "ownerName": "Google", "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, "alt": { "default": "json", - "description": "Data format for the response.", + "description": "Data format for response.", "enum": [ - "json" + "json", + "media", + "proto" ], "enumDescriptions": [ - "Responses with Content-Type of application/json" + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" ], "location": "query", "type": "string" }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "location": "query", @@ -47,11 +69,6 @@ "location": "query", "type": "string" }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "location": "query", - "type": "string" - }, "prettyPrint": { "default": "true", "description": "Returns response with indentations and line breaks.", @@ -59,12 +76,17 @@ "type": "boolean" }, "quotaUser": { - "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.", + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", + "location": "query", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query", "type": "string" }, - "userIp": { - "description": "Deprecated. Please use quotaUser instead.", + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query", "type": "string" } @@ -75,6 +97,7 @@ "methods": { "get": { "description": "Retrieves metadata for a specific bookshelf for the specified user.", + "flatPath": "books/v1/users/{userId}/bookshelves/{shelf}", "httpMethod": "GET", "id": "books.bookshelves.get", "parameterOrder": [ @@ -100,7 +123,7 @@ "type": "string" } }, - "path": "users/{userId}/bookshelves/{shelf}", + "path": "books/v1/users/{userId}/bookshelves/{shelf}", "response": { "$ref": "Bookshelf" }, @@ -110,6 +133,7 @@ }, "list": { "description": "Retrieves a list of public bookshelves for the specified user.", + "flatPath": "books/v1/users/{userId}/bookshelves", "httpMethod": "GET", "id": "books.bookshelves.list", "parameterOrder": [ @@ -128,7 +152,7 @@ "type": "string" } }, - "path": "users/{userId}/bookshelves", + "path": "books/v1/users/{userId}/bookshelves", "response": { "$ref": "Bookshelves" }, @@ -142,6 +166,7 @@ "methods": { "list": { "description": "Retrieves volumes in a specific bookshelf for the specified user.", + "flatPath": "books/v1/users/{userId}/bookshelves/{shelf}/volumes", "httpMethod": "GET", "id": "books.bookshelves.volumes.list", "parameterOrder": [ @@ -153,7 +178,6 @@ "description": "Maximum number of results to return", "format": "uint32", "location": "query", - "minimum": "0", "type": "integer" }, "shelf": { @@ -176,7 +200,6 @@ "description": "Index of the first element to return (starts at 0)", "format": "uint32", "location": "query", - "minimum": "0", "type": "integer" }, "userId": { @@ -186,7 +209,7 @@ "type": "string" } }, - "path": "users/{userId}/bookshelves/{shelf}/volumes", + "path": "books/v1/users/{userId}/bookshelves/{shelf}/volumes", "response": { "$ref": "Volumes" }, @@ -201,9 +224,11 @@ "cloudloading": { "methods": { "addBook": { - "description": "", + "description": "Add a user-upload volume and triggers processing.", + "flatPath": "books/v1/cloudloading/addBook", "httpMethod": "POST", "id": "books.cloudloading.addBook", + "parameterOrder": [], "parameters": { "drive_document_id": { "description": "A drive document id. The upload_client_token must not be set.", @@ -221,11 +246,12 @@ "type": "string" }, "upload_client_token": { + "description": "Scotty upload token.", "location": "query", "type": "string" } }, - "path": "cloudloading/addBook", + "path": "books/v1/cloudloading/addBook", "response": { "$ref": "BooksCloudloadingResource" }, @@ -235,29 +261,33 @@ }, "deleteBook": { "description": "Remove the book and its contents", + "flatPath": "books/v1/cloudloading/deleteBook", "httpMethod": "POST", "id": "books.cloudloading.deleteBook", - "parameterOrder": [ - "volumeId" - ], + "parameterOrder": [], "parameters": { "volumeId": { "description": "The id of the book to be removed.", "location": "query", - "required": true, "type": "string" } }, - "path": "cloudloading/deleteBook", + "path": "books/v1/cloudloading/deleteBook", + "response": { + "$ref": "Empty" + }, "scopes": [ "https://www.googleapis.com/auth/books" ] }, "updateBook": { - "description": "", + "description": "Updates a user-upload volume.", + "flatPath": "books/v1/cloudloading/updateBook", "httpMethod": "POST", "id": "books.cloudloading.updateBook", - "path": "cloudloading/updateBook", + "parameterOrder": [], + "parameters": {}, + "path": "books/v1/cloudloading/updateBook", "request": { "$ref": "BooksCloudloadingResource" }, @@ -274,20 +304,18 @@ "methods": { "listOfflineMetadata": { "description": "Returns a list of offline dictionary metadata available", + "flatPath": "books/v1/dictionary/listOfflineMetadata", "httpMethod": "GET", "id": "books.dictionary.listOfflineMetadata", - "parameterOrder": [ - "cpksver" - ], + "parameterOrder": [], "parameters": { "cpksver": { "description": "The device/version ID from which to request the data.", "location": "query", - "required": true, "type": "string" } }, - "path": "dictionary/listOfflineMetadata", + "path": "books/v1/dictionary/listOfflineMetadata", "response": { "$ref": "Metadata" }, @@ -301,8 +329,10 @@ "methods": { "getFamilyInfo": { "description": "Gets information regarding the family that the user is part of.", + "flatPath": "books/v1/familysharing/getFamilyInfo", "httpMethod": "GET", "id": "books.familysharing.getFamilyInfo", + "parameterOrder": [], "parameters": { "source": { "description": "String to identify the originator of this request.", @@ -310,7 +340,7 @@ "type": "string" } }, - "path": "familysharing/getFamilyInfo", + "path": "books/v1/familysharing/getFamilyInfo", "response": { "$ref": "FamilyInfo" }, @@ -319,9 +349,11 @@ ] }, "share": { - "description": "Initiates sharing of the content with the user's family. Empty response indicates success.", + "description": "Initiates sharing of the content with the user's family. Empty response\nindicates success.", + "flatPath": "books/v1/familysharing/share", "httpMethod": "POST", "id": "books.familysharing.share", + "parameterOrder": [], "parameters": { "docId": { "description": "The docid to share.", @@ -339,15 +371,20 @@ "type": "string" } }, - "path": "familysharing/share", + "path": "books/v1/familysharing/share", + "response": { + "$ref": "Empty" + }, "scopes": [ "https://www.googleapis.com/auth/books" ] }, "unshare": { - "description": "Initiates revoking content that has already been shared with the user's family. Empty response indicates success.", + "description": "Initiates revoking content that has already been shared with the user's\nfamily. Empty response indicates success.", + "flatPath": "books/v1/familysharing/unshare", "httpMethod": "POST", "id": "books.familysharing.unshare", + "parameterOrder": [], "parameters": { "docId": { "description": "The docid to unshare.", @@ -365,7 +402,10 @@ "type": "string" } }, - "path": "familysharing/unshare", + "path": "books/v1/familysharing/unshare", + "response": { + "$ref": "Empty" + }, "scopes": [ "https://www.googleapis.com/auth/books" ] @@ -376,6 +416,7 @@ "methods": { "get": { "description": "Gets the layer summary for a volume.", + "flatPath": "books/v1/volumes/{volumeId}/layersummary/{summaryId}", "httpMethod": "GET", "id": "books.layers.get", "parameterOrder": [ @@ -406,7 +447,7 @@ "type": "string" } }, - "path": "volumes/{volumeId}/layersummary/{summaryId}", + "path": "books/v1/volumes/{volumeId}/layersummary/{summaryId}", "response": { "$ref": "Layersummary" }, @@ -416,6 +457,7 @@ }, "list": { "description": "List the layer summaries for a volume.", + "flatPath": "books/v1/volumes/{volumeId}/layersummary", "httpMethod": "GET", "id": "books.layers.list", "parameterOrder": [ @@ -431,8 +473,6 @@ "description": "Maximum number of results to return", "format": "uint32", "location": "query", - "maximum": "200", - "minimum": "0", "type": "integer" }, "pageToken": { @@ -452,7 +492,7 @@ "type": "string" } }, - "path": "volumes/{volumeId}/layersummary", + "path": "books/v1/volumes/{volumeId}/layersummary", "response": { "$ref": "Layersummaries" }, @@ -466,13 +506,13 @@ "methods": { "get": { "description": "Gets the annotation data.", + "flatPath": "books/v1/volumes/{volumeId}/layers/{layerId}/data/{annotationDataId}", "httpMethod": "GET", "id": "books.layers.annotationData.get", "parameterOrder": [ "volumeId", "layerId", - "annotationDataId", - "contentVersion" + "annotationDataId" ], "parameters": { "allowWebDefinitions": { @@ -489,11 +529,10 @@ "contentVersion": { "description": "The content version for the volume you are trying to retrieve.", "location": "query", - "required": true, "type": "string" }, "h": { - "description": "The requested pixel height for any images. If height is provided width must also be provided.", + "description": "The requested pixel height for any images. If height is provided width must\nalso be provided.", "format": "int32", "location": "query", "type": "integer" @@ -505,7 +544,7 @@ "type": "string" }, "locale": { - "description": "The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.", + "description": "The locale information for the data. ISO-639-1 language and ISO-3166-1\ncountry code. Ex: 'en_US'.", "location": "query", "type": "string" }, @@ -513,7 +552,6 @@ "description": "The requested scale for the image.", "format": "int32", "location": "query", - "minimum": "0", "type": "integer" }, "source": { @@ -528,15 +566,15 @@ "type": "string" }, "w": { - "description": "The requested pixel width for any images. If width is provided height must also be provided.", + "description": "The requested pixel width for any images. If width is provided height must\nalso be provided.", "format": "int32", "location": "query", "type": "integer" } }, - "path": "volumes/{volumeId}/layers/{layerId}/data/{annotationDataId}", + "path": "books/v1/volumes/{volumeId}/layers/{layerId}/data/{annotationDataId}", "response": { - "$ref": "Annotationdata" + "$ref": "DictionaryAnnotationdata" }, "scopes": [ "https://www.googleapis.com/auth/books" @@ -544,16 +582,16 @@ }, "list": { "description": "Gets the annotation data for a volume and layer.", + "flatPath": "books/v1/volumes/{volumeId}/layers/{layerId}/data", "httpMethod": "GET", "id": "books.layers.annotationData.list", "parameterOrder": [ "volumeId", - "layerId", - "contentVersion" + "layerId" ], "parameters": { "annotationDataId": { - "description": "The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set.", + "description": "The list of Annotation Data Ids to retrieve. Pagination is ignored if this\nis set.", "location": "query", "repeated": true, "type": "string" @@ -561,11 +599,10 @@ "contentVersion": { "description": "The content version for the requested volume.", "location": "query", - "required": true, "type": "string" }, "h": { - "description": "The requested pixel height for any images. If height is provided width must also be provided.", + "description": "The requested pixel height for any images. If height is provided width must\nalso be provided.", "format": "int32", "location": "query", "type": "integer" @@ -577,7 +614,7 @@ "type": "string" }, "locale": { - "description": "The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.", + "description": "The locale information for the data. ISO-639-1 language and ISO-3166-1\ncountry code. Ex: 'en_US'.", "location": "query", "type": "string" }, @@ -585,8 +622,6 @@ "description": "Maximum number of results to return", "format": "uint32", "location": "query", - "maximum": "200", - "minimum": "0", "type": "integer" }, "pageToken": { @@ -598,7 +633,6 @@ "description": "The requested scale for the image.", "format": "int32", "location": "query", - "minimum": "0", "type": "integer" }, "source": { @@ -607,12 +641,12 @@ "type": "string" }, "updatedMax": { - "description": "RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).", + "description": "RFC 3339 timestamp to restrict to items updated prior to this timestamp\n(exclusive).", "location": "query", "type": "string" }, "updatedMin": { - "description": "RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).", + "description": "RFC 3339 timestamp to restrict to items updated since this timestamp\n(inclusive).", "location": "query", "type": "string" }, @@ -623,13 +657,13 @@ "type": "string" }, "w": { - "description": "The requested pixel width for any images. If width is provided height must also be provided.", + "description": "The requested pixel width for any images. If width is provided height must\nalso be provided.", "format": "int32", "location": "query", "type": "integer" } }, - "path": "volumes/{volumeId}/layers/{layerId}/data", + "path": "books/v1/volumes/{volumeId}/layers/{layerId}/data", "response": { "$ref": "Annotationsdata" }, @@ -643,6 +677,7 @@ "methods": { "get": { "description": "Gets the volume annotation.", + "flatPath": "books/v1/volumes/{volumeId}/layers/{layerId}/annotations/{annotationId}", "httpMethod": "GET", "id": "books.layers.volumeAnnotations.get", "parameterOrder": [ @@ -664,7 +699,7 @@ "type": "string" }, "locale": { - "description": "The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.", + "description": "The locale information for the data. ISO-639-1 language and ISO-3166-1\ncountry code. Ex: 'en_US'.", "location": "query", "type": "string" }, @@ -680,7 +715,7 @@ "type": "string" } }, - "path": "volumes/{volumeId}/layers/{layerId}/annotations/{annotationId}", + "path": "books/v1/volumes/{volumeId}/layers/{layerId}/annotations/{annotationId}", "response": { "$ref": "Volumeannotation" }, @@ -690,18 +725,17 @@ }, "list": { "description": "Gets the volume annotations for a volume and layer.", + "flatPath": "books/v1/volumes/{volumeId}/layers/{layerId}", "httpMethod": "GET", "id": "books.layers.volumeAnnotations.list", "parameterOrder": [ "volumeId", - "layerId", - "contentVersion" + "layerId" ], "parameters": { "contentVersion": { "description": "The content version for the requested volume.", "location": "query", - "required": true, "type": "string" }, "endOffset": { @@ -721,7 +755,7 @@ "type": "string" }, "locale": { - "description": "The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.", + "description": "The locale information for the data. ISO-639-1 language and ISO-3166-1\ncountry code. Ex: 'en_US'.", "location": "query", "type": "string" }, @@ -729,8 +763,6 @@ "description": "Maximum number of results to return", "format": "uint32", "location": "query", - "maximum": "200", - "minimum": "0", "type": "integer" }, "pageToken": { @@ -739,7 +771,7 @@ "type": "string" }, "showDeleted": { - "description": "Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.", + "description": "Set to true to return deleted annotations. updatedMin must be in the\nrequest to use this. Defaults to false.", "location": "query", "type": "boolean" }, @@ -759,12 +791,12 @@ "type": "string" }, "updatedMax": { - "description": "RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).", + "description": "RFC 3339 timestamp to restrict to items updated prior to this timestamp\n(exclusive).", "location": "query", "type": "string" }, "updatedMin": { - "description": "RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).", + "description": "RFC 3339 timestamp to restrict to items updated since this timestamp\n(inclusive).", "location": "query", "type": "string" }, @@ -780,7 +812,7 @@ "type": "string" } }, - "path": "volumes/{volumeId}/layers/{layerId}", + "path": "books/v1/volumes/{volumeId}/layers/{layerId}", "response": { "$ref": "Volumeannotations" }, @@ -796,9 +828,18 @@ "methods": { "getUserSettings": { "description": "Gets the current settings for the user.", + "flatPath": "books/v1/myconfig/getUserSettings", "httpMethod": "GET", "id": "books.myconfig.getUserSettings", - "path": "myconfig/getUserSettings", + "parameterOrder": [], + "parameters": { + "country": { + "description": "Unused. Added only to workaround TEX mandatory request template requirement", + "location": "query", + "type": "string" + } + }, + "path": "books/v1/myconfig/getUserSettings", "response": { "$ref": "Usersettings" }, @@ -808,17 +849,14 @@ }, "releaseDownloadAccess": { "description": "Release downloaded content access restriction.", + "flatPath": "books/v1/myconfig/releaseDownloadAccess", "httpMethod": "POST", "id": "books.myconfig.releaseDownloadAccess", - "parameterOrder": [ - "volumeIds", - "cpksver" - ], + "parameterOrder": [], "parameters": { "cpksver": { "description": "The device/version ID from which to release the restriction.", "location": "query", - "required": true, "type": "string" }, "locale": { @@ -835,11 +873,10 @@ "description": "The volume(s) to release restrictions for.", "location": "query", "repeated": true, - "required": true, "type": "string" } }, - "path": "myconfig/releaseDownloadAccess", + "path": "books/v1/myconfig/releaseDownloadAccess", "response": { "$ref": "DownloadAccesses" }, @@ -849,33 +886,24 @@ }, "requestAccess": { "description": "Request concurrent and download access restrictions.", + "flatPath": "books/v1/myconfig/requestAccess", "httpMethod": "POST", "id": "books.myconfig.requestAccess", - "parameterOrder": [ - "source", - "volumeId", - "nonce", - "cpksver" - ], + "parameterOrder": [], "parameters": { "cpksver": { "description": "The device/version ID from which to request the restrictions.", "location": "query", - "required": true, "type": "string" }, "licenseTypes": { - "description": "The type of access license to request. If not specified, the default is BOTH.", + "description": "The type of access license to request. If not specified, the default is\nBOTH.", "enum": [ + "LICENSE_TYPES_UNDEFINED", "BOTH", "CONCURRENT", "DOWNLOAD" ], - "enumDescriptions": [ - "Both concurrent and download licenses.", - "Concurrent access license.", - "Offline download access license." - ], "location": "query", "type": "string" }, @@ -887,54 +915,45 @@ "nonce": { "description": "The client nonce value.", "location": "query", - "required": true, "type": "string" }, "source": { "description": "String to identify the originator of this request.", "location": "query", - "required": true, "type": "string" }, "volumeId": { "description": "The volume to request concurrent/download restrictions for.", "location": "query", - "required": true, "type": "string" } }, - "path": "myconfig/requestAccess", + "path": "books/v1/myconfig/requestAccess", "response": { - "$ref": "RequestAccess" + "$ref": "RequestAccessData" }, "scopes": [ "https://www.googleapis.com/auth/books" ] }, "syncVolumeLicenses": { - "description": "Request downloaded content access for specified volumes on the My eBooks shelf.", + "description": "Request downloaded content access for specified volumes on the My eBooks\nshelf.", + "flatPath": "books/v1/myconfig/syncVolumeLicenses", "httpMethod": "POST", "id": "books.myconfig.syncVolumeLicenses", - "parameterOrder": [ - "source", - "nonce", - "cpksver" - ], + "parameterOrder": [], "parameters": { "cpksver": { "description": "The device/version ID from which to release the restriction.", "location": "query", - "required": true, "type": "string" }, "features": { "description": "List of features supported by the client, i.e., 'RENTALS'", "enum": [ + "FEATURES_UNDEFINED", "RENTALS" ], - "enumDescriptions": [ - "Client supports rentals." - ], "location": "query", "repeated": true, "type": "string" @@ -952,7 +971,6 @@ "nonce": { "description": "The client nonce value.", "location": "query", - "required": true, "type": "string" }, "showPreorders": { @@ -963,7 +981,6 @@ "source": { "description": "String to identify the originator of this request.", "location": "query", - "required": true, "type": "string" }, "volumeIds": { @@ -973,7 +990,7 @@ "type": "string" } }, - "path": "myconfig/syncVolumeLicenses", + "path": "books/v1/myconfig/syncVolumeLicenses", "response": { "$ref": "Volumes" }, @@ -982,10 +999,13 @@ ] }, "updateUserSettings": { - "description": "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.", + "description": "Sets the settings for the user. If a sub-object is specified, it will\noverwrite the existing sub-object stored in the server. Unspecified\nsub-objects will retain the existing value.", + "flatPath": "books/v1/myconfig/updateUserSettings", "httpMethod": "POST", "id": "books.myconfig.updateUserSettings", - "path": "myconfig/updateUserSettings", + "parameterOrder": [], + "parameters": {}, + "path": "books/v1/myconfig/updateUserSettings", "request": { "$ref": "Usersettings" }, @@ -1004,6 +1024,7 @@ "methods": { "delete": { "description": "Deletes an annotation.", + "flatPath": "books/v1/mylibrary/annotations/{annotationId}", "httpMethod": "DELETE", "id": "books.mylibrary.annotations.delete", "parameterOrder": [ @@ -1022,15 +1043,20 @@ "type": "string" } }, - "path": "mylibrary/annotations/{annotationId}", + "path": "books/v1/mylibrary/annotations/{annotationId}", + "response": { + "$ref": "Empty" + }, "scopes": [ "https://www.googleapis.com/auth/books" ] }, "insert": { "description": "Inserts a new annotation.", + "flatPath": "books/v1/mylibrary/annotations", "httpMethod": "POST", "id": "books.mylibrary.annotations.insert", + "parameterOrder": [], "parameters": { "annotationId": { "description": "The ID for the annotation to insert.", @@ -1043,7 +1069,7 @@ "type": "string" }, "showOnlySummaryInResponse": { - "description": "Requests that only the summary of the specified layer be provided in the response.", + "description": "Requests that only the summary of the specified layer be provided in the\nresponse.", "location": "query", "type": "boolean" }, @@ -1053,7 +1079,7 @@ "type": "string" } }, - "path": "mylibrary/annotations", + "path": "books/v1/mylibrary/annotations", "request": { "$ref": "Annotation" }, @@ -1066,8 +1092,10 @@ }, "list": { "description": "Retrieves a list of annotations, possibly filtered.", + "flatPath": "books/v1/mylibrary/annotations", "httpMethod": "GET", "id": "books.mylibrary.annotations.list", + "parameterOrder": [], "parameters": { "contentVersion": { "description": "The content version for the requested volume.", @@ -1089,8 +1117,6 @@ "description": "Maximum number of results to return", "format": "uint32", "location": "query", - "maximum": "40", - "minimum": "0", "type": "integer" }, "pageToken": { @@ -1099,7 +1125,7 @@ "type": "string" }, "showDeleted": { - "description": "Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.", + "description": "Set to true to return deleted annotations. updatedMin must be in the\nrequest to use this. Defaults to false.", "location": "query", "type": "boolean" }, @@ -1109,12 +1135,12 @@ "type": "string" }, "updatedMax": { - "description": "RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).", + "description": "RFC 3339 timestamp to restrict to items updated prior to this timestamp\n(exclusive).", "location": "query", "type": "string" }, "updatedMin": { - "description": "RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).", + "description": "RFC 3339 timestamp to restrict to items updated since this timestamp\n(inclusive).", "location": "query", "type": "string" }, @@ -1124,7 +1150,7 @@ "type": "string" } }, - "path": "mylibrary/annotations", + "path": "books/v1/mylibrary/annotations", "response": { "$ref": "Annotations" }, @@ -1134,28 +1160,24 @@ }, "summary": { "description": "Gets the summary of specified layers.", + "flatPath": "books/v1/mylibrary/annotations/summary", "httpMethod": "POST", "id": "books.mylibrary.annotations.summary", - "parameterOrder": [ - "layerIds", - "volumeId" - ], + "parameterOrder": [], "parameters": { "layerIds": { "description": "Array of layer IDs to get the summary for.", "location": "query", "repeated": true, - "required": true, "type": "string" }, "volumeId": { "description": "Volume id to get the summary for.", "location": "query", - "required": true, "type": "string" } }, - "path": "mylibrary/annotations/summary", + "path": "books/v1/mylibrary/annotations/summary", "response": { "$ref": "AnnotationsSummary" }, @@ -1165,6 +1187,7 @@ }, "update": { "description": "Updates an existing annotation.", + "flatPath": "books/v1/mylibrary/annotations/{annotationId}", "httpMethod": "PUT", "id": "books.mylibrary.annotations.update", "parameterOrder": [ @@ -1183,7 +1206,7 @@ "type": "string" } }, - "path": "mylibrary/annotations/{annotationId}", + "path": "books/v1/mylibrary/annotations/{annotationId}", "request": { "$ref": "Annotation" }, @@ -1200,25 +1223,21 @@ "methods": { "addVolume": { "description": "Adds a volume to a bookshelf.", + "flatPath": "books/v1/mylibrary/bookshelves/{shelf}/addVolume", "httpMethod": "POST", "id": "books.mylibrary.bookshelves.addVolume", "parameterOrder": [ - "shelf", - "volumeId" + "shelf" ], "parameters": { "reason": { "description": "The reason for which the book is added to the library.", "enum": [ + "REASON_UNDEFINED", "IOS_PREX", "IOS_SEARCH", "ONBOARDING" ], - "enumDescriptions": [ - "Volumes added from the PREX flow on iOS.", - "Volumes added from the Search flow on iOS.", - "Volumes added from the Onboarding flow." - ], "location": "query", "type": "string" }, @@ -1236,17 +1255,20 @@ "volumeId": { "description": "ID of volume to add.", "location": "query", - "required": true, "type": "string" } }, - "path": "mylibrary/bookshelves/{shelf}/addVolume", + "path": "books/v1/mylibrary/bookshelves/{shelf}/addVolume", + "response": { + "$ref": "Empty" + }, "scopes": [ "https://www.googleapis.com/auth/books" ] }, "clearVolumes": { "description": "Clears all volumes from a bookshelf.", + "flatPath": "books/v1/mylibrary/bookshelves/{shelf}/clearVolumes", "httpMethod": "POST", "id": "books.mylibrary.bookshelves.clearVolumes", "parameterOrder": [ @@ -1265,13 +1287,17 @@ "type": "string" } }, - "path": "mylibrary/bookshelves/{shelf}/clearVolumes", + "path": "books/v1/mylibrary/bookshelves/{shelf}/clearVolumes", + "response": { + "$ref": "Empty" + }, "scopes": [ "https://www.googleapis.com/auth/books" ] }, "get": { - "description": "Retrieves metadata for a specific bookshelf belonging to the authenticated user.", + "description": "Retrieves metadata for a specific bookshelf belonging to the authenticated\nuser.", + "flatPath": "books/v1/mylibrary/bookshelves/{shelf}", "httpMethod": "GET", "id": "books.mylibrary.bookshelves.get", "parameterOrder": [ @@ -1290,7 +1316,7 @@ "type": "string" } }, - "path": "mylibrary/bookshelves/{shelf}", + "path": "books/v1/mylibrary/bookshelves/{shelf}", "response": { "$ref": "Bookshelf" }, @@ -1300,8 +1326,10 @@ }, "list": { "description": "Retrieves a list of bookshelves belonging to the authenticated user.", + "flatPath": "books/v1/mylibrary/bookshelves", "httpMethod": "GET", "id": "books.mylibrary.bookshelves.list", + "parameterOrder": [], "parameters": { "source": { "description": "String to identify the originator of this request.", @@ -1309,7 +1337,7 @@ "type": "string" } }, - "path": "mylibrary/bookshelves", + "path": "books/v1/mylibrary/bookshelves", "response": { "$ref": "Bookshelves" }, @@ -1319,12 +1347,11 @@ }, "moveVolume": { "description": "Moves a volume within a bookshelf.", + "flatPath": "books/v1/mylibrary/bookshelves/{shelf}/moveVolume", "httpMethod": "POST", "id": "books.mylibrary.bookshelves.moveVolume", "parameterOrder": [ - "shelf", - "volumeId", - "volumePosition" + "shelf" ], "parameters": { "shelf": { @@ -1341,39 +1368,38 @@ "volumeId": { "description": "ID of volume to move.", "location": "query", - "required": true, "type": "string" }, "volumePosition": { - "description": "Position on shelf to move the item (0 puts the item before the current first item, 1 puts it between the first and the second and so on.)", + "description": "Position on shelf to move the item (0 puts the item before the current\nfirst item, 1 puts it between the first and the second and so on.)", "format": "int32", "location": "query", - "required": true, "type": "integer" } }, - "path": "mylibrary/bookshelves/{shelf}/moveVolume", + "path": "books/v1/mylibrary/bookshelves/{shelf}/moveVolume", + "response": { + "$ref": "Empty" + }, "scopes": [ "https://www.googleapis.com/auth/books" ] }, "removeVolume": { "description": "Removes a volume from a bookshelf.", + "flatPath": "books/v1/mylibrary/bookshelves/{shelf}/removeVolume", "httpMethod": "POST", "id": "books.mylibrary.bookshelves.removeVolume", "parameterOrder": [ - "shelf", - "volumeId" + "shelf" ], "parameters": { "reason": { "description": "The reason for which the book is removed from the library.", "enum": [ + "REASON_UNDEFINED", "ONBOARDING" ], - "enumDescriptions": [ - "Samples removed from the Onboarding flow." - ], "location": "query", "type": "string" }, @@ -1391,11 +1417,13 @@ "volumeId": { "description": "ID of volume to remove.", "location": "query", - "required": true, "type": "string" } }, - "path": "mylibrary/bookshelves/{shelf}/removeVolume", + "path": "books/v1/mylibrary/bookshelves/{shelf}/removeVolume", + "response": { + "$ref": "Empty" + }, "scopes": [ "https://www.googleapis.com/auth/books" ] @@ -1406,6 +1434,7 @@ "methods": { "list": { "description": "Gets volume information for volumes on a bookshelf.", + "flatPath": "books/v1/mylibrary/bookshelves/{shelf}/volumes", "httpMethod": "GET", "id": "books.mylibrary.bookshelves.volumes.list", "parameterOrder": [ @@ -1421,18 +1450,14 @@ "description": "Maximum number of results to return", "format": "uint32", "location": "query", - "minimum": "0", "type": "integer" }, "projection": { "description": "Restrict information returned to a set of selected fields.", "enum": [ - "full", - "lite" - ], - "enumDescriptions": [ - "Includes all volume data.", - "Includes a subset of fields in volumeInfo and accessInfo." + "PROJECTION_UNDEFINED", + "FULL", + "LITE" ], "location": "query", "type": "string" @@ -1462,11 +1487,10 @@ "description": "Index of the first element to return (starts at 0)", "format": "uint32", "location": "query", - "minimum": "0", "type": "integer" } }, - "path": "mylibrary/bookshelves/{shelf}/volumes", + "path": "books/v1/mylibrary/bookshelves/{shelf}/volumes", "response": { "$ref": "Volumes" }, @@ -1482,6 +1506,7 @@ "methods": { "get": { "description": "Retrieves my reading position information for a volume.", + "flatPath": "books/v1/mylibrary/readingpositions/{volumeId}", "httpMethod": "GET", "id": "books.mylibrary.readingpositions.get", "parameterOrder": [ @@ -1505,7 +1530,7 @@ "type": "string" } }, - "path": "mylibrary/readingpositions/{volumeId}", + "path": "books/v1/mylibrary/readingpositions/{volumeId}", "response": { "$ref": "ReadingPosition" }, @@ -1515,17 +1540,17 @@ }, "setPosition": { "description": "Sets my reading position information for a volume.", + "flatPath": "books/v1/mylibrary/readingpositions/{volumeId}/setPosition", "httpMethod": "POST", "id": "books.mylibrary.readingpositions.setPosition", "parameterOrder": [ - "volumeId", - "timestamp", - "position" + "volumeId" ], "parameters": { "action": { "description": "Action that caused this reading position to be set.", "enum": [ + "ACTION_UNDEFINED", "bookmark", "chapter", "next-page", @@ -1533,14 +1558,6 @@ "scroll", "search" ], - "enumDescriptions": [ - "User chose bookmark within volume.", - "User selected chapter from list.", - "Next page event.", - "Previous page event.", - "User navigated to page.", - "User chose search results within volume." - ], "location": "query", "type": "string" }, @@ -1557,7 +1574,6 @@ "position": { "description": "Position string for the new volume reading position.", "location": "query", - "required": true, "type": "string" }, "source": { @@ -1568,7 +1584,6 @@ "timestamp": { "description": "RFC 3339 UTC format timestamp associated with this reading position.", "location": "query", - "required": true, "type": "string" }, "volumeId": { @@ -1578,7 +1593,10 @@ "type": "string" } }, - "path": "mylibrary/readingpositions/{volumeId}/setPosition", + "path": "books/v1/mylibrary/readingpositions/{volumeId}/setPosition", + "response": { + "$ref": "Empty" + }, "scopes": [ "https://www.googleapis.com/auth/books" ] @@ -1591,21 +1609,19 @@ "methods": { "get": { "description": "Returns notification details for a given notification id.", + "flatPath": "books/v1/notification/get", "httpMethod": "GET", "id": "books.notification.get", - "parameterOrder": [ - "notification_id" - ], + "parameterOrder": [], "parameters": { "locale": { - "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating notification title and body.", + "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for\ngenerating notification title and body.", "location": "query", "type": "string" }, "notification_id": { "description": "String to identify the notification.", "location": "query", - "required": true, "type": "string" }, "source": { @@ -1614,7 +1630,7 @@ "type": "string" } }, - "path": "notification/get", + "path": "books/v1/notification/get", "response": { "$ref": "Notification" }, @@ -1628,8 +1644,10 @@ "methods": { "listCategories": { "description": "List categories for onboarding experience.", + "flatPath": "books/v1/onboarding/listCategories", "httpMethod": "GET", "id": "books.onboarding.listCategories", + "parameterOrder": [], "parameters": { "locale": { "description": "ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.", @@ -1637,7 +1655,7 @@ "type": "string" } }, - "path": "onboarding/listCategories", + "path": "books/v1/onboarding/listCategories", "response": { "$ref": "Category" }, @@ -1647,8 +1665,10 @@ }, "listCategoryVolumes": { "description": "List available volumes under categories for onboarding experience.", + "flatPath": "books/v1/onboarding/listCategoryVolumes", "httpMethod": "GET", "id": "books.onboarding.listCategoryVolumes", + "parameterOrder": [], "parameters": { "categoryId": { "description": "List of category ids requested.", @@ -1662,15 +1682,12 @@ "type": "string" }, "maxAllowedMaturityRating": { - "description": "The maximum allowed maturity rating of returned volumes. Books with a higher maturity rating are filtered out.", + "description": "The maximum allowed maturity rating of returned volumes. Books with a\nhigher maturity rating are filtered out.", "enum": [ - "mature", + "MAX_ALLOWED_MATURITY_RATING_UNDEFINED", + "MATURE", "not-mature" ], - "enumDescriptions": [ - "Show books which are rated mature or lower.", - "Show books which are rated not mature." - ], "location": "query", "type": "string" }, @@ -1686,7 +1703,7 @@ "type": "string" } }, - "path": "onboarding/listCategoryVolumes", + "path": "books/v1/onboarding/listCategoryVolumes", "response": { "$ref": "Volume2" }, @@ -1700,24 +1717,23 @@ "methods": { "get": { "description": "Returns a stream of personalized book clusters", + "flatPath": "books/v1/personalizedstream/get", "httpMethod": "GET", "id": "books.personalizedstream.get", + "parameterOrder": [], "parameters": { "locale": { - "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.", + "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for\ngenerating recommendations.", "location": "query", "type": "string" }, "maxAllowedMaturityRating": { - "description": "The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.", + "description": "The maximum allowed maturity rating of returned recommendations. Books with\na higher maturity rating are filtered out.", "enum": [ - "mature", + "MAX_ALLOWED_MATURITY_RATING_UNDEFINED", + "MATURE", "not-mature" ], - "enumDescriptions": [ - "Show books which are rated mature or lower.", - "Show books which are rated not mature." - ], "location": "query", "type": "string" }, @@ -1727,7 +1743,7 @@ "type": "string" } }, - "path": "personalizedstream/get", + "path": "books/v1/personalizedstream/get", "response": { "$ref": "Discoveryclusters" }, @@ -1740,9 +1756,11 @@ "promooffer": { "methods": { "accept": { - "description": "", + "description": "Accepts the promo offer.", + "flatPath": "books/v1/promooffer/accept", "httpMethod": "POST", "id": "books.promooffer.accept", + "parameterOrder": [], "parameters": { "androidId": { "description": "device android_id", @@ -1784,15 +1802,20 @@ "type": "string" } }, - "path": "promooffer/accept", + "path": "books/v1/promooffer/accept", + "response": { + "$ref": "Empty" + }, "scopes": [ "https://www.googleapis.com/auth/books" ] }, "dismiss": { - "description": "", + "description": "Marks the promo offer as dismissed.", + "flatPath": "books/v1/promooffer/dismiss", "httpMethod": "POST", "id": "books.promooffer.dismiss", + "parameterOrder": [], "parameters": { "androidId": { "description": "device android_id", @@ -1830,15 +1853,20 @@ "type": "string" } }, - "path": "promooffer/dismiss", + "path": "books/v1/promooffer/dismiss", + "response": { + "$ref": "Empty" + }, "scopes": [ "https://www.googleapis.com/auth/books" ] }, "get": { "description": "Returns a list of promo offers available to the user", + "flatPath": "books/v1/promooffer/get", "httpMethod": "GET", "id": "books.promooffer.get", + "parameterOrder": [], "parameters": { "androidId": { "description": "device android_id", @@ -1871,7 +1899,7 @@ "type": "string" } }, - "path": "promooffer/get", + "path": "books/v1/promooffer/get", "response": { "$ref": "Offers" }, @@ -1885,21 +1913,19 @@ "methods": { "get": { "description": "Returns Series metadata for the given series ids.", + "flatPath": "books/v1/series/get", "httpMethod": "GET", "id": "books.series.get", - "parameterOrder": [ - "series_id" - ], + "parameterOrder": [], "parameters": { "series_id": { "description": "String that identifies the series", "location": "query", "repeated": true, - "required": true, "type": "string" } }, - "path": "series/get", + "path": "books/v1/series/get", "response": { "$ref": "Series" }, @@ -1913,11 +1939,10 @@ "methods": { "get": { "description": "Returns Series membership data given the series id.", + "flatPath": "books/v1/series/membership/get", "httpMethod": "GET", "id": "books.series.membership.get", - "parameterOrder": [ - "series_id" - ], + "parameterOrder": [], "parameters": { "page_size": { "description": "Number of maximum results per page to be included in the response.", @@ -1933,11 +1958,10 @@ "series_id": { "description": "String that identifies the series", "location": "query", - "required": true, "type": "string" } }, - "path": "series/membership/get", + "path": "books/v1/series/membership/get", "response": { "$ref": "Seriesmembership" }, @@ -1953,6 +1977,7 @@ "methods": { "get": { "description": "Gets volume information for a single volume.", + "flatPath": "books/v1/volumes/{volumeId}", "httpMethod": "GET", "id": "books.volumes.get", "parameterOrder": [ @@ -1977,18 +2002,15 @@ "projection": { "description": "Restrict information returned to a set of selected fields.", "enum": [ - "full", - "lite" - ], - "enumDescriptions": [ - "Includes all volume data.", - "Includes a subset of fields in volumeInfo and accessInfo." + "PROJECTION_UNDEFINED", + "FULL", + "LITE" ], "location": "query", "type": "string" }, "source": { - "description": "String to identify the originator of this request.", + "description": "string to identify the originator of this request.", "location": "query", "type": "string" }, @@ -2003,7 +2025,7 @@ "type": "string" } }, - "path": "volumes/{volumeId}", + "path": "books/v1/volumes/{volumeId}", "response": { "$ref": "Volume" }, @@ -2013,19 +2035,16 @@ }, "list": { "description": "Performs a book search.", + "flatPath": "books/v1/volumes", "httpMethod": "GET", "id": "books.volumes.list", - "parameterOrder": [ - "q" - ], + "parameterOrder": [], "parameters": { "download": { "description": "Restrict to volumes by download availability.", "enum": [ - "epub" - ], - "enumDescriptions": [ - "All volumes with epub." + "DOWNLOAD_UNDEFINED", + "EPUB" ], "location": "query", "type": "string" @@ -2033,19 +2052,13 @@ "filter": { "description": "Filter search results.", "enum": [ + "FILTER_UNDEFINED", "ebooks", "free-ebooks", "full", "paid-ebooks", "partial" ], - "enumDescriptions": [ - "All Google eBooks.", - "Google eBook with full volume text viewability.", - "Public can view entire volume text.", - "Google eBook with a price.", - "Public able to see parts of text." - ], "location": "query", "type": "string" }, @@ -2057,26 +2070,20 @@ "libraryRestrict": { "description": "Restrict search to this user's library.", "enum": [ + "LIBRARY_RESTRICT_UNDEFINED", "my-library", "no-restrict" ], - "enumDescriptions": [ - "Restrict to the user's library, any shelf.", - "Do not restrict based on user's library." - ], "location": "query", "type": "string" }, "maxAllowedMaturityRating": { - "description": "The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.", + "description": "The maximum allowed maturity rating of returned recommendations. Books with\na higher maturity rating are filtered out.", "enum": [ - "mature", + "MAX_ALLOWED_MATURITY_RATING_UNDEFINED", + "MATURE", "not-mature" ], - "enumDescriptions": [ - "Show books which are rated mature or lower.", - "Show books which are rated not mature." - ], "location": "query", "type": "string" }, @@ -2084,20 +2091,15 @@ "description": "Maximum number of results to return.", "format": "uint32", "location": "query", - "maximum": "40", - "minimum": "0", "type": "integer" }, "orderBy": { "description": "Sort search results.", "enum": [ + "ORDER_BY_UNDEFINED", "newest", "relevance" ], - "enumDescriptions": [ - "Most recently published.", - "Relevance to search terms." - ], "location": "query", "type": "string" }, @@ -2109,14 +2111,10 @@ "printType": { "description": "Restrict to books or magazines.", "enum": [ - "all", - "books", - "magazines" - ], - "enumDescriptions": [ - "All volume content types.", - "Just books.", - "Just magazines." + "PRINT_TYPE_UNDEFINED", + "ALL", + "BOOKS", + "MAGAZINES" ], "location": "query", "type": "string" @@ -2124,12 +2122,9 @@ "projection": { "description": "Restrict information returned to a set of selected fields.", "enum": [ - "full", - "lite" - ], - "enumDescriptions": [ - "Includes all volume data.", - "Includes a subset of fields in volumeInfo and accessInfo." + "PROJECTION_UNDEFINED", + "FULL", + "LITE" ], "location": "query", "type": "string" @@ -2137,7 +2132,6 @@ "q": { "description": "Full-text search query string.", "location": "query", - "required": true, "type": "string" }, "showPreorders": { @@ -2154,11 +2148,10 @@ "description": "Index of the first result to return (starts at 0)", "format": "uint32", "location": "query", - "minimum": "0", "type": "integer" } }, - "path": "volumes", + "path": "books/v1/volumes", "response": { "$ref": "Volumes" }, @@ -2172,6 +2165,7 @@ "methods": { "list": { "description": "Return a list of associated books.", + "flatPath": "books/v1/volumes/{volumeId}/associated", "httpMethod": "GET", "id": "books.volumes.associated.list", "parameterOrder": [ @@ -2181,33 +2175,26 @@ "association": { "description": "Association type.", "enum": [ + "ASSOCIATION_UNDEFINED", "end-of-sample", "end-of-volume", "related-for-play" ], - "enumDescriptions": [ - "Recommendations for display end-of-sample.", - "Recommendations for display end-of-volume.", - "Related volumes for Play Store." - ], "location": "query", "type": "string" }, "locale": { - "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.", + "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for\ngenerating recommendations.", "location": "query", "type": "string" }, "maxAllowedMaturityRating": { - "description": "The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.", + "description": "The maximum allowed maturity rating of returned recommendations. Books with\na higher maturity rating are filtered out.", "enum": [ - "mature", + "MAX_ALLOWED_MATURITY_RATING_UNDEFINED", + "MATURE", "not-mature" ], - "enumDescriptions": [ - "Show books which are rated mature or lower.", - "Show books which are rated not mature." - ], "location": "query", "type": "string" }, @@ -2223,7 +2210,7 @@ "type": "string" } }, - "path": "volumes/{volumeId}/associated", + "path": "books/v1/volumes/{volumeId}/associated", "response": { "$ref": "Volumes" }, @@ -2237,12 +2224,15 @@ "methods": { "list": { "description": "Return a list of books in My Library.", + "flatPath": "books/v1/volumes/mybooks", "httpMethod": "GET", "id": "books.volumes.mybooks.list", + "parameterOrder": [], "parameters": { "acquireMethod": { "description": "How the book was acquired", "enum": [ + "ACQUIRE_METHOD_UNDEFINED", "FAMILY_SHARED", "PREORDERED", "PREVIOUSLY_RENTED", @@ -2252,16 +2242,6 @@ "SAMPLE", "UPLOADED" ], - "enumDescriptions": [ - "Books acquired via Family Sharing", - "Preordered books (not yet available)", - "User-rented books past their expiration time", - "Public domain books", - "Purchased books", - "User-rented books", - "Sample books", - "User uploaded books" - ], "location": "query", "repeated": true, "type": "string" @@ -2272,7 +2252,7 @@ "type": "string" }, "locale": { - "description": "ISO-639-1 language and ISO-3166-1 country code. Ex:'en_US'. Used for generating recommendations.", + "description": "ISO-639-1 language and ISO-3166-1 country code. Ex:'en_US'. Used for\ngenerating recommendations.", "location": "query", "type": "string" }, @@ -2280,22 +2260,16 @@ "description": "Maximum number of results to return.", "format": "uint32", "location": "query", - "maximum": "100", - "minimum": "0", "type": "integer" }, "processingState": { - "description": "The processing state of the user uploaded volumes to be returned. Applicable only if the UPLOADED is specified in the acquireMethod.", + "description": "The processing state of the user uploaded volumes to be returned.\nApplicable only if the UPLOADED is specified in the acquireMethod.", "enum": [ + "PROCESSING_STATE_UNDEFINED", "COMPLETED_FAILED", "COMPLETED_SUCCESS", "RUNNING" ], - "enumDescriptions": [ - "The volume processing hase failed.", - "The volume processing was completed.", - "The volume processing is not completed." - ], "location": "query", "repeated": true, "type": "string" @@ -2309,11 +2283,10 @@ "description": "Index of the first result to return (starts at 0)", "format": "uint32", "location": "query", - "minimum": "0", "type": "integer" } }, - "path": "volumes/mybooks", + "path": "books/v1/volumes/mybooks", "response": { "$ref": "Volumes" }, @@ -2327,24 +2300,23 @@ "methods": { "list": { "description": "Return a list of recommended books for the current user.", + "flatPath": "books/v1/volumes/recommended", "httpMethod": "GET", "id": "books.volumes.recommended.list", + "parameterOrder": [], "parameters": { "locale": { - "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.", + "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for\ngenerating recommendations.", "location": "query", "type": "string" }, "maxAllowedMaturityRating": { - "description": "The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.", + "description": "The maximum allowed maturity rating of returned recommendations. Books with\na higher maturity rating are filtered out.", "enum": [ - "mature", + "MAX_ALLOWED_MATURITY_RATING_UNDEFINED", + "MATURE", "not-mature" ], - "enumDescriptions": [ - "Show books which are rated mature or lower.", - "Show books which are rated not mature." - ], "location": "query", "type": "string" }, @@ -2354,7 +2326,7 @@ "type": "string" } }, - "path": "volumes/recommended", + "path": "books/v1/volumes/recommended", "response": { "$ref": "Volumes" }, @@ -2364,30 +2336,24 @@ }, "rate": { "description": "Rate a recommended book for the current user.", + "flatPath": "books/v1/volumes/recommended/rate", "httpMethod": "POST", "id": "books.volumes.recommended.rate", - "parameterOrder": [ - "rating", - "volumeId" - ], + "parameterOrder": [], "parameters": { "locale": { - "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.", + "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for\ngenerating recommendations.", "location": "query", "type": "string" }, "rating": { "description": "Rating to be given to the volume.", "enum": [ + "RATING_UNDEFINED", "HAVE_IT", "NOT_INTERESTED" ], - "enumDescriptions": [ - "Rating indicating a dismissal due to ownership.", - "Rating indicating a negative dismissal of a volume." - ], "location": "query", - "required": true, "type": "string" }, "source": { @@ -2398,11 +2364,10 @@ "volumeId": { "description": "ID of the source volume.", "location": "query", - "required": true, "type": "string" } }, - "path": "volumes/recommended/rate", + "path": "books/v1/volumes/recommended/rate", "response": { "$ref": "BooksVolumesRecommendedRateResponse" }, @@ -2416,11 +2381,13 @@ "methods": { "list": { "description": "Return a list of books uploaded by the current user.", + "flatPath": "books/v1/volumes/useruploaded", "httpMethod": "GET", "id": "books.volumes.useruploaded.list", + "parameterOrder": [], "parameters": { "locale": { - "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.", + "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for\ngenerating recommendations.", "location": "query", "type": "string" }, @@ -2428,22 +2395,16 @@ "description": "Maximum number of results to return.", "format": "uint32", "location": "query", - "maximum": "40", - "minimum": "0", "type": "integer" }, "processingState": { "description": "The processing state of the user uploaded volumes to be returned.", "enum": [ + "PROCESSING_STATE_UNDEFINED", "COMPLETED_FAILED", "COMPLETED_SUCCESS", "RUNNING" ], - "enumDescriptions": [ - "The volume processing hase failed.", - "The volume processing was completed.", - "The volume processing is not completed." - ], "location": "query", "repeated": true, "type": "string" @@ -2457,17 +2418,16 @@ "description": "Index of the first result to return (starts at 0)", "format": "uint32", "location": "query", - "minimum": "0", "type": "integer" }, "volumeId": { - "description": "The ids of the volumes to be returned. If not specified all that match the processingState are returned.", + "description": "The ids of the volumes to be returned. If not specified all that match the\nprocessingState are returned.", "location": "query", "repeated": true, "type": "string" } }, - "path": "volumes/useruploaded", + "path": "books/v1/volumes/useruploaded", "response": { "$ref": "Volumes" }, @@ -2480,18 +2440,18 @@ } } }, - "revision": "20200310", + "revision": "20200606", "rootUrl": "https://www.googleapis.com/", "schemas": { "Annotation": { "id": "Annotation", "properties": { "afterSelectedText": { - "description": "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.", + "description": "Anchor text after excerpt. For requests, if the user bookmarked a screen\nthat has no flowing text on it, then this field should be empty.", "type": "string" }, "beforeSelectedText": { - "description": "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.", + "description": "Anchor text before excerpt. For requests, if the user bookmarked a screen\nthat has no flowing text on it, then this field should be empty.", "type": "string" }, "clientVersionRanges": { @@ -2522,7 +2482,6 @@ }, "created": { "description": "Timestamp for the created time of this annotation.", - "format": "date-time", "type": "string" }, "currentVersionRanges": { @@ -2568,7 +2527,6 @@ "type": "string" }, "kind": { - "default": "books#annotation", "description": "Resource type.", "type": "string" }, @@ -2579,16 +2537,16 @@ "layerSummary": { "properties": { "allowedCharacterCount": { - "description": "Maximum allowed characters on this layer, especially for the \"copy\" layer.", + "description": "Maximum allowed characters on this layer, especially for the \"copy\"\nlayer.", "format": "int32", "type": "integer" }, "limitType": { - "description": "Type of limitation on this layer. \"limited\" or \"unlimited\" for the \"copy\" layer.", + "description": "Type of limitation on this layer. \"limited\" or \"unlimited\" for the \"copy\"\nlayer.", "type": "string" }, "remainingCharacterCount": { - "description": "Remaining allowed characters on this layer, especially for the \"copy\" layer.", + "description": "Remaining allowed characters on this layer, especially for the \"copy\"\nlayer.", "format": "int32", "type": "integer" } @@ -2612,7 +2570,6 @@ }, "updated": { "description": "Timestamp for the last time this annotation was modified.", - "format": "date-time", "type": "string" }, "volumeId": { @@ -2622,50 +2579,6 @@ }, "type": "object" }, - "Annotationdata": { - "id": "Annotationdata", - "properties": { - "annotationType": { - "description": "The type of annotation this data is for.", - "type": "string" - }, - "data": { - "type": "any" - }, - "encoded_data": { - "description": "Base64 encoded data for this annotation data.", - "format": "byte", - "type": "string" - }, - "id": { - "description": "Unique id for this annotation data.", - "type": "string" - }, - "kind": { - "default": "books#annotationdata", - "description": "Resource Type", - "type": "string" - }, - "layerId": { - "description": "The Layer id for this data. *", - "type": "string" - }, - "selfLink": { - "description": "URL for this resource. *", - "type": "string" - }, - "updated": { - "description": "Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format).", - "format": "date-time", - "type": "string" - }, - "volumeId": { - "description": "The volume id for this data. *", - "type": "string" - } - }, - "type": "object" - }, "Annotations": { "id": "Annotations", "properties": { @@ -2677,16 +2590,15 @@ "type": "array" }, "kind": { - "default": "books#annotations", "description": "Resource type.", "type": "string" }, "nextPageToken": { - "description": "Token to pass in for pagination for the next page. This will not be present if this request does not have more results.", + "description": "Token to pass in for pagination for the next page. This will not be present\nif this request does not have more results.", "type": "string" }, "totalItems": { - "description": "Total number of annotations found. This may be greater than the number of notes returned in this response if results have been paginated.", + "description": "Total number of annotations found. This may be greater than the number of\nnotes returned in this response if results have been paginated.", "format": "int32", "type": "integer" } @@ -2697,7 +2609,6 @@ "id": "AnnotationsSummary", "properties": { "kind": { - "default": "books#annotationsSummary", "type": "string" }, "layers": { @@ -2718,7 +2629,6 @@ "type": "integer" }, "updated": { - "format": "date-time", "type": "string" } }, @@ -2735,17 +2645,16 @@ "items": { "description": "A list of Annotation Data.", "items": { - "$ref": "Annotationdata" + "$ref": "GeoAnnotationdata" }, "type": "array" }, "kind": { - "default": "books#annotationsdata", "description": "Resource type", "type": "string" }, "nextPageToken": { - "description": "Token to pass in for pagination for the next page. This will not be present if this request does not have more results.", + "description": "Token to pass in for pagination for the next page. This will not be present\nif this request does not have more results.", "type": "string" }, "totalItems": { @@ -2796,30 +2705,6 @@ }, "type": "object" }, - "BooksSubscriptionReleaseInfo": { - "id": "BooksSubscriptionReleaseInfo", - "properties": { - "amountInMicros": { - "description": "Amount in micros of the specified currency code.", - "format": "int64", - "type": "string" - }, - "currencyCode": { - "description": "Currency code of the amount.", - "type": "string" - }, - "releaseNumber": { - "description": "The release number of this issue/volume/book.", - "type": "string" - }, - "releaseTimestampUs": { - "description": "The release date.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, "BooksVolumesRecommendedRateResponse": { "id": "BooksVolumesRecommendedRateResponse", "properties": { @@ -2837,8 +2722,7 @@ "type": "string" }, "created": { - "description": "Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).", - "format": "date-time", + "description": "Created time for this bookshelf (formatted UTC timestamp with millisecond\nresolution).", "type": "string" }, "description": { @@ -2851,7 +2735,6 @@ "type": "integer" }, "kind": { - "default": "books#bookshelf", "description": "Resource type for bookshelf metadata.", "type": "string" }, @@ -2864,8 +2747,7 @@ "type": "string" }, "updated": { - "description": "Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).", - "format": "date-time", + "description": "Last modified time of this bookshelf (formatted UTC timestamp with\nmillisecond resolution).", "type": "string" }, "volumeCount": { @@ -2874,8 +2756,7 @@ "type": "integer" }, "volumesLastUpdated": { - "description": "Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).", - "format": "date-time", + "description": "Last time a volume was added or removed from this bookshelf (formatted UTC\ntimestamp with millisecond resolution).", "type": "string" } }, @@ -2892,7 +2773,6 @@ "type": "array" }, "kind": { - "default": "books#bookshelves", "description": "Resource type.", "type": "string" } @@ -2921,7 +2801,6 @@ "type": "array" }, "kind": { - "default": "onboarding#category", "description": "Resource type.", "type": "string" } @@ -2936,7 +2815,6 @@ "type": "boolean" }, "kind": { - "default": "books#concurrentAccessRestriction", "description": "Resource type.", "type": "string" }, @@ -2966,7 +2844,7 @@ "type": "string" }, "source": { - "description": "Client app identifier for verification. Download access and client-validation only.", + "description": "Client app identifier for verification. Download access and\nclient-validation only.", "type": "string" }, "timeWindowSeconds": { @@ -2981,13 +2859,56 @@ }, "type": "object" }, + "DictionaryAnnotationdata": { + "id": "DictionaryAnnotationdata", + "properties": { + "annotationType": { + "description": "The type of annotation this data is for.", + "type": "string" + }, + "data": { + "$ref": "Dictlayerdata", + "description": "JSON encoded data for this dictionary annotation data.\nEmitted with name 'data' in JSON output. Either this or geo_data will\nbe populated." + }, + "encodedData": { + "description": "Base64 encoded data for this annotation data.", + "format": "byte", + "type": "string" + }, + "id": { + "description": "Unique id for this annotation data.", + "type": "string" + }, + "kind": { + "description": "Resource Type", + "type": "string" + }, + "layerId": { + "description": "The Layer id for this data. *", + "type": "string" + }, + "selfLink": { + "description": "URL for this resource. *", + "type": "string" + }, + "updated": { + "description": "Timestamp for the last time this data was updated. (RFC 3339 UTC date-time\nformat).", + "type": "string" + }, + "volumeId": { + "description": "The volume id for this data. *", + "type": "string" + } + }, + "type": "object" + }, "Dictlayerdata": { "id": "Dictlayerdata", "properties": { "common": { "properties": { "title": { - "description": "The display title and localized canonical name to use when searching for this entity on Google search.", + "description": "The display title and localized canonical name to use when searching for\nthis entity on Google search.", "type": "string" } }, @@ -3155,7 +3076,7 @@ "type": "array" }, "source": { - "description": "The words with different meanings but not related words, e.g. \"go\" (game) and \"go\" (verb).", + "description": "The words with different meanings but not related words, e.g. \"go\"\n(game) and \"go\" (verb).", "properties": { "attribution": { "type": "string" @@ -3175,7 +3096,6 @@ "type": "object" }, "kind": { - "default": "books#dictlayerdata", "type": "string" } }, @@ -3235,7 +3155,6 @@ "type": "array" }, "kind": { - "default": "books#discovery#clusters", "description": "Resorce type.", "type": "string" }, @@ -3254,7 +3173,7 @@ "type": "boolean" }, "downloadsAcquired": { - "description": "If restricted, the number of content download licenses already acquired (including the requesting client, if licensed).", + "description": "If restricted, the number of content download licenses already acquired\n(including the requesting client, if licensed).", "format": "int32", "type": "integer" }, @@ -3263,12 +3182,11 @@ "type": "boolean" }, "kind": { - "default": "books#downloadAccessRestriction", "description": "Resource type.", "type": "string" }, "maxDownloadDevices": { - "description": "If restricted, the maximum number of content download licenses for this volume.", + "description": "If restricted, the maximum number of content download licenses for this\nvolume.", "format": "int32", "type": "integer" }, @@ -3281,7 +3199,7 @@ "type": "string" }, "reasonCode": { - "description": "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", + "description": "Error/warning reason code. Additional codes may be added in the future. 0\nOK 100 ACCESS_DENIED_PUBLISHER_LIMIT 101 ACCESS_DENIED_LIMIT 200\nWARNING_USED_LAST_ACCESS", "type": "string" }, "restricted": { @@ -3293,7 +3211,7 @@ "type": "string" }, "source": { - "description": "Client app identifier for verification. Download access and client-validation only.", + "description": "Client app identifier for verification. Download access and\nclient-validation only.", "type": "string" }, "volumeId": { @@ -3314,18 +3232,22 @@ "type": "array" }, "kind": { - "default": "books#downloadAccesses", "description": "Resource type.", "type": "string" } }, "type": "object" }, + "Empty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", + "id": "Empty", + "properties": {}, + "type": "object" + }, "FamilyInfo": { "id": "FamilyInfo", "properties": { "kind": { - "default": "books#familyInfo", "description": "Resource type.", "type": "string" }, @@ -3357,6 +3279,49 @@ }, "type": "object" }, + "GeoAnnotationdata": { + "id": "GeoAnnotationdata", + "properties": { + "annotationType": { + "description": "The type of annotation this data is for.", + "type": "string" + }, + "data": { + "$ref": "Geolayerdata", + "description": "JSON encoded data for this geo annotation data.\nEmitted with name 'data' in JSON output. Either this or dict_data will\nbe populated." + }, + "encodedData": { + "description": "Base64 encoded data for this annotation data.", + "format": "byte", + "type": "string" + }, + "id": { + "description": "Unique id for this annotation data.", + "type": "string" + }, + "kind": { + "description": "Resource Type", + "type": "string" + }, + "layerId": { + "description": "The Layer id for this data. *", + "type": "string" + }, + "selfLink": { + "description": "URL for this resource. *", + "type": "string" + }, + "updated": { + "description": "Timestamp for the last time this data was updated. (RFC 3339 UTC date-time\nformat).", + "type": "string" + }, + "volumeId": { + "description": "The volume id for this data. *", + "type": "string" + } + }, + "type": "object" + }, "Geolayerdata": { "id": "Geolayerdata", "properties": { @@ -3379,7 +3344,7 @@ "type": "string" }, "title": { - "description": "The display title and localized canonical name to use when searching for this entity on Google search.", + "description": "The display title and localized canonical name to use when searching for\nthis entity on Google search.", "type": "string" } }, @@ -3388,27 +3353,14 @@ "geo": { "properties": { "boundary": { - "description": "The boundary of the location as a set of loops containing pairs of latitude, longitude coordinates.", + "description": "The boundary of the location as a set of loops containing pairs of\nlatitude, longitude coordinates.", "items": { - "items": { - "properties": { - "latitude": { - "format": "uint32", - "type": "integer" - }, - "longitude": { - "format": "uint32", - "type": "integer" - } - }, - "type": "object" - }, - "type": "array" + "type": "string" }, "type": "array" }, "cachePolicy": { - "description": "The cache policy active for this data. EX: UNRESTRICTED, RESTRICTED, NEVER", + "description": "The cache policy active for this data. EX: UNRESTRICTED, RESTRICTED,\nNEVER", "type": "string" }, "countryCode": { @@ -3426,11 +3378,11 @@ "type": "number" }, "mapType": { - "description": "The type of map that should be used for this location. EX: HYBRID, ROADMAP, SATELLITE, TERRAIN", + "description": "The type of map that should be used for this location. EX: HYBRID,\nROADMAP, SATELLITE, TERRAIN", "type": "string" }, "viewport": { - "description": "The viewport for showing this location. This is a latitude, longitude rectangle.", + "description": "The viewport for showing this location. This is a latitude, longitude\nrectangle.", "properties": { "hi": { "properties": { @@ -3462,7 +3414,7 @@ "type": "object" }, "zoom": { - "description": "The Zoom level to use for the map. Zoom levels between 0 (the lowest zoom level, in which the entire world can be seen on one map) to 21+ (down to individual buildings). See: https://developers.google.com/maps/documentation/staticmaps/#Zoomlevels", + "description": "The Zoom level to use for the map. Zoom levels between 0 (the lowest zoom\nlevel, in which the entire world can be seen on one map) to 21+ (down to\nindividual buildings). See: https:\n//developers.google.com/maps/documentation/staticmaps/#Zoomlevels", "format": "int32", "type": "integer" } @@ -3470,7 +3422,6 @@ "type": "object" }, "kind": { - "default": "books#geolayerdata", "type": "string" } }, @@ -3487,7 +3438,6 @@ "type": "array" }, "kind": { - "default": "books#layersummaries", "description": "Resource type.", "type": "string" }, @@ -3536,7 +3486,6 @@ "type": "string" }, "kind": { - "default": "books#layersummary", "description": "Resource Type", "type": "string" }, @@ -3549,12 +3498,11 @@ "type": "string" }, "updated": { - "description": "Timestamp for the last time an item in this layer was updated. (RFC 3339 UTC date-time format).", - "format": "date-time", + "description": "Timestamp for the last time an item in this layer was updated. (RFC 3339\nUTC date-time format).", "type": "string" }, "volumeAnnotationsVersion": { - "description": "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.", + "description": "The current version of this layer's volume annotations. Note that this\nversion applies only to the data in the books.layers.volumeAnnotations.*\nresponses. The actual annotation data is versioned separately.", "type": "string" }, "volumeId": { @@ -3594,7 +3542,6 @@ "type": "array" }, "kind": { - "default": "dictionary#metadata", "description": "Resource type.", "type": "string" } @@ -3631,7 +3578,6 @@ "type": "boolean" }, "kind": { - "default": "books#notification", "description": "Resource type.", "type": "string" }, @@ -3711,7 +3657,6 @@ "type": "array" }, "kind": { - "default": "promooffer#offers", "description": "Resource type.", "type": "string" } @@ -3734,7 +3679,6 @@ "type": "string" }, "kind": { - "default": "books#readingPosition", "description": "Resource type for a reading position.", "type": "string" }, @@ -3743,8 +3687,7 @@ "type": "string" }, "updated": { - "description": "Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).", - "format": "date-time", + "description": "Timestamp when this reading position was last updated (formatted UTC\ntimestamp with millisecond resolution).", "type": "string" }, "volumeId": { @@ -3754,8 +3697,8 @@ }, "type": "object" }, - "RequestAccess": { - "id": "RequestAccess", + "RequestAccessData": { + "id": "RequestAccessData", "properties": { "concurrentAccess": { "$ref": "ConcurrentAccessRestriction", @@ -3766,7 +3709,6 @@ "description": "A download access response." }, "kind": { - "default": "books#requestAccess", "description": "Resource type.", "type": "string" } @@ -3799,16 +3741,15 @@ "type": "string" }, "kind": { - "default": "books#review", "description": "Resource type for a review.", "type": "string" }, "rating": { - "description": "Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.", + "description": "Star rating for this review. Possible values are ONE, TWO, THREE, FOUR,\nFIVE or NOT_RATED.", "type": "string" }, "source": { - "description": "Information regarding the source of this review, when the review is not from a Google Books user.", + "description": "Information regarding the source of this review, when the review is not\nfrom a Google Books user.", "properties": { "description": { "description": "Name of the source.", @@ -3830,7 +3771,7 @@ "type": "string" }, "type": { - "description": "Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.", + "description": "Source type for this review. Possible values are EDITORIAL, WEB_USER or\nGOOGLE_USER.", "type": "string" }, "volumeId": { @@ -3844,7 +3785,6 @@ "id": "Series", "properties": { "kind": { - "default": "books#series", "description": "Resource type.", "type": "string" }, @@ -3871,21 +3811,46 @@ }, "seriesSubscriptionReleaseInfo": { "properties": { - "cancellationTimestampUs": { - "description": "Cancellation date of the series subscription (or when it ends).", - "format": "int64", + "cancelTime": { "type": "string" }, "currentReleaseInfo": { - "$ref": "BooksSubscriptionReleaseInfo", - "description": "Release information for the last release." + "properties": { + "amountInMicros": { + "format": "double", + "type": "number" + }, + "currencyCode": { + "type": "string" + }, + "releaseNumber": { + "type": "string" + }, + "releaseTime": { + "type": "string" + } + }, + "type": "object" }, "nextReleaseInfo": { - "$ref": "BooksSubscriptionReleaseInfo", - "description": "Release information for the next release." + "properties": { + "amountInMicros": { + "format": "double", + "type": "number" + }, + "currencyCode": { + "type": "string" + }, + "releaseNumber": { + "type": "string" + }, + "releaseTime": { + "type": "string" + } + }, + "type": "object" }, "seriesSubscriptionType": { - "description": "series subscription type.", "type": "string" } }, @@ -3912,7 +3877,6 @@ "id": "Seriesmembership", "properties": { "kind": { - "default": "books#series#membership", "description": "Resorce type.", "type": "string" }, @@ -3932,7 +3896,6 @@ "id": "Usersettings", "properties": { "kind": { - "default": "books#usersettings", "description": "Resource type.", "type": "string" }, @@ -4000,14 +3963,14 @@ "id": "Volume", "properties": { "accessInfo": { - "description": "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.).", + "description": "Any information about a volume related to reading or obtaining that volume\ntext. This information can depend on country (books may be public domain in\none country but not in another, e.g.).", "properties": { "accessViewStatus": { - "description": "Combines the access and viewability of this volume into a single status field for this user. Values can be FULL_PURCHASED, FULL_PUBLIC_DOMAIN, SAMPLE or NONE. (In LITE projection.)", + "description": "Combines the access and viewability of this volume into a single status\nfield for this user. Values can be FULL_PURCHASED, FULL_PUBLIC_DOMAIN,\nSAMPLE or NONE. (In LITE projection.)", "type": "string" }, "country": { - "description": "The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.)", + "description": "The two-letter ISO_3166-1 country code for which this access information\nis valid. (In LITE projection.)", "type": "string" }, "downloadAccess": { @@ -4015,11 +3978,11 @@ "description": "Information about a volume's download license access restrictions." }, "driveImportedContentLink": { - "description": "URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive.", + "description": "URL to the Google Drive viewer if this volume is uploaded by the user by\nselecting the file from Google Drive.", "type": "string" }, "embeddable": { - "description": "Whether this volume can be embedded in a viewport using the Embedded Viewer API.", + "description": "Whether this volume can be embedded in a viewport using the Embedded\nViewer API.", "type": "boolean" }, "epub": { @@ -4034,14 +3997,14 @@ "type": "string" }, "isAvailable": { - "description": "Is a flowing text epub available either as public domain or for purchase. (In LITE projection.)", + "description": "Is a flowing text epub available either as public domain or for\npurchase. (In LITE projection.)", "type": "boolean" } }, "type": "object" }, "explicitOfflineLicenseManagement": { - "description": "Whether this volume requires that the client explicitly request offline download license rather than have it done automatically when loading the content, if the client supports it.", + "description": "Whether this volume requires that the client explicitly request offline\ndownload license rather than have it done automatically when loading the\ncontent, if the client supports it.", "type": "boolean" }, "pdf": { @@ -4056,7 +4019,7 @@ "type": "string" }, "isAvailable": { - "description": "Is a scanned image pdf available either as public domain or for purchase. (In LITE projection.)", + "description": "Is a scanned image pdf available either as public domain or for\npurchase. (In LITE projection.)", "type": "boolean" } }, @@ -4071,26 +4034,26 @@ "type": "boolean" }, "textToSpeechPermission": { - "description": "Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED.", + "description": "Whether text-to-speech is permitted for this volume. Values can be\nALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED.", "type": "string" }, "viewOrderUrl": { - "description": "For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page.", + "description": "For ordered but not yet processed orders, we give a URL that can be used\nto go to the appropriate Google Wallet page.", "type": "string" }, "viewability": { - "description": "The read access of a volume. Possible values are PARTIAL, ALL_PAGES, NO_PAGES or UNKNOWN. This value depends on the country listed above. A value of PARTIAL means that the publisher has allowed some portion of the volume to be viewed publicly, without purchase. This can apply to eBooks as well as non-eBooks. Public domain books will always have a value of ALL_PAGES.", + "description": "The read access of a volume. Possible values are PARTIAL, ALL_PAGES,\nNO_PAGES or UNKNOWN. This value depends on the country listed above. A\nvalue of PARTIAL means that the publisher has allowed some portion of the\nvolume to be viewed publicly, without purchase. This can apply to eBooks\nas well as non-eBooks. Public domain books will always have a value of\nALL_PAGES.", "type": "string" }, "webReaderLink": { - "description": "URL to read this volume on the Google Books site. Link will not allow users to read non-viewable volumes.", + "description": "URL to read this volume on the Google Books site. Link will not allow\nusers to read non-viewable volumes.", "type": "string" } }, "type": "object" }, "etag": { - "description": "Opaque identifier for a specific version of a volume resource. (In LITE projection)", + "description": "Opaque identifier for a specific version of a volume resource. (In LITE\nprojection)", "type": "string" }, "id": { @@ -4098,7 +4061,6 @@ "type": "string" }, "kind": { - "default": "books#volume", "description": "Resource type for a volume. (In LITE projection.)", "type": "string" }, @@ -4114,7 +4076,7 @@ "type": "string" }, "volumeAnnotationsVersion": { - "description": "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.", + "description": "The current version of this layer's volume annotations. Note that this\nversion applies only to the data in the\nbooks.layers.volumeAnnotations.* responses. The actual annotation data\nis versioned separately.", "type": "string" } }, @@ -4136,18 +4098,18 @@ "type": "object" }, "saleInfo": { - "description": "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).", + "description": "Any information about a volume related to the eBookstore and/or\npurchaseability. This information can depend on the country where the\nrequest originates from (i.e. books may not be for sale in certain\ncountries).", "properties": { "buyLink": { - "description": "URL to purchase this volume on the Google Books site. (In LITE projection)", + "description": "URL to purchase this volume on the Google Books site. (In LITE\nprojection)", "type": "string" }, "country": { - "description": "The two-letter ISO_3166-1 country code for which this sale information is valid. (In LITE projection.)", + "description": "The two-letter ISO_3166-1 country code for which this sale information is\nvalid. (In LITE projection.)", "type": "string" }, "isEbook": { - "description": "Whether or not this volume is an eBook (can be added to the My eBooks shelf).", + "description": "Whether or not this volume is an eBook (can be added to the My eBooks\nshelf).", "type": "boolean" }, "listPrice": { @@ -4224,11 +4186,10 @@ }, "onSaleDate": { "description": "The date on which this book is available for sale.", - "format": "date-time", "type": "string" }, "retailPrice": { - "description": "The actual selling price of the book. This is the same as the suggested retail or list price unless there are offers or discounts on this volume. (In LITE projection.)", + "description": "The actual selling price of the book. This is the same as the suggested\nretail or list price unless there are offers or discounts on this volume.\n(In LITE projection.)", "properties": { "amount": { "description": "Amount in the currency listed below. (In LITE projection.)", @@ -4243,7 +4204,7 @@ "type": "object" }, "saleability": { - "description": "Whether or not this book is available for sale or offered for free in the Google eBookstore for the country listed above. Possible values are FOR_SALE, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, FREE, NOT_FOR_SALE, or FOR_PREORDER.", + "description": "Whether or not this book is available for sale or offered for free in the\nGoogle eBookstore for the country listed above. Possible values are\nFOR_SALE, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, FREE, NOT_FOR_SALE, or\nFOR_PREORDER.", "type": "string" } }, @@ -4264,11 +4225,10 @@ "type": "string" }, "userInfo": { - "description": "User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)", + "description": "User specific information related to this volume. (e.g. page this user last\nread or whether they purchased this book)", "properties": { "acquiredTime": { - "description": "Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc.", - "format": "date-time", + "description": "Timestamp when this volume was acquired by the user. (RFC 3339 UTC\ndate-time format) Acquiring includes purchase, user upload, receiving\nfamily sharing, etc.", "type": "string" }, "acquisitionType": { @@ -4291,7 +4251,6 @@ "type": "integer" }, "updated": { - "format": "date-time", "type": "string" } }, @@ -4310,11 +4269,11 @@ "type": "string" }, "isSharingAllowed": { - "description": "Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action.", + "description": "Whether or not this volume can be shared with the family by the user.\nThis includes sharing eligibility of both the volume and the user. If\nthe value is true, the user can initiate a family sharing action.", "type": "boolean" }, "isSharingDisabledByFop": { - "description": "Whether or not sharing this volume is temporarily disabled due to issues with the Family Wallet.", + "description": "Whether or not sharing this volume is temporarily disabled due to\nissues with the Family Wallet.", "type": "boolean" } }, @@ -4341,11 +4300,11 @@ "type": "boolean" }, "isPreordered": { - "description": "Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)", + "description": "Whether or not this volume was pre-ordered by the authenticated user\nmaking the request. (In LITE projection.)", "type": "boolean" }, "isPurchased": { - "description": "Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)", + "description": "Whether or not this volume was purchased by the authenticated user making\nthe request. (In LITE projection.)", "type": "boolean" }, "isUploaded": { @@ -4354,7 +4313,7 @@ }, "readingPosition": { "$ref": "ReadingPosition", - "description": "The user's current reading position in the volume, if one is available. (In LITE projection.)" + "description": "The user's current reading position in the volume, if one is available.\n(In LITE projection.)" }, "rentalPeriod": { "description": "Period during this book is/was a valid rental.", @@ -4379,8 +4338,7 @@ "description": "This user's review of this volume, if one exists." }, "updated": { - "description": "Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).", - "format": "date-time", + "description": "Timestamp when this volume was last modified by a user action, such as a\nreading position update, volume purchase or writing a review. (RFC 3339\nUTC date-time format).", "type": "string" }, "userUploadedVolumeInfo": { @@ -4402,7 +4360,7 @@ "type": "boolean" }, "authors": { - "description": "The names of the authors and/or editors for this volume. (In LITE projection)", + "description": "The names of the authors and/or editors for this volume. (In LITE\nprojection)", "items": { "type": "string" }, @@ -4429,11 +4387,11 @@ "type": "boolean" }, "contentVersion": { - "description": "An identifier for the version of the volume content (text & images). (In LITE projection)", + "description": "An identifier for the version of the volume content (text & images). (In\nLITE projection)", "type": "string" }, "description": { - "description": "A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)", + "description": "A synopsis of the volume. The text of the description is formatted in\nHTML and includes simple formatting elements, such as b, i, and br tags.\n(In LITE projection.)", "type": "string" }, "dimensions": { @@ -4455,10 +4413,10 @@ "type": "object" }, "imageLinks": { - "description": "A list of image links for all the sizes that are available. (In LITE projection.)", + "description": "A list of image links for all the sizes that are available. (In LITE\nprojection.)", "properties": { "extraLarge": { - "description": "Image link for extra large size (width of ~1280 pixels). (In LITE projection)", + "description": "Image link for extra large size (width of ~1280 pixels). (In LITE\nprojection)", "type": "string" }, "large": { @@ -4474,11 +4432,11 @@ "type": "string" }, "smallThumbnail": { - "description": "Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)", + "description": "Image link for small thumbnail size (width of ~80 pixels). (In LITE\nprojection)", "type": "string" }, "thumbnail": { - "description": "Image link for thumbnail size (width of ~128 pixels). (In LITE projection)", + "description": "Image link for thumbnail size (width of ~128 pixels). (In LITE\nprojection)", "type": "string" } }, @@ -4502,15 +4460,15 @@ "type": "array" }, "infoLink": { - "description": "URL to view information about this volume on the Google Books site. (In LITE projection)", + "description": "URL to view information about this volume on the Google Books site. (In\nLITE projection)", "type": "string" }, "language": { - "description": "Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.", + "description": "Best language for this volume (based on content). It is the two-letter\nISO 639-1 code such as 'fr', 'en', etc.", "type": "string" }, "mainCategory": { - "description": "The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.", + "description": "The main category to which this volume belongs. It will be the category\nfrom the categories list returned below that has the highest weight.", "type": "string" }, "maturityRating": { @@ -4567,7 +4525,15 @@ }, "readingModes": { "description": "The reading modes available for this volume.", - "type": "any" + "properties": { + "image": { + "type": "boolean" + }, + "text": { + "type": "boolean" + } + }, + "type": "object" }, "samplePageCount": { "description": "Total number of sample pages as per publisher metadata.", @@ -4602,7 +4568,6 @@ "type": "array" }, "kind": { - "default": "onboarding#volume", "description": "Resource type.", "type": "string" }, @@ -4662,7 +4627,6 @@ "type": "string" }, "kind": { - "default": "books#volumeannotation", "description": "Resource Type", "type": "string" }, @@ -4686,8 +4650,7 @@ "type": "string" }, "updated": { - "description": "Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format).", - "format": "date-time", + "description": "Timestamp for the last time this anntoation was updated. (RFC 3339 UTC\ndate-time format).", "type": "string" }, "volumeId": { @@ -4708,12 +4671,11 @@ "type": "array" }, "kind": { - "default": "books#volumeannotations", "description": "Resource type", "type": "string" }, "nextPageToken": { - "description": "Token to pass in for pagination for the next page. This will not be present if this request does not have more results.", + "description": "Token to pass in for pagination for the next page. This will not be present\nif this request does not have more results.", "type": "string" }, "totalItems": { @@ -4722,7 +4684,7 @@ "type": "integer" }, "version": { - "description": "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).", + "description": "The version string for all of the volume annotations in this layer (not\njust the ones in this response). Note: the version string\ndoesn't apply to the annotation data, just the information in this response\n(e.g. the location of annotations in the book).", "type": "string" } }, @@ -4739,12 +4701,11 @@ "type": "array" }, "kind": { - "default": "books#volumes", "description": "Resource type.", "type": "string" }, "totalItems": { - "description": "Total number of volumes found. This might be greater than the number of volumes returned in this response if results have been paginated.", + "description": "Total number of volumes found. This might be greater than the number of\nvolumes returned in this response if results have been paginated.", "format": "int32", "type": "integer" } @@ -4755,11 +4716,10 @@ "id": "Volumeseriesinfo", "properties": { "bookDisplayNumber": { - "description": "The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber.", + "description": "The display number string. This should be used only for display purposes\nand the actual sequence should be inferred from the below orderNumber.", "type": "string" }, "kind": { - "default": "books#volume_series_info", "description": "Resource type.", "type": "string" }, @@ -4792,7 +4752,7 @@ "type": "integer" }, "seriesBookType": { - "description": "The book type in the context of series. Examples - Single Issue, Collection Edition, etc.", + "description": "The book type in the context of series. Examples - Single Issue,\nCollection Edition, etc.", "type": "string" }, "seriesId": { @@ -4808,7 +4768,8 @@ "type": "object" } }, - "servicePath": "books/v1/", + "servicePath": "", "title": "Books API", - "version": "v1" + "version": "v1", + "version_module": true } \ No newline at end of file diff --git a/src/apis/books/v1.ts b/src/apis/books/v1.ts index 2dec857ef3..03d4a65edd 100644 --- a/src/apis/books/v1.ts +++ b/src/apis/books/v1.ts @@ -53,9 +53,17 @@ export namespace books_v1 { | GoogleAuth; /** - * Data format for the response. + * V1 error format. + */ + '$.xgafv'?: string; + /** + * Data format for response. */ alt?: string; + /** + * JSONP + */ + callback?: string; /** * Selector specifying which fields to include in a partial response. */ @@ -64,28 +72,28 @@ export namespace books_v1 { * 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. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** - * Deprecated. Please use quotaUser instead. + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). */ - userIp?: string; + upload_protocol?: string; } /** * Books API * - * Searches for books and manages your Google Books library. + * The Google Books API allows clients to access the Google Books repository. * * @example * const {google} = require('googleapis'); @@ -218,41 +226,6 @@ export namespace books_v1 { */ volumeId?: string | null; } - export interface Schema$Annotationdata { - /** - * The type of annotation this data is for. - */ - annotationType?: string | null; - data?: any | null; - /** - * Base64 encoded data for this annotation data. - */ - encoded_data?: string | null; - /** - * Unique id for this annotation data. - */ - id?: string | null; - /** - * Resource Type - */ - kind?: string | null; - /** - * The Layer id for this data. * - */ - layerId?: string | null; - /** - * URL for this resource. * - */ - selfLink?: string | null; - /** - * Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format). - */ - updated?: string | null; - /** - * The volume id for this data. * - */ - volumeId?: string | null; - } export interface Schema$Annotations { /** * A list of annotations. @@ -275,7 +248,7 @@ export namespace books_v1 { /** * A list of Annotation Data. */ - items?: Schema$Annotationdata[]; + items?: Schema$GeoAnnotationdata[]; /** * Resource type */ @@ -375,24 +348,6 @@ export namespace books_v1 { */ kind?: string | null; } - export interface Schema$BooksSubscriptionReleaseInfo { - /** - * Amount in micros of the specified currency code. - */ - amountInMicros?: string | null; - /** - * Currency code of the amount. - */ - currencyCode?: string | null; - /** - * The release number of this issue/volume/book. - */ - releaseNumber?: string | null; - /** - * The release date. - */ - releaseTimestampUs?: string | null; - } export interface Schema$BooksVolumesRecommendedRateResponse { consistency_token?: string | null; } @@ -456,6 +411,44 @@ export namespace books_v1 { */ volumeId?: string | null; } + export interface Schema$DictionaryAnnotationdata { + /** + * The type of annotation this data is for. + */ + annotationType?: string | null; + /** + * JSON encoded data for this dictionary annotation data. Emitted with name 'data' in JSON output. Either this or geo_data will be populated. + */ + data?: Schema$Dictlayerdata; + /** + * Base64 encoded data for this annotation data. + */ + encodedData?: string | null; + /** + * Unique id for this annotation data. + */ + id?: string | null; + /** + * Resource Type + */ + kind?: string | null; + /** + * The Layer id for this data. * + */ + layerId?: string | null; + /** + * URL for this resource. * + */ + selfLink?: string | null; + /** + * Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format). + */ + updated?: string | null; + /** + * The volume id for this data. * + */ + volumeId?: string | null; + } export interface Schema$Dictlayerdata { common?: {title?: string} | null; dict?: { @@ -555,7 +548,7 @@ export namespace books_v1 { */ nonce?: string | null; /** - * 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 + * 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 | null; /** @@ -575,6 +568,10 @@ export namespace books_v1 { */ volumeId?: string | null; } + /** + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + */ + export interface Schema$Empty {} export interface Schema$FamilyInfo { /** * Resource type. @@ -591,6 +588,44 @@ export namespace books_v1 { role?: string; } | null; } + export interface Schema$GeoAnnotationdata { + /** + * The type of annotation this data is for. + */ + annotationType?: string | null; + /** + * JSON encoded data for this geo annotation data. Emitted with name 'data' in JSON output. Either this or dict_data will be populated. + */ + data?: Schema$Geolayerdata; + /** + * Base64 encoded data for this annotation data. + */ + encodedData?: string | null; + /** + * Unique id for this annotation data. + */ + id?: string | null; + /** + * Resource Type + */ + kind?: string | null; + /** + * The Layer id for this data. * + */ + layerId?: string | null; + /** + * URL for this resource. * + */ + selfLink?: string | null; + /** + * Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format). + */ + updated?: string | null; + /** + * The volume id for this data. * + */ + volumeId?: string | null; + } export interface Schema$Geolayerdata { common?: { lang?: string; @@ -600,7 +635,7 @@ export namespace books_v1 { title?: string; } | null; geo?: { - boundary?: Array>; + boundary?: string[]; cachePolicy?: string; countryCode?: string; latitude?: number; @@ -774,7 +809,7 @@ export namespace books_v1 { */ volumeId?: string | null; } - export interface Schema$RequestAccess { + export interface Schema$RequestAccessData { /** * A concurrent access response. */ @@ -847,9 +882,19 @@ export namespace books_v1 { seriesFormatType?: string; seriesId?: string; seriesSubscriptionReleaseInfo?: { - cancellationTimestampUs?: string; - currentReleaseInfo?: Schema$BooksSubscriptionReleaseInfo; - nextReleaseInfo?: Schema$BooksSubscriptionReleaseInfo; + cancelTime?: string; + currentReleaseInfo?: { + amountInMicros?: number; + currencyCode?: string; + releaseNumber?: string; + releaseTime?: string; + }; + nextReleaseInfo?: { + amountInMicros?: number; + currencyCode?: string; + releaseNumber?: string; + releaseTime?: string; + }; seriesSubscriptionType?: string; }; seriesType?: string; @@ -1031,7 +1076,7 @@ export namespace books_v1 { publishedDate?: string; publisher?: string; ratingsCount?: number; - readingModes?: any; + readingModes?: {image?: boolean; text?: boolean}; samplePageCount?: number; seriesInfo?: Schema$Volumeseriesinfo; subtitle?: string; @@ -1671,6 +1716,7 @@ export namespace books_v1 { /** * books.cloudloading.addBook + * @desc Add a user-upload volume and triggers processing. * @example * // Before running the sample: * // - Enable the API at: @@ -1701,7 +1747,7 @@ export namespace books_v1 { * mime_type: 'placeholder-value', * // The document name. It can be set only if the drive_document_id is set. * name: 'placeholder-value', - * + * // Scotty upload token. * upload_client_token: 'placeholder-value', * }); * console.log(res.data); @@ -1723,11 +1769,11 @@ export namespace books_v1 { * @alias books.cloudloading.addBook * @memberOf! () * - * @param {object=} params Parameters for request + * @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 {string=} params.upload_client_token Scotty upload 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 @@ -1849,6 +1895,9 @@ export namespace books_v1 { * volumeId: 'placeholder-value', * }); * console.log(res.data); + * + * // Example response + * // {} * } * * main().catch(e => { @@ -1860,7 +1909,7 @@ export namespace books_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.volumeId The id of the book to be removed. + * @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 @@ -1872,7 +1921,7 @@ export namespace books_v1 { deleteBook( params?: Params$Resource$Cloudloading$Deletebook, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; deleteBook( params: Params$Resource$Cloudloading$Deletebook, options: StreamMethodOptions | BodyResponseCallback, @@ -1880,26 +1929,28 @@ export namespace books_v1 { ): void; deleteBook( params: Params$Resource$Cloudloading$Deletebook, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; deleteBook( params: Params$Resource$Cloudloading$Deletebook, - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; - deleteBook(callback: BodyResponseCallback): void; + deleteBook(callback: BodyResponseCallback): void; deleteBook( paramsOrCallback?: | Params$Resource$Cloudloading$Deletebook - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, - callback?: BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || {}) as Params$Resource$Cloudloading$Deletebook; let options = (optionsOrCallback || {}) as MethodOptions; @@ -1928,22 +1979,23 @@ export namespace books_v1 { options ), params, - requiredParams: ['volumeId'], + requiredParams: [], pathParams: [], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** * books.cloudloading.updateBook + * @desc Updates a user-upload volume. * @example * // Before running the sample: * // - Enable the API at: @@ -2106,7 +2158,7 @@ export namespace books_v1 { */ name?: string; /** - * + * Scotty upload token. */ upload_client_token?: string; } @@ -2179,7 +2231,7 @@ export namespace books_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.cpksver The device/version ID from which to request the data. + * @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 @@ -2249,7 +2301,7 @@ export namespace books_v1 { options ), params, - requiredParams: ['cpksver'], + requiredParams: [], pathParams: [], context: this.context, }; @@ -2325,7 +2377,7 @@ export namespace books_v1 { * @alias books.familysharing.getFamilyInfo * @memberOf! () * - * @param {object=} params Parameters for request + * @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. @@ -2445,6 +2497,9 @@ export namespace books_v1 { * volumeId: 'placeholder-value', * }); * console.log(res.data); + * + * // Example response + * // {} * } * * main().catch(e => { @@ -2455,7 +2510,7 @@ export namespace books_v1 { * @alias books.familysharing.share * @memberOf! () * - * @param {object=} params Parameters for request + * @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. @@ -2470,7 +2525,7 @@ export namespace books_v1 { share( params?: Params$Resource$Familysharing$Share, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; share( params: Params$Resource$Familysharing$Share, options: StreamMethodOptions | BodyResponseCallback, @@ -2478,26 +2533,28 @@ export namespace books_v1 { ): void; share( params: Params$Resource$Familysharing$Share, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; share( params: Params$Resource$Familysharing$Share, - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; - share(callback: BodyResponseCallback): void; + share(callback: BodyResponseCallback): void; share( paramsOrCallback?: | Params$Resource$Familysharing$Share - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, - callback?: BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || {}) as Params$Resource$Familysharing$Share; let options = (optionsOrCallback || {}) as MethodOptions; @@ -2531,12 +2588,12 @@ export namespace books_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } @@ -2575,6 +2632,9 @@ export namespace books_v1 { * volumeId: 'placeholder-value', * }); * console.log(res.data); + * + * // Example response + * // {} * } * * main().catch(e => { @@ -2585,7 +2645,7 @@ export namespace books_v1 { * @alias books.familysharing.unshare * @memberOf! () * - * @param {object=} params Parameters for request + * @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. @@ -2600,7 +2660,7 @@ export namespace books_v1 { unshare( params?: Params$Resource$Familysharing$Unshare, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; unshare( params: Params$Resource$Familysharing$Unshare, options: StreamMethodOptions | BodyResponseCallback, @@ -2608,26 +2668,28 @@ export namespace books_v1 { ): void; unshare( params: Params$Resource$Familysharing$Unshare, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; unshare( params: Params$Resource$Familysharing$Unshare, - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; - unshare(callback: BodyResponseCallback): void; + unshare(callback: BodyResponseCallback): void; unshare( paramsOrCallback?: | Params$Resource$Familysharing$Unshare - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, - callback?: BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || {}) as Params$Resource$Familysharing$Unshare; let options = (optionsOrCallback || {}) as MethodOptions; @@ -2661,12 +2723,12 @@ export namespace books_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } @@ -3095,11 +3157,13 @@ export namespace books_v1 { * annotationDataId: 'placeholder-value', * // The content version for the volume you are trying to retrieve. * contentVersion: 'placeholder-value', - * // The requested pixel height for any images. If height is provided width must also be provided. + * // The requested pixel height for any images. If height is provided width must + * // also be provided. * h: 'placeholder-value', * // The ID for the layer to get the annotations. * layerId: 'placeholder-value', - * // The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. + * // The locale information for the data. ISO-639-1 language and ISO-3166-1 + * // country code. Ex: 'en_US'. * locale: 'placeholder-value', * // The requested scale for the image. * scale: 'placeholder-value', @@ -3107,7 +3171,8 @@ export namespace books_v1 { * source: 'placeholder-value', * // The volume to retrieve annotations for. * volumeId: 'placeholder-value', - * // The requested pixel width for any images. If width is provided height must also be provided. + * // The requested pixel width for any images. If width is provided height must + * // also be provided. * w: 'placeholder-value', * }); * console.log(res.data); @@ -3116,7 +3181,7 @@ export namespace books_v1 { * // { * // "annotationType": "my_annotationType", * // "data": {}, - * // "encoded_data": "my_encoded_data", + * // "encodedData": "my_encodedData", * // "id": "my_id", * // "kind": "my_kind", * // "layerId": "my_layerId", @@ -3137,7 +3202,7 @@ export namespace books_v1 { * @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 {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'. @@ -3156,7 +3221,7 @@ export namespace books_v1 { get( params?: Params$Resource$Layers$Annotationdata$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( params: Params$Resource$Layers$Annotationdata$Get, options: StreamMethodOptions | BodyResponseCallback, @@ -3164,28 +3229,33 @@ export namespace books_v1 { ): void; get( params: Params$Resource$Layers$Annotationdata$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( params: Params$Resource$Layers$Annotationdata$Get, - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: | Params$Resource$Layers$Annotationdata$Get - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || {}) as Params$Resource$Layers$Annotationdata$Get; let options = (optionsOrCallback || {}) as MethodOptions; @@ -3214,22 +3284,17 @@ export namespace books_v1 { options ), params, - requiredParams: [ - 'volumeId', - 'layerId', - 'annotationDataId', - 'contentVersion', - ], + requiredParams: ['volumeId', 'layerId', 'annotationDataId'], pathParams: ['annotationDataId', 'layerId', 'volumeId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } @@ -3260,15 +3325,18 @@ export namespace books_v1 { * * // Do the magic * const res = await books.layers.annotationData.list({ - * // The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set. + * // The list of Annotation Data Ids to retrieve. Pagination is ignored if this + * // is set. * annotationDataId: 'placeholder-value', * // The content version for the requested volume. * contentVersion: 'placeholder-value', - * // The requested pixel height for any images. If height is provided width must also be provided. + * // The requested pixel height for any images. If height is provided width must + * // also be provided. * h: 'placeholder-value', * // The ID for the layer to get the annotation data. * layerId: 'placeholder-value', - * // The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. + * // The locale information for the data. ISO-639-1 language and ISO-3166-1 + * // country code. Ex: 'en_US'. * locale: 'placeholder-value', * // Maximum number of results to return * maxResults: 'placeholder-value', @@ -3278,13 +3346,16 @@ export namespace books_v1 { * scale: 'placeholder-value', * // String to identify the originator of this request. * source: 'placeholder-value', - * // RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive). + * // RFC 3339 timestamp to restrict to items updated prior to this timestamp + * // (exclusive). * updatedMax: 'placeholder-value', - * // RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive). + * // RFC 3339 timestamp to restrict to items updated since this timestamp + * // (inclusive). * updatedMin: 'placeholder-value', * // The volume to retrieve annotation data for. * volumeId: 'placeholder-value', - * // The requested pixel width for any images. If width is provided height must also be provided. + * // The requested pixel width for any images. If width is provided height must + * // also be provided. * w: 'placeholder-value', * }); * console.log(res.data); @@ -3308,7 +3379,7 @@ export namespace books_v1 { * * @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 {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'. @@ -3388,7 +3459,7 @@ export namespace books_v1 { options ), params, - requiredParams: ['volumeId', 'layerId', 'contentVersion'], + requiredParams: ['volumeId', 'layerId'], pathParams: ['layerId', 'volumeId'], context: this.context, }; @@ -3539,7 +3610,8 @@ export namespace books_v1 { * annotationId: 'placeholder-value', * // The ID for the layer to get the annotations. * layerId: 'placeholder-value', - * // The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. + * // The locale information for the data. ISO-639-1 language and ISO-3166-1 + * // country code. Ex: 'en_US'. * locale: 'placeholder-value', * // String to identify the originator of this request. * source: 'placeholder-value', @@ -3699,13 +3771,15 @@ export namespace books_v1 { * endPosition: 'placeholder-value', * // The ID for the layer to get the annotations. * layerId: 'placeholder-value', - * // The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. + * // The locale information for the data. ISO-639-1 language and ISO-3166-1 + * // country code. Ex: 'en_US'. * locale: 'placeholder-value', * // Maximum number of results to return * maxResults: 'placeholder-value', * // The value of the nextToken from the previous page. * pageToken: 'placeholder-value', - * // Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false. + * // Set to true to return deleted annotations. updatedMin must be in the + * // request to use this. Defaults to false. * showDeleted: 'placeholder-value', * // String to identify the originator of this request. * source: 'placeholder-value', @@ -3713,9 +3787,11 @@ export namespace books_v1 { * startOffset: 'placeholder-value', * // The start position to start retrieving data from. * startPosition: 'placeholder-value', - * // RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive). + * // RFC 3339 timestamp to restrict to items updated prior to this timestamp + * // (exclusive). * updatedMax: 'placeholder-value', - * // RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive). + * // RFC 3339 timestamp to restrict to items updated since this timestamp + * // (inclusive). * updatedMin: 'placeholder-value', * // The version of the volume annotations that you are requesting. * volumeAnnotationsVersion: 'placeholder-value', @@ -3743,7 +3819,7 @@ export namespace books_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.contentVersion The content version for the requested volume. + * @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. @@ -3829,7 +3905,7 @@ export namespace books_v1 { options ), params, - requiredParams: ['volumeId', 'layerId', 'contentVersion'], + requiredParams: ['volumeId', 'layerId'], pathParams: ['layerId', 'volumeId'], context: this.context, }; @@ -3963,7 +4039,10 @@ export namespace books_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await books.myconfig.getUserSettings({}); + * const res = await books.myconfig.getUserSettings({ + * // Unused. Added only to workaround TEX mandatory request template requirement + * country: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -3982,7 +4061,8 @@ export namespace books_v1 { * @alias books.myconfig.getUserSettings * @memberOf! () * - * @param {object=} params Parameters for request + * @param {object} params Parameters for request + * @param {string=} params.country Unused. Added only to workaround TEX mandatory request template requirement * @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 @@ -4120,10 +4200,10 @@ export namespace books_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.cpksver The device/version ID from which to release the restriction. + * @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 {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 @@ -4195,7 +4275,7 @@ export namespace books_v1 { options ), params, - requiredParams: ['volumeIds', 'cpksver'], + requiredParams: [], pathParams: [], context: this.context, }; @@ -4238,7 +4318,8 @@ export namespace books_v1 { * const res = await books.myconfig.requestAccess({ * // The device/version ID from which to request the restrictions. * cpksver: 'placeholder-value', - * // The type of access license to request. If not specified, the default is BOTH. + * // The type of access license to request. If not specified, the default is + * // BOTH. * licenseTypes: 'placeholder-value', * // ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US. * locale: 'placeholder-value', @@ -4268,12 +4349,12 @@ export namespace books_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.cpksver The device/version ID from which to request the restrictions. + * @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 {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 @@ -4285,7 +4366,7 @@ export namespace books_v1 { requestAccess( params?: Params$Resource$Myconfig$Requestaccess, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; requestAccess( params: Params$Resource$Myconfig$Requestaccess, options: StreamMethodOptions | BodyResponseCallback, @@ -4293,28 +4374,33 @@ export namespace books_v1 { ): void; requestAccess( params: Params$Resource$Myconfig$Requestaccess, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; requestAccess( params: Params$Resource$Myconfig$Requestaccess, - callback: BodyResponseCallback + callback: BodyResponseCallback + ): void; + requestAccess( + callback: BodyResponseCallback ): void; - requestAccess(callback: BodyResponseCallback): void; requestAccess( paramsOrCallback?: | Params$Resource$Myconfig$Requestaccess - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || {}) as Params$Resource$Myconfig$Requestaccess; let options = (optionsOrCallback || {}) as MethodOptions; @@ -4343,17 +4429,17 @@ export namespace books_v1 { options ), params, - requiredParams: ['source', 'volumeId', 'nonce', 'cpksver'], + requiredParams: [], pathParams: [], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } @@ -4420,13 +4506,13 @@ export namespace books_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.cpksver The device/version ID from which to release the restriction. + * @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 {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.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. @@ -4497,7 +4583,7 @@ export namespace books_v1 { options ), params, - requiredParams: ['source', 'nonce', 'cpksver'], + requiredParams: [], pathParams: [], context: this.context, }; @@ -4655,7 +4741,12 @@ export namespace books_v1 { } export interface Params$Resource$Myconfig$Getusersettings - extends StandardParameters {} + extends StandardParameters { + /** + * Unused. Added only to workaround TEX mandatory request template requirement + */ + country?: string; + } export interface Params$Resource$Myconfig$Releasedownloadaccess extends StandardParameters { /** @@ -4799,6 +4890,9 @@ export namespace books_v1 { * source: 'placeholder-value', * }); * console.log(res.data); + * + * // Example response + * // {} * } * * main().catch(e => { @@ -4823,7 +4917,7 @@ export namespace books_v1 { delete( params?: Params$Resource$Mylibrary$Annotations$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( params: Params$Resource$Mylibrary$Annotations$Delete, options: StreamMethodOptions | BodyResponseCallback, @@ -4831,26 +4925,28 @@ export namespace books_v1 { ): void; delete( params: Params$Resource$Mylibrary$Annotations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( params: Params$Resource$Mylibrary$Annotations$Delete, - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: | Params$Resource$Mylibrary$Annotations$Delete - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, - callback?: BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || {}) as Params$Resource$Mylibrary$Annotations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; @@ -4883,12 +4979,12 @@ export namespace books_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } @@ -4923,7 +5019,8 @@ export namespace books_v1 { * annotationId: 'placeholder-value', * // ISO-3166-1 code to override the IP-based location. * country: 'placeholder-value', - * // Requests that only the summary of the specified layer be provided in the response. + * // Requests that only the summary of the specified layer be provided in the + * // response. * showOnlySummaryInResponse: 'placeholder-value', * // String to identify the originator of this request. * source: 'placeholder-value', @@ -5110,13 +5207,16 @@ export namespace books_v1 { * maxResults: 'placeholder-value', * // The value of the nextToken from the previous page. * pageToken: 'placeholder-value', - * // Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false. + * // Set to true to return deleted annotations. updatedMin must be in the + * // request to use this. Defaults to false. * showDeleted: 'placeholder-value', * // String to identify the originator of this request. * source: 'placeholder-value', - * // RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive). + * // RFC 3339 timestamp to restrict to items updated prior to this timestamp + * // (exclusive). * updatedMax: 'placeholder-value', - * // RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive). + * // RFC 3339 timestamp to restrict to items updated since this timestamp + * // (inclusive). * updatedMin: 'placeholder-value', * // The volume to restrict annotations to. * volumeId: 'placeholder-value', @@ -5140,7 +5240,7 @@ export namespace books_v1 { * @alias books.mylibrary.annotations.list * @memberOf! () * - * @param {object=} params Parameters for request + * @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. @@ -5284,8 +5384,8 @@ export namespace books_v1 { * @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 {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 @@ -5358,7 +5458,7 @@ export namespace books_v1 { options ), params, - requiredParams: ['layerIds', 'volumeId'], + requiredParams: [], pathParams: [], context: this.context, }; @@ -5698,6 +5798,9 @@ export namespace books_v1 { * volumeId: 'placeholder-value', * }); * console.log(res.data); + * + * // Example response + * // {} * } * * main().catch(e => { @@ -5712,7 +5815,7 @@ export namespace books_v1 { * @param {string=} params.reason The reason for which the book is added to the library. * @param {string} params.shelf ID of bookshelf to which to add a volume. * @param {string=} params.source String to identify the originator of this request. - * @param {string} params.volumeId ID of volume to add. + * @param {string=} params.volumeId ID of volume to add. * @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 @@ -5724,7 +5827,7 @@ export namespace books_v1 { addVolume( params?: Params$Resource$Mylibrary$Bookshelves$Addvolume, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; addVolume( params: Params$Resource$Mylibrary$Bookshelves$Addvolume, options: StreamMethodOptions | BodyResponseCallback, @@ -5732,26 +5835,28 @@ export namespace books_v1 { ): void; addVolume( params: Params$Resource$Mylibrary$Bookshelves$Addvolume, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; addVolume( params: Params$Resource$Mylibrary$Bookshelves$Addvolume, - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; - addVolume(callback: BodyResponseCallback): void; + addVolume(callback: BodyResponseCallback): void; addVolume( paramsOrCallback?: | Params$Resource$Mylibrary$Bookshelves$Addvolume - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, - callback?: BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || {}) as Params$Resource$Mylibrary$Bookshelves$Addvolume; let options = (optionsOrCallback || {}) as MethodOptions; @@ -5779,17 +5884,17 @@ export namespace books_v1 { options ), params, - requiredParams: ['shelf', 'volumeId'], + requiredParams: ['shelf'], pathParams: ['shelf'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } @@ -5826,6 +5931,9 @@ export namespace books_v1 { * source: 'placeholder-value', * }); * console.log(res.data); + * + * // Example response + * // {} * } * * main().catch(e => { @@ -5850,7 +5958,7 @@ export namespace books_v1 { clearVolumes( params?: Params$Resource$Mylibrary$Bookshelves$Clearvolumes, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; clearVolumes( params: Params$Resource$Mylibrary$Bookshelves$Clearvolumes, options: StreamMethodOptions | BodyResponseCallback, @@ -5858,26 +5966,28 @@ export namespace books_v1 { ): void; clearVolumes( params: Params$Resource$Mylibrary$Bookshelves$Clearvolumes, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; clearVolumes( params: Params$Resource$Mylibrary$Bookshelves$Clearvolumes, - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; - clearVolumes(callback: BodyResponseCallback): void; + clearVolumes(callback: BodyResponseCallback): void; clearVolumes( paramsOrCallback?: | Params$Resource$Mylibrary$Bookshelves$Clearvolumes - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, - callback?: BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || {}) as Params$Resource$Mylibrary$Bookshelves$Clearvolumes; let options = (optionsOrCallback || {}) as MethodOptions; @@ -5910,12 +6020,12 @@ export namespace books_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } @@ -6109,7 +6219,7 @@ export namespace books_v1 { * @alias books.mylibrary.bookshelves.list * @memberOf! () * - * @param {object=} params Parameters for request + * @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. @@ -6227,10 +6337,14 @@ export namespace books_v1 { * source: 'placeholder-value', * // ID of volume to move. * volumeId: 'placeholder-value', - * // Position on shelf to move the item (0 puts the item before the current first item, 1 puts it between the first and the second and so on.) + * // Position on shelf to move the item (0 puts the item before the current + * // first item, 1 puts it between the first and the second and so on.) * volumePosition: 'placeholder-value', * }); * console.log(res.data); + * + * // Example response + * // {} * } * * main().catch(e => { @@ -6244,8 +6358,8 @@ export namespace books_v1 { * @param {object} params Parameters for request * @param {string} params.shelf ID of bookshelf with the volume. * @param {string=} params.source String to identify the originator of this request. - * @param {string} params.volumeId ID of volume to move. - * @param {integer} params.volumePosition Position on shelf to move the item (0 puts the item before the current first item, 1 puts it between the first and the second and so on.) + * @param {string=} params.volumeId ID of volume to move. + * @param {integer=} params.volumePosition Position on shelf to move the item (0 puts the item before the current first item, 1 puts it between the first and the second and so on.) * @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 @@ -6257,7 +6371,7 @@ export namespace books_v1 { moveVolume( params?: Params$Resource$Mylibrary$Bookshelves$Movevolume, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; moveVolume( params: Params$Resource$Mylibrary$Bookshelves$Movevolume, options: StreamMethodOptions | BodyResponseCallback, @@ -6265,26 +6379,28 @@ export namespace books_v1 { ): void; moveVolume( params: Params$Resource$Mylibrary$Bookshelves$Movevolume, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; moveVolume( params: Params$Resource$Mylibrary$Bookshelves$Movevolume, - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; - moveVolume(callback: BodyResponseCallback): void; + moveVolume(callback: BodyResponseCallback): void; moveVolume( paramsOrCallback?: | Params$Resource$Mylibrary$Bookshelves$Movevolume - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, - callback?: BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || {}) as Params$Resource$Mylibrary$Bookshelves$Movevolume; let options = (optionsOrCallback || {}) as MethodOptions; @@ -6312,17 +6428,17 @@ export namespace books_v1 { options ), params, - requiredParams: ['shelf', 'volumeId', 'volumePosition'], + requiredParams: ['shelf'], pathParams: ['shelf'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } @@ -6363,6 +6479,9 @@ export namespace books_v1 { * volumeId: 'placeholder-value', * }); * console.log(res.data); + * + * // Example response + * // {} * } * * main().catch(e => { @@ -6377,7 +6496,7 @@ export namespace books_v1 { * @param {string=} params.reason The reason for which the book is removed from the library. * @param {string} params.shelf ID of bookshelf from which to remove a volume. * @param {string=} params.source String to identify the originator of this request. - * @param {string} params.volumeId ID of volume to remove. + * @param {string=} params.volumeId ID of volume to remove. * @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 @@ -6389,7 +6508,7 @@ export namespace books_v1 { removeVolume( params?: Params$Resource$Mylibrary$Bookshelves$Removevolume, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; removeVolume( params: Params$Resource$Mylibrary$Bookshelves$Removevolume, options: StreamMethodOptions | BodyResponseCallback, @@ -6397,26 +6516,28 @@ export namespace books_v1 { ): void; removeVolume( params: Params$Resource$Mylibrary$Bookshelves$Removevolume, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; removeVolume( params: Params$Resource$Mylibrary$Bookshelves$Removevolume, - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; - removeVolume(callback: BodyResponseCallback): void; + removeVolume(callback: BodyResponseCallback): void; removeVolume( paramsOrCallback?: | Params$Resource$Mylibrary$Bookshelves$Removevolume - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, - callback?: BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || {}) as Params$Resource$Mylibrary$Bookshelves$Removevolume; let options = (optionsOrCallback || {}) as MethodOptions; @@ -6444,17 +6565,17 @@ export namespace books_v1 { options ), params, - requiredParams: ['shelf', 'volumeId'], + requiredParams: ['shelf'], pathParams: ['shelf'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } @@ -6933,6 +7054,9 @@ export namespace books_v1 { * volumeId: 'placeholder-value', * }); * console.log(res.data); + * + * // Example response + * // {} * } * * main().catch(e => { @@ -6947,9 +7071,9 @@ export namespace books_v1 { * @param {string=} params.action Action that caused this reading position to be set. * @param {string=} params.contentVersion Volume content version for which this reading position applies. * @param {string=} params.deviceCookie Random persistent device cookie optional on set position. - * @param {string} params.position Position string for the new volume reading position. + * @param {string=} params.position Position string for the new volume reading position. * @param {string=} params.source String to identify the originator of this request. - * @param {string} params.timestamp RFC 3339 UTC format timestamp associated with this reading position. + * @param {string=} params.timestamp RFC 3339 UTC format timestamp associated with this reading position. * @param {string} params.volumeId ID of volume for which to update the reading position. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6962,7 +7086,7 @@ export namespace books_v1 { setPosition( params?: Params$Resource$Mylibrary$Readingpositions$Setposition, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; setPosition( params: Params$Resource$Mylibrary$Readingpositions$Setposition, options: StreamMethodOptions | BodyResponseCallback, @@ -6970,26 +7094,28 @@ export namespace books_v1 { ): void; setPosition( params: Params$Resource$Mylibrary$Readingpositions$Setposition, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; setPosition( params: Params$Resource$Mylibrary$Readingpositions$Setposition, - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; - setPosition(callback: BodyResponseCallback): void; + setPosition(callback: BodyResponseCallback): void; setPosition( paramsOrCallback?: | Params$Resource$Mylibrary$Readingpositions$Setposition - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, - callback?: BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || {}) as Params$Resource$Mylibrary$Readingpositions$Setposition; let options = (optionsOrCallback || {}) as MethodOptions; @@ -7018,17 +7144,17 @@ export namespace books_v1 { options ), params, - requiredParams: ['volumeId', 'timestamp', 'position'], + requiredParams: ['volumeId'], pathParams: ['volumeId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } @@ -7113,7 +7239,8 @@ export namespace books_v1 { * * // Do the magic * const res = await books.notification.get({ - * // ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating notification title and body. + * // ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for + * // generating notification title and body. * locale: 'placeholder-value', * // String to identify the notification. * notification_id: 'placeholder-value', @@ -7153,7 +7280,7 @@ export namespace books_v1 { * * @param {object} params Parameters for request * @param {string=} params.locale ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating notification title and body. - * @param {string} params.notification_id String to identify the notification. + * @param {string=} params.notification_id String to identify the notification. * @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. @@ -7223,7 +7350,7 @@ export namespace books_v1 { options ), params, - requiredParams: ['notification_id'], + requiredParams: [], pathParams: [], context: this.context, }; @@ -7306,7 +7433,7 @@ export namespace books_v1 { * @alias books.onboarding.listCategories * @memberOf! () * - * @param {object=} params Parameters for request + * @param {object} params Parameters for request * @param {string=} params.locale ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -7422,7 +7549,8 @@ export namespace books_v1 { * categoryId: 'placeholder-value', * // ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset. * locale: 'placeholder-value', - * // The maximum allowed maturity rating of returned volumes. Books with a higher maturity rating are filtered out. + * // The maximum allowed maturity rating of returned volumes. Books with a + * // higher maturity rating are filtered out. * maxAllowedMaturityRating: 'placeholder-value', * // Number of maximum results per page to be included in the response. * pageSize: 'placeholder-value', @@ -7447,7 +7575,7 @@ export namespace books_v1 { * @alias books.onboarding.listCategoryVolumes * @memberOf! () * - * @param {object=} params Parameters for request + * @param {object} params Parameters for request * @param {string=} params.categoryId List of category ids requested. * @param {string=} params.locale ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset. * @param {string=} params.maxAllowedMaturityRating The maximum allowed maturity rating of returned volumes. Books with a higher maturity rating are filtered out. @@ -7601,9 +7729,11 @@ export namespace books_v1 { * * // Do the magic * const res = await books.personalizedstream.get({ - * // ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations. + * // ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for + * // generating recommendations. * locale: 'placeholder-value', - * // The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out. + * // The maximum allowed maturity rating of returned recommendations. Books with + * // a higher maturity rating are filtered out. * maxAllowedMaturityRating: 'placeholder-value', * // String to identify the originator of this request. * source: 'placeholder-value', @@ -7626,7 +7756,7 @@ export namespace books_v1 { * @alias books.personalizedstream.get * @memberOf! () * - * @param {object=} params Parameters for request + * @param {object} params Parameters for request * @param {string=} params.locale ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations. * @param {string=} params.maxAllowedMaturityRating The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out. * @param {string=} params.source String to identify the originator of this request. @@ -7741,6 +7871,7 @@ export namespace books_v1 { /** * books.promooffer.accept + * @desc Accepts the promo offer. * @example * // Before running the sample: * // - Enable the API at: @@ -7783,6 +7914,9 @@ export namespace books_v1 { * volumeId: 'placeholder-value', * }); * console.log(res.data); + * + * // Example response + * // {} * } * * main().catch(e => { @@ -7793,7 +7927,7 @@ export namespace books_v1 { * @alias books.promooffer.accept * @memberOf! () * - * @param {object=} params Parameters for request + * @param {object} params Parameters for request * @param {string=} params.androidId device android_id * @param {string=} params.device device device * @param {string=} params.manufacturer device manufacturer @@ -7813,7 +7947,7 @@ export namespace books_v1 { accept( params?: Params$Resource$Promooffer$Accept, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; accept( params: Params$Resource$Promooffer$Accept, options: StreamMethodOptions | BodyResponseCallback, @@ -7821,26 +7955,28 @@ export namespace books_v1 { ): void; accept( params: Params$Resource$Promooffer$Accept, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; accept( params: Params$Resource$Promooffer$Accept, - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; - accept(callback: BodyResponseCallback): void; + accept(callback: BodyResponseCallback): void; accept( paramsOrCallback?: | Params$Resource$Promooffer$Accept - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, - callback?: BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || {}) as Params$Resource$Promooffer$Accept; let options = (optionsOrCallback || {}) as MethodOptions; @@ -7874,17 +8010,18 @@ export namespace books_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** * books.promooffer.dismiss + * @desc Marks the promo offer as dismissed. * @example * // Before running the sample: * // - Enable the API at: @@ -7925,6 +8062,9 @@ export namespace books_v1 { * serial: 'placeholder-value', * }); * console.log(res.data); + * + * // Example response + * // {} * } * * main().catch(e => { @@ -7935,7 +8075,7 @@ export namespace books_v1 { * @alias books.promooffer.dismiss * @memberOf! () * - * @param {object=} params Parameters for request + * @param {object} params Parameters for request * @param {string=} params.androidId device android_id * @param {string=} params.device device device * @param {string=} params.manufacturer device manufacturer @@ -7954,7 +8094,7 @@ export namespace books_v1 { dismiss( params?: Params$Resource$Promooffer$Dismiss, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; dismiss( params: Params$Resource$Promooffer$Dismiss, options: StreamMethodOptions | BodyResponseCallback, @@ -7962,26 +8102,28 @@ export namespace books_v1 { ): void; dismiss( params: Params$Resource$Promooffer$Dismiss, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; dismiss( params: Params$Resource$Promooffer$Dismiss, - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; - dismiss(callback: BodyResponseCallback): void; + dismiss(callback: BodyResponseCallback): void; dismiss( paramsOrCallback?: | Params$Resource$Promooffer$Dismiss - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, - callback?: BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || {}) as Params$Resource$Promooffer$Dismiss; let options = (optionsOrCallback || {}) as MethodOptions; @@ -8015,12 +8157,12 @@ export namespace books_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback<{} | void> ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } @@ -8081,7 +8223,7 @@ export namespace books_v1 { * @alias books.promooffer.get * @memberOf! () * - * @param {object=} params Parameters for request + * @param {object} params Parameters for request * @param {string=} params.androidId device android_id * @param {string=} params.device device device * @param {string=} params.manufacturer device manufacturer @@ -8320,7 +8462,7 @@ export namespace books_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.series_id String that identifies the series + * @param {string=} params.series_id String that identifies the series * @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 @@ -8389,7 +8531,7 @@ export namespace books_v1 { options ), params, - requiredParams: ['series_id'], + requiredParams: [], pathParams: [], context: this.context, }; @@ -8472,7 +8614,7 @@ export namespace books_v1 { * @param {object} params Parameters for request * @param {integer=} params.page_size Number of maximum results per page to be included in the response. * @param {string=} params.page_token The value of the nextToken from the previous page. - * @param {string} params.series_id String that identifies the series + * @param {string=} params.series_id String that identifies the series * @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 @@ -8542,7 +8684,7 @@ export namespace books_v1 { options ), params, - requiredParams: ['series_id'], + requiredParams: [], pathParams: [], context: this.context, }; @@ -8622,7 +8764,7 @@ export namespace books_v1 { * partner: 'placeholder-value', * // Restrict information returned to a set of selected fields. * projection: 'placeholder-value', - * // String to identify the originator of this request. + * // string to identify the originator of this request. * source: 'placeholder-value', * * user_library_consistent_read: 'placeholder-value', @@ -8660,7 +8802,7 @@ export namespace books_v1 { * @param {boolean=} params.includeNonComicsSeries Set to true to include non-comics series. Defaults to false. * @param {string=} params.partner Brand results for partner ID. * @param {string=} params.projection Restrict information returned to a set of selected fields. - * @param {string=} params.source String to identify the originator of this request. + * @param {string=} params.source string to identify the originator of this request. * @param {boolean=} params.user_library_consistent_read * @param {string} params.volumeId ID of volume to retrieve. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8780,7 +8922,8 @@ export namespace books_v1 { * langRestrict: 'placeholder-value', * // Restrict search to this user's library. * libraryRestrict: 'placeholder-value', - * // The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out. + * // The maximum allowed maturity rating of returned recommendations. Books with + * // a higher maturity rating are filtered out. * maxAllowedMaturityRating: 'placeholder-value', * // Maximum number of results to return. * maxResults: 'placeholder-value', @@ -8830,7 +8973,7 @@ export namespace books_v1 { * @param {string=} params.partner Restrict and brand results for partner ID. * @param {string=} params.printType Restrict to books or magazines. * @param {string=} params.projection Restrict information returned to a set of selected fields. - * @param {string} params.q Full-text search query string. + * @param {string=} params.q Full-text search query string. * @param {boolean=} params.showPreorders Set to true to show books available for preorder. Defaults to false. * @param {string=} params.source String to identify the originator of this request. * @param {integer=} params.startIndex Index of the first result to return (starts at 0) @@ -8899,7 +9042,7 @@ export namespace books_v1 { options ), params, - requiredParams: ['q'], + requiredParams: [], pathParams: [], context: this.context, }; @@ -8932,7 +9075,7 @@ export namespace books_v1 { */ projection?: string; /** - * String to identify the originator of this request. + * string to identify the originator of this request. */ source?: string; /** @@ -9038,9 +9181,11 @@ export namespace books_v1 { * const res = await books.volumes.associated.list({ * // Association type. * association: 'placeholder-value', - * // ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations. + * // ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for + * // generating recommendations. * locale: 'placeholder-value', - * // The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out. + * // The maximum allowed maturity rating of returned recommendations. Books with + * // a higher maturity rating are filtered out. * maxAllowedMaturityRating: 'placeholder-value', * // String to identify the originator of this request. * source: 'placeholder-value', @@ -9216,11 +9361,13 @@ export namespace books_v1 { * acquireMethod: 'placeholder-value', * // ISO-3166-1 code to override the IP-based location. * country: 'placeholder-value', - * // ISO-639-1 language and ISO-3166-1 country code. Ex:'en_US'. Used for generating recommendations. + * // ISO-639-1 language and ISO-3166-1 country code. Ex:'en_US'. Used for + * // generating recommendations. * locale: 'placeholder-value', * // Maximum number of results to return. * maxResults: 'placeholder-value', - * // The processing state of the user uploaded volumes to be returned. Applicable only if the UPLOADED is specified in the acquireMethod. + * // The processing state of the user uploaded volumes to be returned. + * // Applicable only if the UPLOADED is specified in the acquireMethod. * processingState: 'placeholder-value', * // String to identify the originator of this request. * source: 'placeholder-value', @@ -9245,7 +9392,7 @@ export namespace books_v1 { * @alias books.volumes.mybooks.list * @memberOf! () * - * @param {object=} params Parameters for request + * @param {object} params Parameters for request * @param {string=} params.acquireMethod How the book was acquired * @param {string=} params.country ISO-3166-1 code to override the IP-based location. * @param {string=} params.locale ISO-639-1 language and ISO-3166-1 country code. Ex:'en_US'. Used for generating recommendations. @@ -9402,9 +9549,11 @@ export namespace books_v1 { * * // Do the magic * const res = await books.volumes.recommended.list({ - * // ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations. + * // ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for + * // generating recommendations. * locale: 'placeholder-value', - * // The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out. + * // The maximum allowed maturity rating of returned recommendations. Books with + * // a higher maturity rating are filtered out. * maxAllowedMaturityRating: 'placeholder-value', * // String to identify the originator of this request. * source: 'placeholder-value', @@ -9427,7 +9576,7 @@ export namespace books_v1 { * @alias books.volumes.recommended.list * @memberOf! () * - * @param {object=} params Parameters for request + * @param {object} params Parameters for request * @param {string=} params.locale ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations. * @param {string=} params.maxAllowedMaturityRating The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out. * @param {string=} params.source String to identify the originator of this request. @@ -9541,7 +9690,8 @@ export namespace books_v1 { * * // Do the magic * const res = await books.volumes.recommended.rate({ - * // ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations. + * // ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for + * // generating recommendations. * locale: 'placeholder-value', * // Rating to be given to the volume. * rating: 'placeholder-value', @@ -9568,9 +9718,9 @@ export namespace books_v1 { * * @param {object} params Parameters for request * @param {string=} params.locale ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations. - * @param {string} params.rating Rating to be given to the volume. + * @param {string=} params.rating Rating to be given to the volume. * @param {string=} params.source String to identify the originator of this request. - * @param {string} params.volumeId ID of the source volume. + * @param {string=} params.volumeId ID of the source volume. * @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 @@ -9647,7 +9797,7 @@ export namespace books_v1 { options ), params, - requiredParams: ['rating', 'volumeId'], + requiredParams: [], pathParams: [], context: this.context, }; @@ -9732,7 +9882,8 @@ export namespace books_v1 { * * // Do the magic * const res = await books.volumes.useruploaded.list({ - * // ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations. + * // ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for + * // generating recommendations. * locale: 'placeholder-value', * // Maximum number of results to return. * maxResults: 'placeholder-value', @@ -9742,7 +9893,8 @@ export namespace books_v1 { * source: 'placeholder-value', * // Index of the first result to return (starts at 0) * startIndex: 'placeholder-value', - * // The ids of the volumes to be returned. If not specified all that match the processingState are returned. + * // The ids of the volumes to be returned. If not specified all that match the + * // processingState are returned. * volumeId: 'placeholder-value', * }); * console.log(res.data); @@ -9763,7 +9915,7 @@ export namespace books_v1 { * @alias books.volumes.useruploaded.list * @memberOf! () * - * @param {object=} params Parameters for request + * @param {object} params Parameters for request * @param {string=} params.locale ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations. * @param {integer=} params.maxResults Maximum number of results to return. * @param {string=} params.processingState The processing state of the user uploaded volumes to be returned.