npm package: @maxim_mazurok/gapi.client.books
Description: TypeScript typings for Books API v1
Author: Maxim Mazurok
Latest version: 1.0.20220810

# TypeScript typings for Books API v1

The Google Books API allows clients to access the Google Books repository.
For detailed description please check [documentation](https://code.google.com/apis/books/docs/v1/getting_started.html).

## Installing

Install typings for Books API:

```
npm install @types/gapi.client.books@v1 --save-dev
```

## Usage

You need to initialize Google API client in your code:

```typescript
gapi.load('client', () => {
  // now we can use gapi.client
  // ...
});
```

Then load api client wrapper:

```typescript
gapi.client.load('books', 'v1', () => {
  // now we can use gapi.client.books
  // ...
});
```

Don't forget to authenticate your client before sending any request to resources:

```typescript
// declare client_id registered in Google Developers Console
var client_id = '',
  scope = [ 
      // Manage your books
      'https://www.googleapis.com/auth/books',
    ],
    immediate = true;
// ...

gapi.auth.authorize(
  { client_id: client_id, scope: scope, immediate: immediate },
  authResult => {
    if (authResult && !authResult.error) {
        /* handle successful authorization */
    } else {
        /* handle authorization error */
    }
});
```

After that you can use Books API resources:

```typescript

/*
Retrieves metadata for a specific bookshelf for the specified user.
*/
await gapi.client.books.bookshelves.get({ shelf: "shelf", userId: "userId",  });

/*
Retrieves a list of public bookshelves for the specified user.
*/
await gapi.client.books.bookshelves.list({ userId: "userId",  });

/*
Add a user-upload volume and triggers processing.
*/
await gapi.client.books.cloudloading.addBook({  });

/*
Remove the book and its contents
*/
await gapi.client.books.cloudloading.deleteBook({ volumeId: "volumeId",  });

/*
Updates a user-upload volume.
*/
await gapi.client.books.cloudloading.updateBook({  });

/*
Returns a list of offline dictionary metadata available
*/
await gapi.client.books.dictionary.listOfflineMetadata({ cpksver: "cpksver",  });

/*
Gets information regarding the family that the user is part of.
*/
await gapi.client.books.familysharing.getFamilyInfo({  });

/*
Initiates sharing of the content with the user's family. Empty response indicates success.
*/
await gapi.client.books.familysharing.share({  });

/*
Initiates revoking content that has already been shared with the user's family. Empty response indicates success.
*/
await gapi.client.books.familysharing.unshare({  });

/*
Gets the layer summary for a volume.
*/
await gapi.client.books.layers.get({ summaryId: "summaryId", volumeId: "volumeId",  });

/*
List the layer summaries for a volume.
*/
await gapi.client.books.layers.list({ volumeId: "volumeId",  });

/*
Gets the current settings for the user.
*/
await gapi.client.books.myconfig.getUserSettings({  });

/*
Release downloaded content access restriction.
*/
await gapi.client.books.myconfig.releaseDownloadAccess({ cpksver: "cpksver", volumeIds: "volumeIds",  });

/*
Request concurrent and download access restrictions.
*/
await gapi.client.books.myconfig.requestAccess({ cpksver: "cpksver", nonce: "nonce", source: "source", volumeId: "volumeId",  });

/*
Request downloaded content access for specified volumes on the My eBooks shelf.
*/
await gapi.client.books.myconfig.syncVolumeLicenses({ cpksver: "cpksver", nonce: "nonce", source: "source",  });

/*
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.
*/
await gapi.client.books.myconfig.updateUserSettings({  });

/*
Returns notification details for a given notification id.
*/
await gapi.client.books.notification.get({ notification_id: "notification_id",  });

/*
List categories for onboarding experience.
*/
await gapi.client.books.onboarding.listCategories({  });

/*
List available volumes under categories for onboarding experience.
*/
await gapi.client.books.onboarding.listCategoryVolumes({  });

/*
Returns a stream of personalized book clusters
*/
await gapi.client.books.personalizedstream.get({  });

/*
Accepts the promo offer.
*/
await gapi.client.books.promooffer.accept({  });

/*
Marks the promo offer as dismissed.
*/
await gapi.client.books.promooffer.dismiss({  });

/*
Returns a list of promo offers available to the user
*/
await gapi.client.books.promooffer.get({  });

/*
Returns Series metadata for the given series ids.
*/
await gapi.client.books.series.get({ series_id: "series_id",  });

/*
Gets volume information for a single volume.
*/
await gapi.client.books.volumes.get({ volumeId: "volumeId",  });

/*
Performs a book search.
*/
await gapi.client.books.volumes.list({ q: "q",  });
```