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\Libraryagent\Resource;
19
20use Google\Service\Libraryagent\GoogleExampleLibraryagentV1ListShelvesResponse;
21use Google\Service\Libraryagent\GoogleExampleLibraryagentV1Shelf;
22
23/**
24 * The "shelves" collection of methods.
25 * Typical usage is:
26 *  <code>
27 *   $libraryagentService = new Google\Service\Libraryagent(...);
28 *   $shelves = $libraryagentService->shelves;
29 *  </code>
30 */
31class Shelves extends \Google\Service\Resource
32{
33  /**
34   * Gets a shelf. Returns NOT_FOUND if the shelf does not exist. (shelves.get)
35   *
36   * @param string $name Required. The name of the shelf to retrieve.
37   * @param array $optParams Optional parameters.
38   * @return GoogleExampleLibraryagentV1Shelf
39   */
40  public function get($name, $optParams = [])
41  {
42    $params = ['name' => $name];
43    $params = array_merge($params, $optParams);
44    return $this->call('get', [$params], GoogleExampleLibraryagentV1Shelf::class);
45  }
46  /**
47   * Lists shelves. The order is unspecified but deterministic. Newly created
48   * shelves will not necessarily be added to the end of this list.
49   * (shelves.listShelves)
50   *
51   * @param array $optParams Optional parameters.
52   *
53   * @opt_param int pageSize Requested page size. Server may return fewer shelves
54   * than requested. If unspecified, server will pick an appropriate default.
55   * @opt_param string pageToken A token identifying a page of results the server
56   * should return. Typically, this is the value of
57   * ListShelvesResponse.next_page_token returned from the previous call to
58   * `ListShelves` method.
59   * @return GoogleExampleLibraryagentV1ListShelvesResponse
60   */
61  public function listShelves($optParams = [])
62  {
63    $params = [];
64    $params = array_merge($params, $optParams);
65    return $this->call('list', [$params], GoogleExampleLibraryagentV1ListShelvesResponse::class);
66  }
67}
68
69// Adding a class alias for backwards compatibility with the previous class name.
70class_alias(Shelves::class, 'Google_Service_Libraryagent_Resource_Shelves');
71