get method

Future<Bookshelf> get(
  1. String userId,
  2. String shelf, {
  3. String? source,
  4. String? $fields,
})

Retrieves metadata for a specific bookshelf for the specified user.

Request parameters:

userId - ID of user for whom to retrieve bookshelves.

shelf - ID of bookshelf to retrieve.

source - String to identify the originator of this request.

$fields - Selector specifying which fields to include in a partial response.

Completes with a Bookshelf.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<Bookshelf> get(
  core.String userId,
  core.String shelf, {
  core.String? source,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (source != null) 'source': [source],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'books/v1/users/' +
      commons.escapeVariable('$userId') +
      '/bookshelves/' +
      commons.escapeVariable('$shelf');

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return Bookshelf.fromJson(response_ as core.Map<core.String, core.dynamic>);
}