1<?php
2/*
3 * Copyright 2014 Google Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6 * use this file except in compliance with the License. You may obtain a copy of
7 * the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 * License for the specific language governing permissions and limitations under
15 * the License.
16 */
17
18namespace Google\Service\Books\Resource;
19
20use Google\Service\Books\Volumes as VolumesModel;
21
22/**
23 * The "volumes" collection of methods.
24 * Typical usage is:
25 *  <code>
26 *   $booksService = new Google\Service\Books(...);
27 *   $volumes = $booksService->volumes;
28 *  </code>
29 */
30class MylibraryBookshelvesVolumes extends \Google\Service\Resource
31{
32  /**
33   * Gets volume information for volumes on a bookshelf.
34   * (volumes.listMylibraryBookshelvesVolumes)
35   *
36   * @param string $shelf The bookshelf ID or name retrieve volumes for.
37   * @param array $optParams Optional parameters.
38   *
39   * @opt_param string country ISO-3166-1 code to override the IP-based location.
40   * @opt_param string maxResults Maximum number of results to return
41   * @opt_param string projection Restrict information returned to a set of
42   * selected fields.
43   * @opt_param string q Full-text search query string in this bookshelf.
44   * @opt_param bool showPreorders Set to true to show pre-ordered books. Defaults
45   * to false.
46   * @opt_param string source String to identify the originator of this request.
47   * @opt_param string startIndex Index of the first element to return (starts at
48   * 0)
49   * @return Volumes
50   */
51  public function listMylibraryBookshelvesVolumes($shelf, $optParams = [])
52  {
53    $params = ['shelf' => $shelf];
54    $params = array_merge($params, $optParams);
55    return $this->call('list', [$params], VolumesModel::class);
56  }
57}
58
59// Adding a class alias for backwards compatibility with the previous class name.
60class_alias(MylibraryBookshelvesVolumes::class, 'Google_Service_Books_Resource_MylibraryBookshelvesVolumes');
61