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\BooksVolumesRecommendedRateResponse;
21use Google\Service\Books\Volumes as VolumesModel;
22
23/**
24 * The "recommended" collection of methods.
25 * Typical usage is:
26 *  <code>
27 *   $booksService = new Google\Service\Books(...);
28 *   $recommended = $booksService->recommended;
29 *  </code>
30 */
31class VolumesRecommended extends \Google\Service\Resource
32{
33  /**
34   * Return a list of recommended books for the current user.
35   * (recommended.listVolumesRecommended)
36   *
37   * @param array $optParams Optional parameters.
38   *
39   * @opt_param string locale ISO-639-1 language and ISO-3166-1 country code. Ex:
40   * 'en_US'. Used for generating recommendations.
41   * @opt_param string maxAllowedMaturityRating The maximum allowed maturity
42   * rating of returned recommendations. Books with a higher maturity rating are
43   * filtered out.
44   * @opt_param string source String to identify the originator of this request.
45   * @return Volumes
46   */
47  public function listVolumesRecommended($optParams = [])
48  {
49    $params = [];
50    $params = array_merge($params, $optParams);
51    return $this->call('list', [$params], VolumesModel::class);
52  }
53  /**
54   * Rate a recommended book for the current user. (recommended.rate)
55   *
56   * @param string $rating Rating to be given to the volume.
57   * @param string $volumeId ID of the source volume.
58   * @param array $optParams Optional parameters.
59   *
60   * @opt_param string locale ISO-639-1 language and ISO-3166-1 country code. Ex:
61   * 'en_US'. Used for generating recommendations.
62   * @opt_param string source String to identify the originator of this request.
63   * @return BooksVolumesRecommendedRateResponse
64   */
65  public function rate($rating, $volumeId, $optParams = [])
66  {
67    $params = ['rating' => $rating, 'volumeId' => $volumeId];
68    $params = array_merge($params, $optParams);
69    return $this->call('rate', [$params], BooksVolumesRecommendedRateResponse::class);
70  }
71}
72
73// Adding a class alias for backwards compatibility with the previous class name.
74class_alias(VolumesRecommended::class, 'Google_Service_Books_Resource_VolumesRecommended');
75