@utdk/google 0.0.1-20260407.8-dev.646adf4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +373 -0
- package/books/README.md +3 -0
- package/books/index.ts +22 -0
- package/books/metadata.ts +1681 -0
- package/books/openapi.json +8073 -0
- package/books/package.json +41 -0
- package/books/types.ts +308 -0
- package/drive/README.md +3 -0
- package/drive/index.ts +22 -0
- package/drive/metadata.ts +1962 -0
- package/drive/openapi.json +7902 -0
- package/drive/types.ts +302 -0
- package/fcm/README.md +3 -0
- package/fcm/index.ts +22 -0
- package/fcm/metadata.ts +36 -0
- package/fcm/openapi.json +678 -0
- package/fcm/types.ts +8 -0
- package/home/README.md +3 -0
- package/home/index.ts +22 -0
- package/home/metadata.ts +512 -0
- package/home/openapi.json +5429 -0
- package/home/types.ts +182 -0
- package/index.ts +14 -0
- package/package.json +35 -0
- package/youtube/README.md +3 -0
- package/youtube/index.ts +22 -0
- package/youtube/metadata.ts +2716 -0
- package/youtube/openapi.json +15600 -0
- package/youtube/types.ts +482 -0
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
{
|
|
2
|
+
"private": true,
|
|
3
|
+
"version": "1.0.0-20260407.1-dev.646adf4",
|
|
4
|
+
"type": "module",
|
|
5
|
+
"description": "Generated UTDK provider client for Books API. The Google Books API allows clients to access the Google Books repository.",
|
|
6
|
+
"homepage": "https://code.google.com/apis/books/docs/v1/getting_started.html",
|
|
7
|
+
"keywords": [
|
|
8
|
+
"google/books",
|
|
9
|
+
"generated",
|
|
10
|
+
"openapi",
|
|
11
|
+
"utdk"
|
|
12
|
+
],
|
|
13
|
+
"license": "Creative Commons Attribution 3.0",
|
|
14
|
+
"utdk": {
|
|
15
|
+
"provider": "google/books",
|
|
16
|
+
"generation": 1,
|
|
17
|
+
"generatedAt": "2026-04-07T02:25:39.564Z",
|
|
18
|
+
"auth": [
|
|
19
|
+
{
|
|
20
|
+
"auth_type": "oauth2",
|
|
21
|
+
"flow": "implicit",
|
|
22
|
+
"client_id": "${CLIENT_ID}",
|
|
23
|
+
"authorization_url": "https://accounts.google.com/o/oauth2/auth"
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
"auth_type": "oauth2",
|
|
27
|
+
"flow": "authorization_code",
|
|
28
|
+
"client_id": "${CLIENT_ID}",
|
|
29
|
+
"client_secret": "${CLIENT_SECRET}",
|
|
30
|
+
"authorization_url": "https://accounts.google.com/o/oauth2/auth",
|
|
31
|
+
"token_url": "https://accounts.google.com/o/oauth2/token"
|
|
32
|
+
}
|
|
33
|
+
],
|
|
34
|
+
"openapi": {
|
|
35
|
+
"title": "Books API",
|
|
36
|
+
"url": "https://raw.githubusercontent.com/APIs-guru/openapi-directory/refs/heads/main/APIs/googleapis.com/books/v1/openapi.yaml",
|
|
37
|
+
"version": "v1",
|
|
38
|
+
"termsOfService": "https://developers.google.com/terms/"
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
}
|
package/books/types.ts
ADDED
|
@@ -0,0 +1,308 @@
|
|
|
1
|
+
export type GoogleBooksClient = {
|
|
2
|
+
/**
|
|
3
|
+
* Retrieves metadata for a specific bookshelf for the specified user.
|
|
4
|
+
* Tags: bookshelves
|
|
5
|
+
* Access as: google/books.bookshelvesGet(input)
|
|
6
|
+
*/
|
|
7
|
+
bookshelvesGet: (input: { userId: string; shelf: string; "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; source?: string }) => Promise<{ access?: string; created?: string; description?: string; id?: number; kind?: string; selfLink?: string; title?: string; updated?: string; volumeCount?: number; volumesLastUpdated?: string }>;
|
|
8
|
+
/**
|
|
9
|
+
* Retrieves a list of public bookshelves for the specified user.
|
|
10
|
+
* Tags: bookshelves
|
|
11
|
+
* Access as: google/books.bookshelvesList(input)
|
|
12
|
+
*/
|
|
13
|
+
bookshelvesList: (input: { userId: string; "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; source?: string }) => Promise<{ items?: ({ access?: string; created?: string; description?: string; id?: number; kind?: string; selfLink?: string; title?: string; updated?: string; volumeCount?: number; volumesLastUpdated?: string })[]; kind?: string }>;
|
|
14
|
+
/**
|
|
15
|
+
* Retrieves volumes in a specific bookshelf for the specified user.
|
|
16
|
+
* Tags: bookshelves
|
|
17
|
+
* Access as: google/books.bookshelvesVolumesList(input)
|
|
18
|
+
*/
|
|
19
|
+
bookshelvesVolumesList: (input: { userId: string; shelf: string; "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; maxResults?: number; showPreorders?: boolean; source?: string; startIndex?: number }) => Promise<{ items?: ({ accessInfo?: { accessViewStatus?: string; country?: string; downloadAccess?: { deviceAllowed?: boolean; downloadsAcquired?: number; justAcquired?: boolean; kind?: string; maxDownloadDevices?: number; message?: string; nonce?: string; reasonCode?: string; restricted?: boolean; signature?: string; source?: string; volumeId?: string }; driveImportedContentLink?: string; embeddable?: boolean; epub?: { acsTokenLink?: string; downloadLink?: string; isAvailable?: boolean }; explicitOfflineLicenseManagement?: boolean; pdf?: { acsTokenLink?: string; downloadLink?: string; isAvailable?: boolean }; publicDomain?: boolean; quoteSharingAllowed?: boolean; textToSpeechPermission?: string; viewOrderUrl?: string; viewability?: string; webReaderLink?: string }; etag?: string; id?: string; kind?: string; layerInfo?: { layers?: ({ layerId?: string; volumeAnnotationsVersion?: string })[] }; recommendedInfo?: { explanation?: string }; saleInfo?: { buyLink?: string; country?: string; isEbook?: boolean; listPrice?: { amount?: number; currencyCode?: string }; offers?: ({ finskyOfferType?: number; giftable?: boolean; listPrice?: { amountInMicros?: number; currencyCode?: string }; rentalDuration?: { count?: number; unit?: string }; retailPrice?: { amountInMicros?: number; currencyCode?: string } })[]; onSaleDate?: string; retailPrice?: { amount?: number; currencyCode?: string }; saleability?: string }; searchInfo?: { textSnippet?: string }; selfLink?: string; userInfo?: { acquiredTime?: string; acquisitionType?: number; copy?: { allowedCharacterCount?: number; limitType?: string; remainingCharacterCount?: number; updated?: string }; entitlementType?: number; familySharing?: { familyRole?: string; isSharingAllowed?: boolean; isSharingDisabledByFop?: boolean }; isFamilySharedFromUser?: boolean; isFamilySharedToUser?: boolean; isFamilySharingAllowed?: boolean; isFamilySharingDisabledByFop?: boolean; isInMyBooks?: boolean; isPreordered?: boolean; isPurchased?: boolean; isUploaded?: boolean; readingPosition?: { epubCfiPosition?: string; gbImagePosition?: string; gbTextPosition?: string; kind?: string; pdfPosition?: string; updated?: string; volumeId?: string }; rentalPeriod?: { endUtcSec?: string; startUtcSec?: string }; rentalState?: string; review?: { author?: { displayName?: string }; content?: string; date?: string; fullTextUrl?: string; kind?: string; rating?: string; source?: { description?: string; extraDescription?: string; url?: string }; title?: string; type?: string; volumeId?: string }; updated?: string; userUploadedVolumeInfo?: { processingState?: string } }; volumeInfo?: { allowAnonLogging?: boolean; authors?: (string)[]; averageRating?: number; canonicalVolumeLink?: string; categories?: (string)[]; comicsContent?: boolean; contentVersion?: string; description?: string; dimensions?: { height?: string; thickness?: string; width?: string }; imageLinks?: { extraLarge?: string; large?: string; medium?: string; small?: string; smallThumbnail?: string; thumbnail?: string }; industryIdentifiers?: ({ identifier?: string; type?: string })[]; infoLink?: string; language?: string; mainCategory?: string; maturityRating?: string; pageCount?: number; panelizationSummary?: { containsEpubBubbles?: boolean; containsImageBubbles?: boolean; epubBubbleVersion?: string; imageBubbleVersion?: string }; previewLink?: string; printType?: string; printedPageCount?: number; publishedDate?: string; publisher?: string; ratingsCount?: number; readingModes?: { image?: boolean; text?: boolean }; samplePageCount?: number; seriesInfo?: { bookDisplayNumber?: string; kind?: string; shortSeriesBookTitle?: string; volumeSeries?: ({ issue?: ({ issueDisplayNumber?: string; issueOrderNumber?: number })[]; orderNumber?: number; seriesBookType?: string; seriesId?: string })[] }; subtitle?: string; title?: string } })[]; kind?: string; totalItems?: number }>;
|
|
20
|
+
/**
|
|
21
|
+
* Add a user-upload volume and triggers processing.
|
|
22
|
+
* Tags: cloudloading
|
|
23
|
+
* Access as: google/books.cloudloadingAddBook(input)
|
|
24
|
+
*/
|
|
25
|
+
cloudloadingAddBook: (input: { "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; drive_document_id?: string; mime_type?: string; name?: string; upload_client_token?: string }) => Promise<{ author?: string; processingState?: string; title?: string; volumeId?: string }>;
|
|
26
|
+
/**
|
|
27
|
+
* Remove the book and its contents
|
|
28
|
+
* Tags: cloudloading
|
|
29
|
+
* Access as: google/books.cloudloadingDeleteBook(input)
|
|
30
|
+
*/
|
|
31
|
+
cloudloadingDeleteBook: (input: { "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; volumeId: string }) => Promise<{ [key: string]: unknown }>;
|
|
32
|
+
/**
|
|
33
|
+
* Updates a user-upload volume.
|
|
34
|
+
* Tags: cloudloading
|
|
35
|
+
* Access as: google/books.cloudloadingUpdateBook(input)
|
|
36
|
+
*/
|
|
37
|
+
cloudloadingUpdateBook: (input: { author?: string; processingState?: string; title?: string; volumeId?: string; "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string }) => Promise<{ author?: string; processingState?: string; title?: string; volumeId?: string }>;
|
|
38
|
+
/**
|
|
39
|
+
* Returns a list of offline dictionary metadata available
|
|
40
|
+
* Tags: dictionary
|
|
41
|
+
* Access as: google/books.dictionaryListOfflineMetadata(input)
|
|
42
|
+
*/
|
|
43
|
+
dictionaryListOfflineMetadata: (input: { "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; cpksver: string }) => Promise<{ items?: ({ download_url?: string; encrypted_key?: string; language?: string; size?: string; version?: string })[]; kind?: string }>;
|
|
44
|
+
/**
|
|
45
|
+
* Gets information regarding the family that the user is part of.
|
|
46
|
+
* Tags: familysharing
|
|
47
|
+
* Access as: google/books.familysharingGetFamilyInfo(input)
|
|
48
|
+
*/
|
|
49
|
+
familysharingGetFamilyInfo: (input: { "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; source?: string }) => Promise<{ kind?: string; membership?: { acquirePermission?: string; ageGroup?: string; allowedMaturityRating?: string; isInFamily?: boolean; role?: string } }>;
|
|
50
|
+
/**
|
|
51
|
+
* Initiates sharing of the content with the user's family. Empty response indicates success.
|
|
52
|
+
* Tags: familysharing
|
|
53
|
+
* Access as: google/books.familysharingShare(input)
|
|
54
|
+
*/
|
|
55
|
+
familysharingShare: (input: { "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; docId?: string; source?: string; volumeId?: string }) => Promise<{ [key: string]: unknown }>;
|
|
56
|
+
/**
|
|
57
|
+
* Initiates revoking content that has already been shared with the user's family. Empty response indicates success.
|
|
58
|
+
* Tags: familysharing
|
|
59
|
+
* Access as: google/books.familysharingUnshare(input)
|
|
60
|
+
*/
|
|
61
|
+
familysharingUnshare: (input: { "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; docId?: string; source?: string; volumeId?: string }) => Promise<{ [key: string]: unknown }>;
|
|
62
|
+
/**
|
|
63
|
+
* Gets the annotation data.
|
|
64
|
+
* Tags: layers
|
|
65
|
+
* Access as: google/books.layersAnnotationDataGet(input)
|
|
66
|
+
*/
|
|
67
|
+
layersAnnotationDataGet: (input: { volumeId: string; layerId: string; annotationDataId: string; "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; contentVersion: string; allowWebDefinitions?: boolean; h?: number; locale?: string; scale?: number; source?: string; w?: number }) => Promise<{ annotationType?: string; data?: { common?: { title?: string }; dict?: { source?: { attribution?: string; url?: string }; words?: ({ derivatives?: ({ source?: { attribution?: string; url?: string }; text?: string })[]; examples?: ({ source?: { attribution?: string; url?: string }; text?: string })[]; senses?: ({ conjugations?: ({ type?: string; value?: string })[]; definitions?: ({ definition?: string; examples?: ({ source?: { attribution?: string; url?: string }; text?: string })[] })[]; partOfSpeech?: string; pronunciation?: string; pronunciationUrl?: string; source?: { attribution?: string; url?: string }; syllabification?: string; synonyms?: ({ source?: { attribution?: string; url?: string }; text?: string })[] })[]; source?: { attribution?: string; url?: string } })[] }; kind?: string }; encodedData?: string; id?: string; kind?: string; layerId?: string; selfLink?: string; updated?: string; volumeId?: string }>;
|
|
68
|
+
/**
|
|
69
|
+
* Gets the annotation data for a volume and layer.
|
|
70
|
+
* Tags: layers
|
|
71
|
+
* Access as: google/books.layersAnnotationDataList(input)
|
|
72
|
+
*/
|
|
73
|
+
layersAnnotationDataList: (input: { volumeId: string; layerId: string; "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; contentVersion: string; annotationDataId?: (string)[]; h?: number; locale?: string; maxResults?: number; pageToken?: string; scale?: number; source?: string; updatedMax?: string; updatedMin?: string; w?: number }) => Promise<{ items?: ({ annotationType?: string; data?: { common?: { lang?: string; previewImageUrl?: string; snippet?: string; snippetUrl?: string; title?: string }; geo?: { boundary?: (string)[]; cachePolicy?: string; countryCode?: string; latitude?: number; longitude?: number; mapType?: string; viewport?: { hi?: { latitude?: number; longitude?: number }; lo?: { latitude?: number; longitude?: number } }; zoom?: number }; kind?: string }; encodedData?: string; id?: string; kind?: string; layerId?: string; selfLink?: string; updated?: string; volumeId?: string })[]; kind?: string; nextPageToken?: string; totalItems?: number }>;
|
|
74
|
+
/**
|
|
75
|
+
* Gets the layer summary for a volume.
|
|
76
|
+
* Tags: layers
|
|
77
|
+
* Access as: google/books.layersGet(input)
|
|
78
|
+
*/
|
|
79
|
+
layersGet: (input: { volumeId: string; summaryId: string; "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; contentVersion?: string; source?: string }) => Promise<{ annotationCount?: number; annotationTypes?: (string)[]; annotationsDataLink?: string; annotationsLink?: string; contentVersion?: string; dataCount?: number; id?: string; kind?: string; layerId?: string; selfLink?: string; updated?: string; volumeAnnotationsVersion?: string; volumeId?: string }>;
|
|
80
|
+
/**
|
|
81
|
+
* List the layer summaries for a volume.
|
|
82
|
+
* Tags: layers
|
|
83
|
+
* Access as: google/books.layersList(input)
|
|
84
|
+
*/
|
|
85
|
+
layersList: (input: { volumeId: string; "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; contentVersion?: string; maxResults?: number; pageToken?: string; source?: string }) => Promise<{ items?: ({ annotationCount?: number; annotationTypes?: (string)[]; annotationsDataLink?: string; annotationsLink?: string; contentVersion?: string; dataCount?: number; id?: string; kind?: string; layerId?: string; selfLink?: string; updated?: string; volumeAnnotationsVersion?: string; volumeId?: string })[]; kind?: string; totalItems?: number }>;
|
|
86
|
+
/**
|
|
87
|
+
* Gets the volume annotation.
|
|
88
|
+
* Tags: layers
|
|
89
|
+
* Access as: google/books.layersVolumeAnnotationsGet(input)
|
|
90
|
+
*/
|
|
91
|
+
layersVolumeAnnotationsGet: (input: { volumeId: string; layerId: string; annotationId: string; "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; locale?: string; source?: string }) => Promise<{ annotationDataId?: string; annotationDataLink?: string; annotationType?: string; contentRanges?: { cfiRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; contentVersion?: string; gbImageRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; gbTextRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string } }; data?: string; deleted?: boolean; id?: string; kind?: string; layerId?: string; pageIds?: (string)[]; selectedText?: string; selfLink?: string; updated?: string; volumeId?: string }>;
|
|
92
|
+
/**
|
|
93
|
+
* Gets the volume annotations for a volume and layer.
|
|
94
|
+
* Tags: layers
|
|
95
|
+
* Access as: google/books.layersVolumeAnnotationsList(input)
|
|
96
|
+
*/
|
|
97
|
+
layersVolumeAnnotationsList: (input: { volumeId: string; layerId: string; "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; contentVersion: string; endOffset?: string; endPosition?: string; locale?: string; maxResults?: number; pageToken?: string; showDeleted?: boolean; source?: string; startOffset?: string; startPosition?: string; updatedMax?: string; updatedMin?: string; volumeAnnotationsVersion?: string }) => Promise<{ items?: ({ annotationDataId?: string; annotationDataLink?: string; annotationType?: string; contentRanges?: { cfiRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; contentVersion?: string; gbImageRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; gbTextRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string } }; data?: string; deleted?: boolean; id?: string; kind?: string; layerId?: string; pageIds?: (string)[]; selectedText?: string; selfLink?: string; updated?: string; volumeId?: string })[]; kind?: string; nextPageToken?: string; totalItems?: number; version?: string }>;
|
|
98
|
+
/**
|
|
99
|
+
* Gets the current settings for the user.
|
|
100
|
+
* Tags: myconfig
|
|
101
|
+
* Access as: google/books.myconfigGetUserSettings(input)
|
|
102
|
+
*/
|
|
103
|
+
myconfigGetUserSettings: (input: { "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; country?: string }) => Promise<{ kind?: string; notesExport?: { folderName?: string; isEnabled?: boolean }; notification?: { matchMyInterests?: { opted_state?: string }; moreFromAuthors?: { opted_state?: string }; moreFromSeries?: { opted_state?: string }; priceDrop?: { opted_state?: string }; rewardExpirations?: { opted_state?: string } } }>;
|
|
104
|
+
/**
|
|
105
|
+
* Release downloaded content access restriction.
|
|
106
|
+
* Tags: myconfig
|
|
107
|
+
* Access as: google/books.myconfigReleaseDownloadAccess(input)
|
|
108
|
+
*/
|
|
109
|
+
myconfigReleaseDownloadAccess: (input: { "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; cpksver: string; volumeIds: (string)[]; locale?: string; source?: string }) => Promise<{ downloadAccessList?: ({ deviceAllowed?: boolean; downloadsAcquired?: number; justAcquired?: boolean; kind?: string; maxDownloadDevices?: number; message?: string; nonce?: string; reasonCode?: string; restricted?: boolean; signature?: string; source?: string; volumeId?: string })[]; kind?: string }>;
|
|
110
|
+
/**
|
|
111
|
+
* Request concurrent and download access restrictions.
|
|
112
|
+
* Tags: myconfig
|
|
113
|
+
* Access as: google/books.myconfigRequestAccess(input)
|
|
114
|
+
*/
|
|
115
|
+
myconfigRequestAccess: (input: { "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; cpksver: string; nonce: string; source: string; volumeId: string; licenseTypes?: "LICENSE_TYPES_UNDEFINED" | "BOTH" | "CONCURRENT" | "DOWNLOAD"; locale?: string }) => Promise<{ concurrentAccess?: { deviceAllowed?: boolean; kind?: string; maxConcurrentDevices?: number; message?: string; nonce?: string; reasonCode?: string; restricted?: boolean; signature?: string; source?: string; timeWindowSeconds?: number; volumeId?: string }; downloadAccess?: { deviceAllowed?: boolean; downloadsAcquired?: number; justAcquired?: boolean; kind?: string; maxDownloadDevices?: number; message?: string; nonce?: string; reasonCode?: string; restricted?: boolean; signature?: string; source?: string; volumeId?: string }; kind?: string }>;
|
|
116
|
+
/**
|
|
117
|
+
* Request downloaded content access for specified volumes on the My eBooks shelf.
|
|
118
|
+
* Tags: myconfig
|
|
119
|
+
* Access as: google/books.myconfigSyncVolumeLicenses(input)
|
|
120
|
+
*/
|
|
121
|
+
myconfigSyncVolumeLicenses: (input: { "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; cpksver: string; nonce: string; source: string; features?: ("FEATURES_UNDEFINED" | "RENTALS")[]; includeNonComicsSeries?: boolean; locale?: string; showPreorders?: boolean; volumeIds?: (string)[] }) => Promise<{ items?: ({ accessInfo?: { accessViewStatus?: string; country?: string; downloadAccess?: { deviceAllowed?: boolean; downloadsAcquired?: number; justAcquired?: boolean; kind?: string; maxDownloadDevices?: number; message?: string; nonce?: string; reasonCode?: string; restricted?: boolean; signature?: string; source?: string; volumeId?: string }; driveImportedContentLink?: string; embeddable?: boolean; epub?: { acsTokenLink?: string; downloadLink?: string; isAvailable?: boolean }; explicitOfflineLicenseManagement?: boolean; pdf?: { acsTokenLink?: string; downloadLink?: string; isAvailable?: boolean }; publicDomain?: boolean; quoteSharingAllowed?: boolean; textToSpeechPermission?: string; viewOrderUrl?: string; viewability?: string; webReaderLink?: string }; etag?: string; id?: string; kind?: string; layerInfo?: { layers?: ({ layerId?: string; volumeAnnotationsVersion?: string })[] }; recommendedInfo?: { explanation?: string }; saleInfo?: { buyLink?: string; country?: string; isEbook?: boolean; listPrice?: { amount?: number; currencyCode?: string }; offers?: ({ finskyOfferType?: number; giftable?: boolean; listPrice?: { amountInMicros?: number; currencyCode?: string }; rentalDuration?: { count?: number; unit?: string }; retailPrice?: { amountInMicros?: number; currencyCode?: string } })[]; onSaleDate?: string; retailPrice?: { amount?: number; currencyCode?: string }; saleability?: string }; searchInfo?: { textSnippet?: string }; selfLink?: string; userInfo?: { acquiredTime?: string; acquisitionType?: number; copy?: { allowedCharacterCount?: number; limitType?: string; remainingCharacterCount?: number; updated?: string }; entitlementType?: number; familySharing?: { familyRole?: string; isSharingAllowed?: boolean; isSharingDisabledByFop?: boolean }; isFamilySharedFromUser?: boolean; isFamilySharedToUser?: boolean; isFamilySharingAllowed?: boolean; isFamilySharingDisabledByFop?: boolean; isInMyBooks?: boolean; isPreordered?: boolean; isPurchased?: boolean; isUploaded?: boolean; readingPosition?: { epubCfiPosition?: string; gbImagePosition?: string; gbTextPosition?: string; kind?: string; pdfPosition?: string; updated?: string; volumeId?: string }; rentalPeriod?: { endUtcSec?: string; startUtcSec?: string }; rentalState?: string; review?: { author?: { displayName?: string }; content?: string; date?: string; fullTextUrl?: string; kind?: string; rating?: string; source?: { description?: string; extraDescription?: string; url?: string }; title?: string; type?: string; volumeId?: string }; updated?: string; userUploadedVolumeInfo?: { processingState?: string } }; volumeInfo?: { allowAnonLogging?: boolean; authors?: (string)[]; averageRating?: number; canonicalVolumeLink?: string; categories?: (string)[]; comicsContent?: boolean; contentVersion?: string; description?: string; dimensions?: { height?: string; thickness?: string; width?: string }; imageLinks?: { extraLarge?: string; large?: string; medium?: string; small?: string; smallThumbnail?: string; thumbnail?: string }; industryIdentifiers?: ({ identifier?: string; type?: string })[]; infoLink?: string; language?: string; mainCategory?: string; maturityRating?: string; pageCount?: number; panelizationSummary?: { containsEpubBubbles?: boolean; containsImageBubbles?: boolean; epubBubbleVersion?: string; imageBubbleVersion?: string }; previewLink?: string; printType?: string; printedPageCount?: number; publishedDate?: string; publisher?: string; ratingsCount?: number; readingModes?: { image?: boolean; text?: boolean }; samplePageCount?: number; seriesInfo?: { bookDisplayNumber?: string; kind?: string; shortSeriesBookTitle?: string; volumeSeries?: ({ issue?: ({ issueDisplayNumber?: string; issueOrderNumber?: number })[]; orderNumber?: number; seriesBookType?: string; seriesId?: string })[] }; subtitle?: string; title?: string } })[]; kind?: string; totalItems?: number }>;
|
|
122
|
+
/**
|
|
123
|
+
* 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.
|
|
124
|
+
* Tags: myconfig
|
|
125
|
+
* Access as: google/books.myconfigUpdateUserSettings(input)
|
|
126
|
+
*/
|
|
127
|
+
myconfigUpdateUserSettings: (input: { kind?: string; notesExport?: { folderName?: string; isEnabled?: boolean }; notification?: { matchMyInterests?: { opted_state?: string }; moreFromAuthors?: { opted_state?: string }; moreFromSeries?: { opted_state?: string }; priceDrop?: { opted_state?: string }; rewardExpirations?: { opted_state?: string } }; "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string }) => Promise<{ kind?: string; notesExport?: { folderName?: string; isEnabled?: boolean }; notification?: { matchMyInterests?: { opted_state?: string }; moreFromAuthors?: { opted_state?: string }; moreFromSeries?: { opted_state?: string }; priceDrop?: { opted_state?: string }; rewardExpirations?: { opted_state?: string } } }>;
|
|
128
|
+
/**
|
|
129
|
+
* Deletes an annotation.
|
|
130
|
+
* Tags: mylibrary
|
|
131
|
+
* Access as: google/books.mylibraryAnnotationsDelete(input)
|
|
132
|
+
*/
|
|
133
|
+
mylibraryAnnotationsDelete: (input: { annotationId: string; "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; source?: string }) => Promise<{ [key: string]: unknown }>;
|
|
134
|
+
/**
|
|
135
|
+
* Inserts a new annotation.
|
|
136
|
+
* Tags: mylibrary
|
|
137
|
+
* Access as: google/books.mylibraryAnnotationsInsert(input)
|
|
138
|
+
*/
|
|
139
|
+
mylibraryAnnotationsInsert: (input: { afterSelectedText?: string; beforeSelectedText?: string; clientVersionRanges?: { cfiRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; contentVersion?: string; gbImageRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; gbTextRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; imageCfiRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string } }; created?: string; currentVersionRanges?: { cfiRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; contentVersion?: string; gbImageRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; gbTextRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; imageCfiRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string } }; data?: string; deleted?: boolean; highlightStyle?: string; id?: string; kind?: string; layerId?: string; layerSummary?: { allowedCharacterCount?: number; limitType?: string; remainingCharacterCount?: number }; pageIds?: (string)[]; selectedText?: string; selfLink?: string; updated?: string; volumeId?: string; "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; annotationId?: string; country?: string; showOnlySummaryInResponse?: boolean; source?: string }) => Promise<{ afterSelectedText?: string; beforeSelectedText?: string; clientVersionRanges?: { cfiRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; contentVersion?: string; gbImageRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; gbTextRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; imageCfiRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string } }; created?: string; currentVersionRanges?: { cfiRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; contentVersion?: string; gbImageRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; gbTextRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; imageCfiRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string } }; data?: string; deleted?: boolean; highlightStyle?: string; id?: string; kind?: string; layerId?: string; layerSummary?: { allowedCharacterCount?: number; limitType?: string; remainingCharacterCount?: number }; pageIds?: (string)[]; selectedText?: string; selfLink?: string; updated?: string; volumeId?: string }>;
|
|
140
|
+
/**
|
|
141
|
+
* Retrieves a list of annotations, possibly filtered.
|
|
142
|
+
* Tags: mylibrary
|
|
143
|
+
* Access as: google/books.mylibraryAnnotationsList(input)
|
|
144
|
+
*/
|
|
145
|
+
mylibraryAnnotationsList: (input: { "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; contentVersion?: string; layerId?: string; layerIds?: (string)[]; maxResults?: number; pageToken?: string; showDeleted?: boolean; source?: string; updatedMax?: string; updatedMin?: string; volumeId?: string }) => Promise<{ items?: ({ afterSelectedText?: string; beforeSelectedText?: string; clientVersionRanges?: { cfiRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; contentVersion?: string; gbImageRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; gbTextRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; imageCfiRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string } }; created?: string; currentVersionRanges?: { cfiRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; contentVersion?: string; gbImageRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; gbTextRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; imageCfiRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string } }; data?: string; deleted?: boolean; highlightStyle?: string; id?: string; kind?: string; layerId?: string; layerSummary?: { allowedCharacterCount?: number; limitType?: string; remainingCharacterCount?: number }; pageIds?: (string)[]; selectedText?: string; selfLink?: string; updated?: string; volumeId?: string })[]; kind?: string; nextPageToken?: string; totalItems?: number }>;
|
|
146
|
+
/**
|
|
147
|
+
* Gets the summary of specified layers.
|
|
148
|
+
* Tags: mylibrary
|
|
149
|
+
* Access as: google/books.mylibraryAnnotationsSummary(input)
|
|
150
|
+
*/
|
|
151
|
+
mylibraryAnnotationsSummary: (input: { "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; layerIds: (string)[]; volumeId: string; source?: string }) => Promise<{ kind?: string; layers?: ({ allowedCharacterCount?: number; layerId?: string; limitType?: string; remainingCharacterCount?: number; updated?: string })[] }>;
|
|
152
|
+
/**
|
|
153
|
+
* Updates an existing annotation.
|
|
154
|
+
* Tags: mylibrary
|
|
155
|
+
* Access as: google/books.mylibraryAnnotationsUpdate(input)
|
|
156
|
+
*/
|
|
157
|
+
mylibraryAnnotationsUpdate: (input: { afterSelectedText?: string; beforeSelectedText?: string; clientVersionRanges?: { cfiRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; contentVersion?: string; gbImageRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; gbTextRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; imageCfiRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string } }; created?: string; currentVersionRanges?: { cfiRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; contentVersion?: string; gbImageRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; gbTextRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; imageCfiRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string } }; data?: string; deleted?: boolean; highlightStyle?: string; id?: string; kind?: string; layerId?: string; layerSummary?: { allowedCharacterCount?: number; limitType?: string; remainingCharacterCount?: number }; pageIds?: (string)[]; selectedText?: string; selfLink?: string; updated?: string; volumeId?: string; annotationId: string; "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; source?: string }) => Promise<{ afterSelectedText?: string; beforeSelectedText?: string; clientVersionRanges?: { cfiRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; contentVersion?: string; gbImageRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; gbTextRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; imageCfiRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string } }; created?: string; currentVersionRanges?: { cfiRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; contentVersion?: string; gbImageRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; gbTextRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string }; imageCfiRange?: { endOffset?: string; endPosition?: string; startOffset?: string; startPosition?: string } }; data?: string; deleted?: boolean; highlightStyle?: string; id?: string; kind?: string; layerId?: string; layerSummary?: { allowedCharacterCount?: number; limitType?: string; remainingCharacterCount?: number }; pageIds?: (string)[]; selectedText?: string; selfLink?: string; updated?: string; volumeId?: string }>;
|
|
158
|
+
/**
|
|
159
|
+
* Adds a volume to a bookshelf.
|
|
160
|
+
* Tags: mylibrary
|
|
161
|
+
* Access as: google/books.mylibraryBookshelvesAddVolume(input)
|
|
162
|
+
*/
|
|
163
|
+
mylibraryBookshelvesAddVolume: (input: { shelf: string; "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; volumeId: string; reason?: "REASON_UNDEFINED" | "IOS_PREX" | "IOS_SEARCH" | "ONBOARDING"; source?: string }) => Promise<{ [key: string]: unknown }>;
|
|
164
|
+
/**
|
|
165
|
+
* Clears all volumes from a bookshelf.
|
|
166
|
+
* Tags: mylibrary
|
|
167
|
+
* Access as: google/books.mylibraryBookshelvesClearVolumes(input)
|
|
168
|
+
*/
|
|
169
|
+
mylibraryBookshelvesClearVolumes: (input: { shelf: string; "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; source?: string }) => Promise<{ [key: string]: unknown }>;
|
|
170
|
+
/**
|
|
171
|
+
* Retrieves metadata for a specific bookshelf belonging to the authenticated user.
|
|
172
|
+
* Tags: mylibrary
|
|
173
|
+
* Access as: google/books.mylibraryBookshelvesGet(input)
|
|
174
|
+
*/
|
|
175
|
+
mylibraryBookshelvesGet: (input: { shelf: string; "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; source?: string }) => Promise<{ access?: string; created?: string; description?: string; id?: number; kind?: string; selfLink?: string; title?: string; updated?: string; volumeCount?: number; volumesLastUpdated?: string }>;
|
|
176
|
+
/**
|
|
177
|
+
* Retrieves a list of bookshelves belonging to the authenticated user.
|
|
178
|
+
* Tags: mylibrary
|
|
179
|
+
* Access as: google/books.mylibraryBookshelvesList(input)
|
|
180
|
+
*/
|
|
181
|
+
mylibraryBookshelvesList: (input: { "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; source?: string }) => Promise<{ items?: ({ access?: string; created?: string; description?: string; id?: number; kind?: string; selfLink?: string; title?: string; updated?: string; volumeCount?: number; volumesLastUpdated?: string })[]; kind?: string }>;
|
|
182
|
+
/**
|
|
183
|
+
* Moves a volume within a bookshelf.
|
|
184
|
+
* Tags: mylibrary
|
|
185
|
+
* Access as: google/books.mylibraryBookshelvesMoveVolume(input)
|
|
186
|
+
*/
|
|
187
|
+
mylibraryBookshelvesMoveVolume: (input: { shelf: string; "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; volumeId: string; volumePosition: number; source?: string }) => Promise<{ [key: string]: unknown }>;
|
|
188
|
+
/**
|
|
189
|
+
* Removes a volume from a bookshelf.
|
|
190
|
+
* Tags: mylibrary
|
|
191
|
+
* Access as: google/books.mylibraryBookshelvesRemoveVolume(input)
|
|
192
|
+
*/
|
|
193
|
+
mylibraryBookshelvesRemoveVolume: (input: { shelf: string; "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; volumeId: string; reason?: "REASON_UNDEFINED" | "ONBOARDING"; source?: string }) => Promise<{ [key: string]: unknown }>;
|
|
194
|
+
/**
|
|
195
|
+
* Gets volume information for volumes on a bookshelf.
|
|
196
|
+
* Tags: mylibrary
|
|
197
|
+
* Access as: google/books.mylibraryBookshelvesVolumesList(input)
|
|
198
|
+
*/
|
|
199
|
+
mylibraryBookshelvesVolumesList: (input: { shelf: string; "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; country?: string; maxResults?: number; projection?: "PROJECTION_UNDEFINED" | "FULL" | "LITE"; q?: string; showPreorders?: boolean; source?: string; startIndex?: number }) => Promise<{ items?: ({ accessInfo?: { accessViewStatus?: string; country?: string; downloadAccess?: { deviceAllowed?: boolean; downloadsAcquired?: number; justAcquired?: boolean; kind?: string; maxDownloadDevices?: number; message?: string; nonce?: string; reasonCode?: string; restricted?: boolean; signature?: string; source?: string; volumeId?: string }; driveImportedContentLink?: string; embeddable?: boolean; epub?: { acsTokenLink?: string; downloadLink?: string; isAvailable?: boolean }; explicitOfflineLicenseManagement?: boolean; pdf?: { acsTokenLink?: string; downloadLink?: string; isAvailable?: boolean }; publicDomain?: boolean; quoteSharingAllowed?: boolean; textToSpeechPermission?: string; viewOrderUrl?: string; viewability?: string; webReaderLink?: string }; etag?: string; id?: string; kind?: string; layerInfo?: { layers?: ({ layerId?: string; volumeAnnotationsVersion?: string })[] }; recommendedInfo?: { explanation?: string }; saleInfo?: { buyLink?: string; country?: string; isEbook?: boolean; listPrice?: { amount?: number; currencyCode?: string }; offers?: ({ finskyOfferType?: number; giftable?: boolean; listPrice?: { amountInMicros?: number; currencyCode?: string }; rentalDuration?: { count?: number; unit?: string }; retailPrice?: { amountInMicros?: number; currencyCode?: string } })[]; onSaleDate?: string; retailPrice?: { amount?: number; currencyCode?: string }; saleability?: string }; searchInfo?: { textSnippet?: string }; selfLink?: string; userInfo?: { acquiredTime?: string; acquisitionType?: number; copy?: { allowedCharacterCount?: number; limitType?: string; remainingCharacterCount?: number; updated?: string }; entitlementType?: number; familySharing?: { familyRole?: string; isSharingAllowed?: boolean; isSharingDisabledByFop?: boolean }; isFamilySharedFromUser?: boolean; isFamilySharedToUser?: boolean; isFamilySharingAllowed?: boolean; isFamilySharingDisabledByFop?: boolean; isInMyBooks?: boolean; isPreordered?: boolean; isPurchased?: boolean; isUploaded?: boolean; readingPosition?: { epubCfiPosition?: string; gbImagePosition?: string; gbTextPosition?: string; kind?: string; pdfPosition?: string; updated?: string; volumeId?: string }; rentalPeriod?: { endUtcSec?: string; startUtcSec?: string }; rentalState?: string; review?: { author?: { displayName?: string }; content?: string; date?: string; fullTextUrl?: string; kind?: string; rating?: string; source?: { description?: string; extraDescription?: string; url?: string }; title?: string; type?: string; volumeId?: string }; updated?: string; userUploadedVolumeInfo?: { processingState?: string } }; volumeInfo?: { allowAnonLogging?: boolean; authors?: (string)[]; averageRating?: number; canonicalVolumeLink?: string; categories?: (string)[]; comicsContent?: boolean; contentVersion?: string; description?: string; dimensions?: { height?: string; thickness?: string; width?: string }; imageLinks?: { extraLarge?: string; large?: string; medium?: string; small?: string; smallThumbnail?: string; thumbnail?: string }; industryIdentifiers?: ({ identifier?: string; type?: string })[]; infoLink?: string; language?: string; mainCategory?: string; maturityRating?: string; pageCount?: number; panelizationSummary?: { containsEpubBubbles?: boolean; containsImageBubbles?: boolean; epubBubbleVersion?: string; imageBubbleVersion?: string }; previewLink?: string; printType?: string; printedPageCount?: number; publishedDate?: string; publisher?: string; ratingsCount?: number; readingModes?: { image?: boolean; text?: boolean }; samplePageCount?: number; seriesInfo?: { bookDisplayNumber?: string; kind?: string; shortSeriesBookTitle?: string; volumeSeries?: ({ issue?: ({ issueDisplayNumber?: string; issueOrderNumber?: number })[]; orderNumber?: number; seriesBookType?: string; seriesId?: string })[] }; subtitle?: string; title?: string } })[]; kind?: string; totalItems?: number }>;
|
|
200
|
+
/**
|
|
201
|
+
* Retrieves my reading position information for a volume.
|
|
202
|
+
* Tags: mylibrary
|
|
203
|
+
* Access as: google/books.mylibraryReadingpositionsGet(input)
|
|
204
|
+
*/
|
|
205
|
+
mylibraryReadingpositionsGet: (input: { volumeId: string; "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; contentVersion?: string; source?: string }) => Promise<{ epubCfiPosition?: string; gbImagePosition?: string; gbTextPosition?: string; kind?: string; pdfPosition?: string; updated?: string; volumeId?: string }>;
|
|
206
|
+
/**
|
|
207
|
+
* Sets my reading position information for a volume.
|
|
208
|
+
* Tags: mylibrary
|
|
209
|
+
* Access as: google/books.mylibraryReadingpositionsSetPosition(input)
|
|
210
|
+
*/
|
|
211
|
+
mylibraryReadingpositionsSetPosition: (input: { volumeId: string; "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; position: string; timestamp: string; action?: "ACTION_UNDEFINED" | "bookmark" | "chapter" | "next-page" | "prev-page" | "scroll" | "search"; contentVersion?: string; deviceCookie?: string; source?: string }) => Promise<{ [key: string]: unknown }>;
|
|
212
|
+
/**
|
|
213
|
+
* Returns notification details for a given notification id.
|
|
214
|
+
* Tags: notification
|
|
215
|
+
* Access as: google/books.notificationGet(input)
|
|
216
|
+
*/
|
|
217
|
+
notificationGet: (input: { "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; notification_id: string; locale?: string; source?: string }) => Promise<{ body?: string; crmExperimentIds?: (string)[]; doc_id?: string; doc_type?: string; dont_show_notification?: boolean; iconUrl?: string; is_document_mature?: boolean; kind?: string; notificationGroup?: string; notification_type?: string; pcampaign_id?: string; reason?: string; show_notification_settings_action?: boolean; targetUrl?: string; timeToExpireMs?: string; title?: string }>;
|
|
218
|
+
/**
|
|
219
|
+
* List categories for onboarding experience.
|
|
220
|
+
* Tags: onboarding
|
|
221
|
+
* Access as: google/books.onboardingListCategories(input)
|
|
222
|
+
*/
|
|
223
|
+
onboardingListCategories: (input: { "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; locale?: string }) => Promise<{ items?: ({ badgeUrl?: string; categoryId?: string; name?: string })[]; kind?: string }>;
|
|
224
|
+
/**
|
|
225
|
+
* List available volumes under categories for onboarding experience.
|
|
226
|
+
* Tags: onboarding
|
|
227
|
+
* Access as: google/books.onboardingListCategoryVolumes(input)
|
|
228
|
+
*/
|
|
229
|
+
onboardingListCategoryVolumes: (input: { "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; categoryId?: (string)[]; locale?: string; maxAllowedMaturityRating?: "MAX_ALLOWED_MATURITY_RATING_UNDEFINED" | "MATURE" | "not-mature"; pageSize?: number; pageToken?: string }) => Promise<{ items?: ({ accessInfo?: { accessViewStatus?: string; country?: string; downloadAccess?: { deviceAllowed?: boolean; downloadsAcquired?: number; justAcquired?: boolean; kind?: string; maxDownloadDevices?: number; message?: string; nonce?: string; reasonCode?: string; restricted?: boolean; signature?: string; source?: string; volumeId?: string }; driveImportedContentLink?: string; embeddable?: boolean; epub?: { acsTokenLink?: string; downloadLink?: string; isAvailable?: boolean }; explicitOfflineLicenseManagement?: boolean; pdf?: { acsTokenLink?: string; downloadLink?: string; isAvailable?: boolean }; publicDomain?: boolean; quoteSharingAllowed?: boolean; textToSpeechPermission?: string; viewOrderUrl?: string; viewability?: string; webReaderLink?: string }; etag?: string; id?: string; kind?: string; layerInfo?: { layers?: ({ layerId?: string; volumeAnnotationsVersion?: string })[] }; recommendedInfo?: { explanation?: string }; saleInfo?: { buyLink?: string; country?: string; isEbook?: boolean; listPrice?: { amount?: number; currencyCode?: string }; offers?: ({ finskyOfferType?: number; giftable?: boolean; listPrice?: { amountInMicros?: number; currencyCode?: string }; rentalDuration?: { count?: number; unit?: string }; retailPrice?: { amountInMicros?: number; currencyCode?: string } })[]; onSaleDate?: string; retailPrice?: { amount?: number; currencyCode?: string }; saleability?: string }; searchInfo?: { textSnippet?: string }; selfLink?: string; userInfo?: { acquiredTime?: string; acquisitionType?: number; copy?: { allowedCharacterCount?: number; limitType?: string; remainingCharacterCount?: number; updated?: string }; entitlementType?: number; familySharing?: { familyRole?: string; isSharingAllowed?: boolean; isSharingDisabledByFop?: boolean }; isFamilySharedFromUser?: boolean; isFamilySharedToUser?: boolean; isFamilySharingAllowed?: boolean; isFamilySharingDisabledByFop?: boolean; isInMyBooks?: boolean; isPreordered?: boolean; isPurchased?: boolean; isUploaded?: boolean; readingPosition?: { epubCfiPosition?: string; gbImagePosition?: string; gbTextPosition?: string; kind?: string; pdfPosition?: string; updated?: string; volumeId?: string }; rentalPeriod?: { endUtcSec?: string; startUtcSec?: string }; rentalState?: string; review?: { author?: { displayName?: string }; content?: string; date?: string; fullTextUrl?: string; kind?: string; rating?: string; source?: { description?: string; extraDescription?: string; url?: string }; title?: string; type?: string; volumeId?: string }; updated?: string; userUploadedVolumeInfo?: { processingState?: string } }; volumeInfo?: { allowAnonLogging?: boolean; authors?: (string)[]; averageRating?: number; canonicalVolumeLink?: string; categories?: (string)[]; comicsContent?: boolean; contentVersion?: string; description?: string; dimensions?: { height?: string; thickness?: string; width?: string }; imageLinks?: { extraLarge?: string; large?: string; medium?: string; small?: string; smallThumbnail?: string; thumbnail?: string }; industryIdentifiers?: ({ identifier?: string; type?: string })[]; infoLink?: string; language?: string; mainCategory?: string; maturityRating?: string; pageCount?: number; panelizationSummary?: { containsEpubBubbles?: boolean; containsImageBubbles?: boolean; epubBubbleVersion?: string; imageBubbleVersion?: string }; previewLink?: string; printType?: string; printedPageCount?: number; publishedDate?: string; publisher?: string; ratingsCount?: number; readingModes?: { image?: boolean; text?: boolean }; samplePageCount?: number; seriesInfo?: { bookDisplayNumber?: string; kind?: string; shortSeriesBookTitle?: string; volumeSeries?: ({ issue?: ({ issueDisplayNumber?: string; issueOrderNumber?: number })[]; orderNumber?: number; seriesBookType?: string; seriesId?: string })[] }; subtitle?: string; title?: string } })[]; kind?: string; nextPageToken?: string }>;
|
|
230
|
+
/**
|
|
231
|
+
* Returns a stream of personalized book clusters
|
|
232
|
+
* Tags: personalizedstream
|
|
233
|
+
* Access as: google/books.personalizedstreamGet(input)
|
|
234
|
+
*/
|
|
235
|
+
personalizedstreamGet: (input: { "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; locale?: string; maxAllowedMaturityRating?: "MAX_ALLOWED_MATURITY_RATING_UNDEFINED" | "MATURE" | "not-mature"; source?: string }) => Promise<{ clusters?: ({ banner_with_content_container?: { fillColorArgb?: string; imageUrl?: string; maskColorArgb?: string; moreButtonText?: string; moreButtonUrl?: string; textColorArgb?: string }; subTitle?: string; title?: string; totalVolumes?: number; uid?: string; volumes?: ({ accessInfo?: { accessViewStatus?: string; country?: string; downloadAccess?: { deviceAllowed?: boolean; downloadsAcquired?: number; justAcquired?: boolean; kind?: string; maxDownloadDevices?: number; message?: string; nonce?: string; reasonCode?: string; restricted?: boolean; signature?: string; source?: string; volumeId?: string }; driveImportedContentLink?: string; embeddable?: boolean; epub?: { acsTokenLink?: string; downloadLink?: string; isAvailable?: boolean }; explicitOfflineLicenseManagement?: boolean; pdf?: { acsTokenLink?: string; downloadLink?: string; isAvailable?: boolean }; publicDomain?: boolean; quoteSharingAllowed?: boolean; textToSpeechPermission?: string; viewOrderUrl?: string; viewability?: string; webReaderLink?: string }; etag?: string; id?: string; kind?: string; layerInfo?: { layers?: ({ layerId?: string; volumeAnnotationsVersion?: string })[] }; recommendedInfo?: { explanation?: string }; saleInfo?: { buyLink?: string; country?: string; isEbook?: boolean; listPrice?: { amount?: number; currencyCode?: string }; offers?: ({ finskyOfferType?: number; giftable?: boolean; listPrice?: { amountInMicros?: number; currencyCode?: string }; rentalDuration?: { count?: number; unit?: string }; retailPrice?: { amountInMicros?: number; currencyCode?: string } })[]; onSaleDate?: string; retailPrice?: { amount?: number; currencyCode?: string }; saleability?: string }; searchInfo?: { textSnippet?: string }; selfLink?: string; userInfo?: { acquiredTime?: string; acquisitionType?: number; copy?: { allowedCharacterCount?: number; limitType?: string; remainingCharacterCount?: number; updated?: string }; entitlementType?: number; familySharing?: { familyRole?: string; isSharingAllowed?: boolean; isSharingDisabledByFop?: boolean }; isFamilySharedFromUser?: boolean; isFamilySharedToUser?: boolean; isFamilySharingAllowed?: boolean; isFamilySharingDisabledByFop?: boolean; isInMyBooks?: boolean; isPreordered?: boolean; isPurchased?: boolean; isUploaded?: boolean; readingPosition?: { epubCfiPosition?: string; gbImagePosition?: string; gbTextPosition?: string; kind?: string; pdfPosition?: string; updated?: string; volumeId?: string }; rentalPeriod?: { endUtcSec?: string; startUtcSec?: string }; rentalState?: string; review?: { author?: { displayName?: string }; content?: string; date?: string; fullTextUrl?: string; kind?: string; rating?: string; source?: { description?: string; extraDescription?: string; url?: string }; title?: string; type?: string; volumeId?: string }; updated?: string; userUploadedVolumeInfo?: { processingState?: string } }; volumeInfo?: { allowAnonLogging?: boolean; authors?: (string)[]; averageRating?: number; canonicalVolumeLink?: string; categories?: (string)[]; comicsContent?: boolean; contentVersion?: string; description?: string; dimensions?: { height?: string; thickness?: string; width?: string }; imageLinks?: { extraLarge?: string; large?: string; medium?: string; small?: string; smallThumbnail?: string; thumbnail?: string }; industryIdentifiers?: ({ identifier?: string; type?: string })[]; infoLink?: string; language?: string; mainCategory?: string; maturityRating?: string; pageCount?: number; panelizationSummary?: { containsEpubBubbles?: boolean; containsImageBubbles?: boolean; epubBubbleVersion?: string; imageBubbleVersion?: string }; previewLink?: string; printType?: string; printedPageCount?: number; publishedDate?: string; publisher?: string; ratingsCount?: number; readingModes?: { image?: boolean; text?: boolean }; samplePageCount?: number; seriesInfo?: { bookDisplayNumber?: string; kind?: string; shortSeriesBookTitle?: string; volumeSeries?: ({ issue?: ({ issueDisplayNumber?: string; issueOrderNumber?: number })[]; orderNumber?: number; seriesBookType?: string; seriesId?: string })[] }; subtitle?: string; title?: string } })[] })[]; kind?: string; totalClusters?: number }>;
|
|
236
|
+
/**
|
|
237
|
+
* Accepts the promo offer.
|
|
238
|
+
* Tags: promooffer
|
|
239
|
+
* Access as: google/books.promoofferAccept(input)
|
|
240
|
+
*/
|
|
241
|
+
promoofferAccept: (input: { "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; androidId?: string; device?: string; manufacturer?: string; model?: string; offerId?: string; product?: string; serial?: string; volumeId?: string }) => Promise<{ [key: string]: unknown }>;
|
|
242
|
+
/**
|
|
243
|
+
* Marks the promo offer as dismissed.
|
|
244
|
+
* Tags: promooffer
|
|
245
|
+
* Access as: google/books.promoofferDismiss(input)
|
|
246
|
+
*/
|
|
247
|
+
promoofferDismiss: (input: { "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; androidId?: string; device?: string; manufacturer?: string; model?: string; offerId?: string; product?: string; serial?: string }) => Promise<{ [key: string]: unknown }>;
|
|
248
|
+
/**
|
|
249
|
+
* Returns a list of promo offers available to the user
|
|
250
|
+
* Tags: promooffer
|
|
251
|
+
* Access as: google/books.promoofferGet(input)
|
|
252
|
+
*/
|
|
253
|
+
promoofferGet: (input: { "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; androidId?: string; device?: string; manufacturer?: string; model?: string; product?: string; serial?: string }) => Promise<{ items?: ({ artUrl?: string; gservicesKey?: string; id?: string; items?: ({ author?: string; canonicalVolumeLink?: string; coverUrl?: string; description?: string; title?: string; volumeId?: string })[] })[]; kind?: string }>;
|
|
254
|
+
/**
|
|
255
|
+
* Returns Series metadata for the given series ids.
|
|
256
|
+
* Tags: series
|
|
257
|
+
* Access as: google/books.seriesGet(input)
|
|
258
|
+
*/
|
|
259
|
+
seriesGet: (input: { "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; series_id: (string)[] }) => Promise<{ kind?: string; series?: ({ bannerImageUrl?: string; eligibleForSubscription?: boolean; imageUrl?: string; isComplete?: boolean; seriesFormatType?: string; seriesId?: string; seriesSubscriptionReleaseInfo?: { cancelTime?: string; currentReleaseInfo?: { amountInMicros?: number; currencyCode?: string; releaseNumber?: string; releaseTime?: string }; nextReleaseInfo?: { amountInMicros?: number; currencyCode?: string; releaseNumber?: string; releaseTime?: string }; seriesSubscriptionType?: string }; seriesType?: string; subscriptionId?: string; title?: string })[] }>;
|
|
260
|
+
/**
|
|
261
|
+
* Returns Series membership data given the series id.
|
|
262
|
+
* Tags: series
|
|
263
|
+
* Access as: google/books.seriesMembershipGet(input)
|
|
264
|
+
*/
|
|
265
|
+
seriesMembershipGet: (input: { "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; series_id: string; page_size?: number; page_token?: string }) => Promise<{ kind?: string; member?: ({ accessInfo?: { accessViewStatus?: string; country?: string; downloadAccess?: { deviceAllowed?: boolean; downloadsAcquired?: number; justAcquired?: boolean; kind?: string; maxDownloadDevices?: number; message?: string; nonce?: string; reasonCode?: string; restricted?: boolean; signature?: string; source?: string; volumeId?: string }; driveImportedContentLink?: string; embeddable?: boolean; epub?: { acsTokenLink?: string; downloadLink?: string; isAvailable?: boolean }; explicitOfflineLicenseManagement?: boolean; pdf?: { acsTokenLink?: string; downloadLink?: string; isAvailable?: boolean }; publicDomain?: boolean; quoteSharingAllowed?: boolean; textToSpeechPermission?: string; viewOrderUrl?: string; viewability?: string; webReaderLink?: string }; etag?: string; id?: string; kind?: string; layerInfo?: { layers?: ({ layerId?: string; volumeAnnotationsVersion?: string })[] }; recommendedInfo?: { explanation?: string }; saleInfo?: { buyLink?: string; country?: string; isEbook?: boolean; listPrice?: { amount?: number; currencyCode?: string }; offers?: ({ finskyOfferType?: number; giftable?: boolean; listPrice?: { amountInMicros?: number; currencyCode?: string }; rentalDuration?: { count?: number; unit?: string }; retailPrice?: { amountInMicros?: number; currencyCode?: string } })[]; onSaleDate?: string; retailPrice?: { amount?: number; currencyCode?: string }; saleability?: string }; searchInfo?: { textSnippet?: string }; selfLink?: string; userInfo?: { acquiredTime?: string; acquisitionType?: number; copy?: { allowedCharacterCount?: number; limitType?: string; remainingCharacterCount?: number; updated?: string }; entitlementType?: number; familySharing?: { familyRole?: string; isSharingAllowed?: boolean; isSharingDisabledByFop?: boolean }; isFamilySharedFromUser?: boolean; isFamilySharedToUser?: boolean; isFamilySharingAllowed?: boolean; isFamilySharingDisabledByFop?: boolean; isInMyBooks?: boolean; isPreordered?: boolean; isPurchased?: boolean; isUploaded?: boolean; readingPosition?: { epubCfiPosition?: string; gbImagePosition?: string; gbTextPosition?: string; kind?: string; pdfPosition?: string; updated?: string; volumeId?: string }; rentalPeriod?: { endUtcSec?: string; startUtcSec?: string }; rentalState?: string; review?: { author?: { displayName?: string }; content?: string; date?: string; fullTextUrl?: string; kind?: string; rating?: string; source?: { description?: string; extraDescription?: string; url?: string }; title?: string; type?: string; volumeId?: string }; updated?: string; userUploadedVolumeInfo?: { processingState?: string } }; volumeInfo?: { allowAnonLogging?: boolean; authors?: (string)[]; averageRating?: number; canonicalVolumeLink?: string; categories?: (string)[]; comicsContent?: boolean; contentVersion?: string; description?: string; dimensions?: { height?: string; thickness?: string; width?: string }; imageLinks?: { extraLarge?: string; large?: string; medium?: string; small?: string; smallThumbnail?: string; thumbnail?: string }; industryIdentifiers?: ({ identifier?: string; type?: string })[]; infoLink?: string; language?: string; mainCategory?: string; maturityRating?: string; pageCount?: number; panelizationSummary?: { containsEpubBubbles?: boolean; containsImageBubbles?: boolean; epubBubbleVersion?: string; imageBubbleVersion?: string }; previewLink?: string; printType?: string; printedPageCount?: number; publishedDate?: string; publisher?: string; ratingsCount?: number; readingModes?: { image?: boolean; text?: boolean }; samplePageCount?: number; seriesInfo?: { bookDisplayNumber?: string; kind?: string; shortSeriesBookTitle?: string; volumeSeries?: ({ issue?: ({ issueDisplayNumber?: string; issueOrderNumber?: number })[]; orderNumber?: number; seriesBookType?: string; seriesId?: string })[] }; subtitle?: string; title?: string } })[]; nextPageToken?: string }>;
|
|
266
|
+
/**
|
|
267
|
+
* Return a list of associated books.
|
|
268
|
+
* Tags: volumes
|
|
269
|
+
* Access as: google/books.volumesAssociatedList(input)
|
|
270
|
+
*/
|
|
271
|
+
volumesAssociatedList: (input: { volumeId: string; "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; association?: "ASSOCIATION_UNDEFINED" | "end-of-sample" | "end-of-volume" | "related-for-play"; locale?: string; maxAllowedMaturityRating?: "MAX_ALLOWED_MATURITY_RATING_UNDEFINED" | "MATURE" | "not-mature"; source?: string }) => Promise<{ items?: ({ accessInfo?: { accessViewStatus?: string; country?: string; downloadAccess?: { deviceAllowed?: boolean; downloadsAcquired?: number; justAcquired?: boolean; kind?: string; maxDownloadDevices?: number; message?: string; nonce?: string; reasonCode?: string; restricted?: boolean; signature?: string; source?: string; volumeId?: string }; driveImportedContentLink?: string; embeddable?: boolean; epub?: { acsTokenLink?: string; downloadLink?: string; isAvailable?: boolean }; explicitOfflineLicenseManagement?: boolean; pdf?: { acsTokenLink?: string; downloadLink?: string; isAvailable?: boolean }; publicDomain?: boolean; quoteSharingAllowed?: boolean; textToSpeechPermission?: string; viewOrderUrl?: string; viewability?: string; webReaderLink?: string }; etag?: string; id?: string; kind?: string; layerInfo?: { layers?: ({ layerId?: string; volumeAnnotationsVersion?: string })[] }; recommendedInfo?: { explanation?: string }; saleInfo?: { buyLink?: string; country?: string; isEbook?: boolean; listPrice?: { amount?: number; currencyCode?: string }; offers?: ({ finskyOfferType?: number; giftable?: boolean; listPrice?: { amountInMicros?: number; currencyCode?: string }; rentalDuration?: { count?: number; unit?: string }; retailPrice?: { amountInMicros?: number; currencyCode?: string } })[]; onSaleDate?: string; retailPrice?: { amount?: number; currencyCode?: string }; saleability?: string }; searchInfo?: { textSnippet?: string }; selfLink?: string; userInfo?: { acquiredTime?: string; acquisitionType?: number; copy?: { allowedCharacterCount?: number; limitType?: string; remainingCharacterCount?: number; updated?: string }; entitlementType?: number; familySharing?: { familyRole?: string; isSharingAllowed?: boolean; isSharingDisabledByFop?: boolean }; isFamilySharedFromUser?: boolean; isFamilySharedToUser?: boolean; isFamilySharingAllowed?: boolean; isFamilySharingDisabledByFop?: boolean; isInMyBooks?: boolean; isPreordered?: boolean; isPurchased?: boolean; isUploaded?: boolean; readingPosition?: { epubCfiPosition?: string; gbImagePosition?: string; gbTextPosition?: string; kind?: string; pdfPosition?: string; updated?: string; volumeId?: string }; rentalPeriod?: { endUtcSec?: string; startUtcSec?: string }; rentalState?: string; review?: { author?: { displayName?: string }; content?: string; date?: string; fullTextUrl?: string; kind?: string; rating?: string; source?: { description?: string; extraDescription?: string; url?: string }; title?: string; type?: string; volumeId?: string }; updated?: string; userUploadedVolumeInfo?: { processingState?: string } }; volumeInfo?: { allowAnonLogging?: boolean; authors?: (string)[]; averageRating?: number; canonicalVolumeLink?: string; categories?: (string)[]; comicsContent?: boolean; contentVersion?: string; description?: string; dimensions?: { height?: string; thickness?: string; width?: string }; imageLinks?: { extraLarge?: string; large?: string; medium?: string; small?: string; smallThumbnail?: string; thumbnail?: string }; industryIdentifiers?: ({ identifier?: string; type?: string })[]; infoLink?: string; language?: string; mainCategory?: string; maturityRating?: string; pageCount?: number; panelizationSummary?: { containsEpubBubbles?: boolean; containsImageBubbles?: boolean; epubBubbleVersion?: string; imageBubbleVersion?: string }; previewLink?: string; printType?: string; printedPageCount?: number; publishedDate?: string; publisher?: string; ratingsCount?: number; readingModes?: { image?: boolean; text?: boolean }; samplePageCount?: number; seriesInfo?: { bookDisplayNumber?: string; kind?: string; shortSeriesBookTitle?: string; volumeSeries?: ({ issue?: ({ issueDisplayNumber?: string; issueOrderNumber?: number })[]; orderNumber?: number; seriesBookType?: string; seriesId?: string })[] }; subtitle?: string; title?: string } })[]; kind?: string; totalItems?: number }>;
|
|
272
|
+
/**
|
|
273
|
+
* Gets volume information for a single volume.
|
|
274
|
+
* Tags: volumes
|
|
275
|
+
* Access as: google/books.volumesGet(input)
|
|
276
|
+
*/
|
|
277
|
+
volumesGet: (input: { volumeId: string; "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; country?: string; includeNonComicsSeries?: boolean; partner?: string; projection?: "PROJECTION_UNDEFINED" | "FULL" | "LITE"; source?: string; user_library_consistent_read?: boolean }) => Promise<{ accessInfo?: { accessViewStatus?: string; country?: string; downloadAccess?: { deviceAllowed?: boolean; downloadsAcquired?: number; justAcquired?: boolean; kind?: string; maxDownloadDevices?: number; message?: string; nonce?: string; reasonCode?: string; restricted?: boolean; signature?: string; source?: string; volumeId?: string }; driveImportedContentLink?: string; embeddable?: boolean; epub?: { acsTokenLink?: string; downloadLink?: string; isAvailable?: boolean }; explicitOfflineLicenseManagement?: boolean; pdf?: { acsTokenLink?: string; downloadLink?: string; isAvailable?: boolean }; publicDomain?: boolean; quoteSharingAllowed?: boolean; textToSpeechPermission?: string; viewOrderUrl?: string; viewability?: string; webReaderLink?: string }; etag?: string; id?: string; kind?: string; layerInfo?: { layers?: ({ layerId?: string; volumeAnnotationsVersion?: string })[] }; recommendedInfo?: { explanation?: string }; saleInfo?: { buyLink?: string; country?: string; isEbook?: boolean; listPrice?: { amount?: number; currencyCode?: string }; offers?: ({ finskyOfferType?: number; giftable?: boolean; listPrice?: { amountInMicros?: number; currencyCode?: string }; rentalDuration?: { count?: number; unit?: string }; retailPrice?: { amountInMicros?: number; currencyCode?: string } })[]; onSaleDate?: string; retailPrice?: { amount?: number; currencyCode?: string }; saleability?: string }; searchInfo?: { textSnippet?: string }; selfLink?: string; userInfo?: { acquiredTime?: string; acquisitionType?: number; copy?: { allowedCharacterCount?: number; limitType?: string; remainingCharacterCount?: number; updated?: string }; entitlementType?: number; familySharing?: { familyRole?: string; isSharingAllowed?: boolean; isSharingDisabledByFop?: boolean }; isFamilySharedFromUser?: boolean; isFamilySharedToUser?: boolean; isFamilySharingAllowed?: boolean; isFamilySharingDisabledByFop?: boolean; isInMyBooks?: boolean; isPreordered?: boolean; isPurchased?: boolean; isUploaded?: boolean; readingPosition?: { epubCfiPosition?: string; gbImagePosition?: string; gbTextPosition?: string; kind?: string; pdfPosition?: string; updated?: string; volumeId?: string }; rentalPeriod?: { endUtcSec?: string; startUtcSec?: string }; rentalState?: string; review?: { author?: { displayName?: string }; content?: string; date?: string; fullTextUrl?: string; kind?: string; rating?: string; source?: { description?: string; extraDescription?: string; url?: string }; title?: string; type?: string; volumeId?: string }; updated?: string; userUploadedVolumeInfo?: { processingState?: string } }; volumeInfo?: { allowAnonLogging?: boolean; authors?: (string)[]; averageRating?: number; canonicalVolumeLink?: string; categories?: (string)[]; comicsContent?: boolean; contentVersion?: string; description?: string; dimensions?: { height?: string; thickness?: string; width?: string }; imageLinks?: { extraLarge?: string; large?: string; medium?: string; small?: string; smallThumbnail?: string; thumbnail?: string }; industryIdentifiers?: ({ identifier?: string; type?: string })[]; infoLink?: string; language?: string; mainCategory?: string; maturityRating?: string; pageCount?: number; panelizationSummary?: { containsEpubBubbles?: boolean; containsImageBubbles?: boolean; epubBubbleVersion?: string; imageBubbleVersion?: string }; previewLink?: string; printType?: string; printedPageCount?: number; publishedDate?: string; publisher?: string; ratingsCount?: number; readingModes?: { image?: boolean; text?: boolean }; samplePageCount?: number; seriesInfo?: { bookDisplayNumber?: string; kind?: string; shortSeriesBookTitle?: string; volumeSeries?: ({ issue?: ({ issueDisplayNumber?: string; issueOrderNumber?: number })[]; orderNumber?: number; seriesBookType?: string; seriesId?: string })[] }; subtitle?: string; title?: string } }>;
|
|
278
|
+
/**
|
|
279
|
+
* Performs a book search.
|
|
280
|
+
* Tags: volumes
|
|
281
|
+
* Access as: google/books.volumesList(input)
|
|
282
|
+
*/
|
|
283
|
+
volumesList: (input: { "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; q: string; download?: "DOWNLOAD_UNDEFINED" | "EPUB"; filter?: "FILTER_UNDEFINED" | "ebooks" | "free-ebooks" | "full" | "paid-ebooks" | "partial"; langRestrict?: string; libraryRestrict?: "LIBRARY_RESTRICT_UNDEFINED" | "my-library" | "no-restrict"; maxAllowedMaturityRating?: "MAX_ALLOWED_MATURITY_RATING_UNDEFINED" | "MATURE" | "not-mature"; maxResults?: number; orderBy?: "ORDER_BY_UNDEFINED" | "newest" | "relevance"; partner?: string; printType?: "PRINT_TYPE_UNDEFINED" | "ALL" | "BOOKS" | "MAGAZINES"; projection?: "PROJECTION_UNDEFINED" | "FULL" | "LITE"; showPreorders?: boolean; source?: string; startIndex?: number }) => Promise<{ items?: ({ accessInfo?: { accessViewStatus?: string; country?: string; downloadAccess?: { deviceAllowed?: boolean; downloadsAcquired?: number; justAcquired?: boolean; kind?: string; maxDownloadDevices?: number; message?: string; nonce?: string; reasonCode?: string; restricted?: boolean; signature?: string; source?: string; volumeId?: string }; driveImportedContentLink?: string; embeddable?: boolean; epub?: { acsTokenLink?: string; downloadLink?: string; isAvailable?: boolean }; explicitOfflineLicenseManagement?: boolean; pdf?: { acsTokenLink?: string; downloadLink?: string; isAvailable?: boolean }; publicDomain?: boolean; quoteSharingAllowed?: boolean; textToSpeechPermission?: string; viewOrderUrl?: string; viewability?: string; webReaderLink?: string }; etag?: string; id?: string; kind?: string; layerInfo?: { layers?: ({ layerId?: string; volumeAnnotationsVersion?: string })[] }; recommendedInfo?: { explanation?: string }; saleInfo?: { buyLink?: string; country?: string; isEbook?: boolean; listPrice?: { amount?: number; currencyCode?: string }; offers?: ({ finskyOfferType?: number; giftable?: boolean; listPrice?: { amountInMicros?: number; currencyCode?: string }; rentalDuration?: { count?: number; unit?: string }; retailPrice?: { amountInMicros?: number; currencyCode?: string } })[]; onSaleDate?: string; retailPrice?: { amount?: number; currencyCode?: string }; saleability?: string }; searchInfo?: { textSnippet?: string }; selfLink?: string; userInfo?: { acquiredTime?: string; acquisitionType?: number; copy?: { allowedCharacterCount?: number; limitType?: string; remainingCharacterCount?: number; updated?: string }; entitlementType?: number; familySharing?: { familyRole?: string; isSharingAllowed?: boolean; isSharingDisabledByFop?: boolean }; isFamilySharedFromUser?: boolean; isFamilySharedToUser?: boolean; isFamilySharingAllowed?: boolean; isFamilySharingDisabledByFop?: boolean; isInMyBooks?: boolean; isPreordered?: boolean; isPurchased?: boolean; isUploaded?: boolean; readingPosition?: { epubCfiPosition?: string; gbImagePosition?: string; gbTextPosition?: string; kind?: string; pdfPosition?: string; updated?: string; volumeId?: string }; rentalPeriod?: { endUtcSec?: string; startUtcSec?: string }; rentalState?: string; review?: { author?: { displayName?: string }; content?: string; date?: string; fullTextUrl?: string; kind?: string; rating?: string; source?: { description?: string; extraDescription?: string; url?: string }; title?: string; type?: string; volumeId?: string }; updated?: string; userUploadedVolumeInfo?: { processingState?: string } }; volumeInfo?: { allowAnonLogging?: boolean; authors?: (string)[]; averageRating?: number; canonicalVolumeLink?: string; categories?: (string)[]; comicsContent?: boolean; contentVersion?: string; description?: string; dimensions?: { height?: string; thickness?: string; width?: string }; imageLinks?: { extraLarge?: string; large?: string; medium?: string; small?: string; smallThumbnail?: string; thumbnail?: string }; industryIdentifiers?: ({ identifier?: string; type?: string })[]; infoLink?: string; language?: string; mainCategory?: string; maturityRating?: string; pageCount?: number; panelizationSummary?: { containsEpubBubbles?: boolean; containsImageBubbles?: boolean; epubBubbleVersion?: string; imageBubbleVersion?: string }; previewLink?: string; printType?: string; printedPageCount?: number; publishedDate?: string; publisher?: string; ratingsCount?: number; readingModes?: { image?: boolean; text?: boolean }; samplePageCount?: number; seriesInfo?: { bookDisplayNumber?: string; kind?: string; shortSeriesBookTitle?: string; volumeSeries?: ({ issue?: ({ issueDisplayNumber?: string; issueOrderNumber?: number })[]; orderNumber?: number; seriesBookType?: string; seriesId?: string })[] }; subtitle?: string; title?: string } })[]; kind?: string; totalItems?: number }>;
|
|
284
|
+
/**
|
|
285
|
+
* Return a list of books in My Library.
|
|
286
|
+
* Tags: volumes
|
|
287
|
+
* Access as: google/books.volumesMybooksList(input)
|
|
288
|
+
*/
|
|
289
|
+
volumesMybooksList: (input: { "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; acquireMethod?: ("ACQUIRE_METHOD_UNDEFINED" | "FAMILY_SHARED" | "PREORDERED" | "PREVIOUSLY_RENTED" | "PUBLIC_DOMAIN" | "PURCHASED" | "RENTED" | "SAMPLE" | "UPLOADED")[]; country?: string; locale?: string; maxResults?: number; processingState?: ("PROCESSING_STATE_UNDEFINED" | "COMPLETED_FAILED" | "COMPLETED_SUCCESS" | "RUNNING")[]; source?: string; startIndex?: number }) => Promise<{ items?: ({ accessInfo?: { accessViewStatus?: string; country?: string; downloadAccess?: { deviceAllowed?: boolean; downloadsAcquired?: number; justAcquired?: boolean; kind?: string; maxDownloadDevices?: number; message?: string; nonce?: string; reasonCode?: string; restricted?: boolean; signature?: string; source?: string; volumeId?: string }; driveImportedContentLink?: string; embeddable?: boolean; epub?: { acsTokenLink?: string; downloadLink?: string; isAvailable?: boolean }; explicitOfflineLicenseManagement?: boolean; pdf?: { acsTokenLink?: string; downloadLink?: string; isAvailable?: boolean }; publicDomain?: boolean; quoteSharingAllowed?: boolean; textToSpeechPermission?: string; viewOrderUrl?: string; viewability?: string; webReaderLink?: string }; etag?: string; id?: string; kind?: string; layerInfo?: { layers?: ({ layerId?: string; volumeAnnotationsVersion?: string })[] }; recommendedInfo?: { explanation?: string }; saleInfo?: { buyLink?: string; country?: string; isEbook?: boolean; listPrice?: { amount?: number; currencyCode?: string }; offers?: ({ finskyOfferType?: number; giftable?: boolean; listPrice?: { amountInMicros?: number; currencyCode?: string }; rentalDuration?: { count?: number; unit?: string }; retailPrice?: { amountInMicros?: number; currencyCode?: string } })[]; onSaleDate?: string; retailPrice?: { amount?: number; currencyCode?: string }; saleability?: string }; searchInfo?: { textSnippet?: string }; selfLink?: string; userInfo?: { acquiredTime?: string; acquisitionType?: number; copy?: { allowedCharacterCount?: number; limitType?: string; remainingCharacterCount?: number; updated?: string }; entitlementType?: number; familySharing?: { familyRole?: string; isSharingAllowed?: boolean; isSharingDisabledByFop?: boolean }; isFamilySharedFromUser?: boolean; isFamilySharedToUser?: boolean; isFamilySharingAllowed?: boolean; isFamilySharingDisabledByFop?: boolean; isInMyBooks?: boolean; isPreordered?: boolean; isPurchased?: boolean; isUploaded?: boolean; readingPosition?: { epubCfiPosition?: string; gbImagePosition?: string; gbTextPosition?: string; kind?: string; pdfPosition?: string; updated?: string; volumeId?: string }; rentalPeriod?: { endUtcSec?: string; startUtcSec?: string }; rentalState?: string; review?: { author?: { displayName?: string }; content?: string; date?: string; fullTextUrl?: string; kind?: string; rating?: string; source?: { description?: string; extraDescription?: string; url?: string }; title?: string; type?: string; volumeId?: string }; updated?: string; userUploadedVolumeInfo?: { processingState?: string } }; volumeInfo?: { allowAnonLogging?: boolean; authors?: (string)[]; averageRating?: number; canonicalVolumeLink?: string; categories?: (string)[]; comicsContent?: boolean; contentVersion?: string; description?: string; dimensions?: { height?: string; thickness?: string; width?: string }; imageLinks?: { extraLarge?: string; large?: string; medium?: string; small?: string; smallThumbnail?: string; thumbnail?: string }; industryIdentifiers?: ({ identifier?: string; type?: string })[]; infoLink?: string; language?: string; mainCategory?: string; maturityRating?: string; pageCount?: number; panelizationSummary?: { containsEpubBubbles?: boolean; containsImageBubbles?: boolean; epubBubbleVersion?: string; imageBubbleVersion?: string }; previewLink?: string; printType?: string; printedPageCount?: number; publishedDate?: string; publisher?: string; ratingsCount?: number; readingModes?: { image?: boolean; text?: boolean }; samplePageCount?: number; seriesInfo?: { bookDisplayNumber?: string; kind?: string; shortSeriesBookTitle?: string; volumeSeries?: ({ issue?: ({ issueDisplayNumber?: string; issueOrderNumber?: number })[]; orderNumber?: number; seriesBookType?: string; seriesId?: string })[] }; subtitle?: string; title?: string } })[]; kind?: string; totalItems?: number }>;
|
|
290
|
+
/**
|
|
291
|
+
* Return a list of recommended books for the current user.
|
|
292
|
+
* Tags: volumes
|
|
293
|
+
* Access as: google/books.volumesRecommendedList(input)
|
|
294
|
+
*/
|
|
295
|
+
volumesRecommendedList: (input: { "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; locale?: string; maxAllowedMaturityRating?: "MAX_ALLOWED_MATURITY_RATING_UNDEFINED" | "MATURE" | "not-mature"; source?: string }) => Promise<{ items?: ({ accessInfo?: { accessViewStatus?: string; country?: string; downloadAccess?: { deviceAllowed?: boolean; downloadsAcquired?: number; justAcquired?: boolean; kind?: string; maxDownloadDevices?: number; message?: string; nonce?: string; reasonCode?: string; restricted?: boolean; signature?: string; source?: string; volumeId?: string }; driveImportedContentLink?: string; embeddable?: boolean; epub?: { acsTokenLink?: string; downloadLink?: string; isAvailable?: boolean }; explicitOfflineLicenseManagement?: boolean; pdf?: { acsTokenLink?: string; downloadLink?: string; isAvailable?: boolean }; publicDomain?: boolean; quoteSharingAllowed?: boolean; textToSpeechPermission?: string; viewOrderUrl?: string; viewability?: string; webReaderLink?: string }; etag?: string; id?: string; kind?: string; layerInfo?: { layers?: ({ layerId?: string; volumeAnnotationsVersion?: string })[] }; recommendedInfo?: { explanation?: string }; saleInfo?: { buyLink?: string; country?: string; isEbook?: boolean; listPrice?: { amount?: number; currencyCode?: string }; offers?: ({ finskyOfferType?: number; giftable?: boolean; listPrice?: { amountInMicros?: number; currencyCode?: string }; rentalDuration?: { count?: number; unit?: string }; retailPrice?: { amountInMicros?: number; currencyCode?: string } })[]; onSaleDate?: string; retailPrice?: { amount?: number; currencyCode?: string }; saleability?: string }; searchInfo?: { textSnippet?: string }; selfLink?: string; userInfo?: { acquiredTime?: string; acquisitionType?: number; copy?: { allowedCharacterCount?: number; limitType?: string; remainingCharacterCount?: number; updated?: string }; entitlementType?: number; familySharing?: { familyRole?: string; isSharingAllowed?: boolean; isSharingDisabledByFop?: boolean }; isFamilySharedFromUser?: boolean; isFamilySharedToUser?: boolean; isFamilySharingAllowed?: boolean; isFamilySharingDisabledByFop?: boolean; isInMyBooks?: boolean; isPreordered?: boolean; isPurchased?: boolean; isUploaded?: boolean; readingPosition?: { epubCfiPosition?: string; gbImagePosition?: string; gbTextPosition?: string; kind?: string; pdfPosition?: string; updated?: string; volumeId?: string }; rentalPeriod?: { endUtcSec?: string; startUtcSec?: string }; rentalState?: string; review?: { author?: { displayName?: string }; content?: string; date?: string; fullTextUrl?: string; kind?: string; rating?: string; source?: { description?: string; extraDescription?: string; url?: string }; title?: string; type?: string; volumeId?: string }; updated?: string; userUploadedVolumeInfo?: { processingState?: string } }; volumeInfo?: { allowAnonLogging?: boolean; authors?: (string)[]; averageRating?: number; canonicalVolumeLink?: string; categories?: (string)[]; comicsContent?: boolean; contentVersion?: string; description?: string; dimensions?: { height?: string; thickness?: string; width?: string }; imageLinks?: { extraLarge?: string; large?: string; medium?: string; small?: string; smallThumbnail?: string; thumbnail?: string }; industryIdentifiers?: ({ identifier?: string; type?: string })[]; infoLink?: string; language?: string; mainCategory?: string; maturityRating?: string; pageCount?: number; panelizationSummary?: { containsEpubBubbles?: boolean; containsImageBubbles?: boolean; epubBubbleVersion?: string; imageBubbleVersion?: string }; previewLink?: string; printType?: string; printedPageCount?: number; publishedDate?: string; publisher?: string; ratingsCount?: number; readingModes?: { image?: boolean; text?: boolean }; samplePageCount?: number; seriesInfo?: { bookDisplayNumber?: string; kind?: string; shortSeriesBookTitle?: string; volumeSeries?: ({ issue?: ({ issueDisplayNumber?: string; issueOrderNumber?: number })[]; orderNumber?: number; seriesBookType?: string; seriesId?: string })[] }; subtitle?: string; title?: string } })[]; kind?: string; totalItems?: number }>;
|
|
296
|
+
/**
|
|
297
|
+
* Rate a recommended book for the current user.
|
|
298
|
+
* Tags: volumes
|
|
299
|
+
* Access as: google/books.volumesRecommendedRate(input)
|
|
300
|
+
*/
|
|
301
|
+
volumesRecommendedRate: (input: { "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; rating: "RATING_UNDEFINED" | "HAVE_IT" | "NOT_INTERESTED"; volumeId: string; locale?: string; source?: string }) => Promise<{ consistency_token?: string }>;
|
|
302
|
+
/**
|
|
303
|
+
* Return a list of books uploaded by the current user.
|
|
304
|
+
* Tags: volumes
|
|
305
|
+
* Access as: google/books.volumesUseruploadedList(input)
|
|
306
|
+
*/
|
|
307
|
+
volumesUseruploadedList: (input: { "$.xgafv"?: "1" | "2"; access_token?: string; alt?: "json" | "media" | "proto"; callback?: string; fields?: string; key?: string; oauth_token?: string; prettyPrint?: boolean; quotaUser?: string; upload_protocol?: string; uploadType?: string; locale?: string; maxResults?: number; processingState?: ("PROCESSING_STATE_UNDEFINED" | "COMPLETED_FAILED" | "COMPLETED_SUCCESS" | "RUNNING")[]; source?: string; startIndex?: number; volumeId?: (string)[] }) => Promise<{ items?: ({ accessInfo?: { accessViewStatus?: string; country?: string; downloadAccess?: { deviceAllowed?: boolean; downloadsAcquired?: number; justAcquired?: boolean; kind?: string; maxDownloadDevices?: number; message?: string; nonce?: string; reasonCode?: string; restricted?: boolean; signature?: string; source?: string; volumeId?: string }; driveImportedContentLink?: string; embeddable?: boolean; epub?: { acsTokenLink?: string; downloadLink?: string; isAvailable?: boolean }; explicitOfflineLicenseManagement?: boolean; pdf?: { acsTokenLink?: string; downloadLink?: string; isAvailable?: boolean }; publicDomain?: boolean; quoteSharingAllowed?: boolean; textToSpeechPermission?: string; viewOrderUrl?: string; viewability?: string; webReaderLink?: string }; etag?: string; id?: string; kind?: string; layerInfo?: { layers?: ({ layerId?: string; volumeAnnotationsVersion?: string })[] }; recommendedInfo?: { explanation?: string }; saleInfo?: { buyLink?: string; country?: string; isEbook?: boolean; listPrice?: { amount?: number; currencyCode?: string }; offers?: ({ finskyOfferType?: number; giftable?: boolean; listPrice?: { amountInMicros?: number; currencyCode?: string }; rentalDuration?: { count?: number; unit?: string }; retailPrice?: { amountInMicros?: number; currencyCode?: string } })[]; onSaleDate?: string; retailPrice?: { amount?: number; currencyCode?: string }; saleability?: string }; searchInfo?: { textSnippet?: string }; selfLink?: string; userInfo?: { acquiredTime?: string; acquisitionType?: number; copy?: { allowedCharacterCount?: number; limitType?: string; remainingCharacterCount?: number; updated?: string }; entitlementType?: number; familySharing?: { familyRole?: string; isSharingAllowed?: boolean; isSharingDisabledByFop?: boolean }; isFamilySharedFromUser?: boolean; isFamilySharedToUser?: boolean; isFamilySharingAllowed?: boolean; isFamilySharingDisabledByFop?: boolean; isInMyBooks?: boolean; isPreordered?: boolean; isPurchased?: boolean; isUploaded?: boolean; readingPosition?: { epubCfiPosition?: string; gbImagePosition?: string; gbTextPosition?: string; kind?: string; pdfPosition?: string; updated?: string; volumeId?: string }; rentalPeriod?: { endUtcSec?: string; startUtcSec?: string }; rentalState?: string; review?: { author?: { displayName?: string }; content?: string; date?: string; fullTextUrl?: string; kind?: string; rating?: string; source?: { description?: string; extraDescription?: string; url?: string }; title?: string; type?: string; volumeId?: string }; updated?: string; userUploadedVolumeInfo?: { processingState?: string } }; volumeInfo?: { allowAnonLogging?: boolean; authors?: (string)[]; averageRating?: number; canonicalVolumeLink?: string; categories?: (string)[]; comicsContent?: boolean; contentVersion?: string; description?: string; dimensions?: { height?: string; thickness?: string; width?: string }; imageLinks?: { extraLarge?: string; large?: string; medium?: string; small?: string; smallThumbnail?: string; thumbnail?: string }; industryIdentifiers?: ({ identifier?: string; type?: string })[]; infoLink?: string; language?: string; mainCategory?: string; maturityRating?: string; pageCount?: number; panelizationSummary?: { containsEpubBubbles?: boolean; containsImageBubbles?: boolean; epubBubbleVersion?: string; imageBubbleVersion?: string }; previewLink?: string; printType?: string; printedPageCount?: number; publishedDate?: string; publisher?: string; ratingsCount?: number; readingModes?: { image?: boolean; text?: boolean }; samplePageCount?: number; seriesInfo?: { bookDisplayNumber?: string; kind?: string; shortSeriesBookTitle?: string; volumeSeries?: ({ issue?: ({ issueDisplayNumber?: string; issueOrderNumber?: number })[]; orderNumber?: number; seriesBookType?: string; seriesId?: string })[] }; subtitle?: string; title?: string } })[]; kind?: string; totalItems?: number }>;
|
|
308
|
+
};
|
package/drive/README.md
ADDED
package/drive/index.ts
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import type { CreateClientOptions } from "../../client.js";
|
|
2
|
+
import { createClient, createLazyClient } from "../../client.js";
|
|
3
|
+
import type { GoogleDriveClient } from "./types.js";
|
|
4
|
+
import { toolMetadata } from "./metadata.js";
|
|
5
|
+
import openApiDocument from "./openapi.json" with { type: "json" };
|
|
6
|
+
|
|
7
|
+
export * from "./types.js";
|
|
8
|
+
|
|
9
|
+
export function createGoogleDriveClient(
|
|
10
|
+
options: Omit<CreateClientOptions, "name" | "openApiDocument" | "toolMetadata"> = {},
|
|
11
|
+
): Promise<GoogleDriveClient> {
|
|
12
|
+
return createClient<GoogleDriveClient>({
|
|
13
|
+
...options,
|
|
14
|
+
name: "google/drive",
|
|
15
|
+
openApiDocument,
|
|
16
|
+
toolMetadata,
|
|
17
|
+
});
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
const defaultClient = createLazyClient(() => createGoogleDriveClient());
|
|
21
|
+
|
|
22
|
+
export default defaultClient;
|