moveVolume method

Future<Empty> moveVolume(
  1. String shelf,
  2. String volumeId,
  3. int volumePosition, {
  4. String? source,
  5. String? $fields,
})

Moves a volume within a bookshelf.

Request parameters:

shelf - ID of bookshelf with the volume.

volumeId - ID of volume to move.

volumePosition - Position on shelf to move the item (0 puts the item before the current first item, 1 puts it between the first and the second and so on.)

source - String to identify the originator of this request.

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

Completes with a Empty.

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<Empty> moveVolume(
  core.String shelf,
  core.String volumeId,
  core.int volumePosition, {
  core.String? source,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    'volumeId': [volumeId],
    'volumePosition': ['${volumePosition}'],
    if (source != null) 'source': [source],
    if ($fields != null) 'fields': [$fields],
  };

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

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