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\Ideahub\Resource;
19
20use Google\Service\Ideahub\GoogleSearchIdeahubV1betaListIdeasResponse;
21
22/**
23 * The "ideas" collection of methods.
24 * Typical usage is:
25 *  <code>
26 *   $ideahubService = new Google\Service\Ideahub(...);
27 *   $ideas = $ideahubService->ideas;
28 *  </code>
29 */
30class PlatformsPropertiesIdeas extends \Google\Service\Resource
31{
32  /**
33   * List ideas for a given Creator and filter and sort options.
34   * (ideas.listPlatformsPropertiesIdeas)
35   *
36   * @param string $parent Required. If defined, specifies the creator for which
37   * to filter by. Format: publishers/{publisher}/properties/{property}
38   * @param array $optParams Optional parameters.
39   *
40   * @opt_param string filter Allows filtering. Supported syntax: * Filter
41   * expressions are made up of one or more restrictions. * Restrictions are
42   * implicitly combined, as if the `AND` operator was always used. The `OR`
43   * operator is currently unsupported. * Supported functions: - `saved(bool)`: If
44   * set to true, fetches only saved ideas. If set to false, fetches all except
45   * saved ideas. Can't be simultaneously used with `dismissed(bool)`. -
46   * `dismissed(bool)`: If set to true, fetches only dismissed ideas. Can't be
47   * simultaneously used with `saved(bool)`. The `false` value is currently
48   * unsupported. Examples: * `saved(true)` * `saved(false)` * `dismissed(true)`
49   * The length of this field should be no more than 500 characters.
50   * @opt_param string orderBy Order semantics described below.
51   * @opt_param int pageSize The maximum number of ideas per page. If unspecified,
52   * at most 10 ideas will be returned. The maximum value is 2000; values above
53   * 2000 will be coerced to 2000.
54   * @opt_param string pageToken Used to fetch next page.
55   * @return GoogleSearchIdeahubV1betaListIdeasResponse
56   */
57  public function listPlatformsPropertiesIdeas($parent, $optParams = [])
58  {
59    $params = ['parent' => $parent];
60    $params = array_merge($params, $optParams);
61    return $this->call('list', [$params], GoogleSearchIdeahubV1betaListIdeasResponse::class);
62  }
63}
64
65// Adding a class alias for backwards compatibility with the previous class name.
66class_alias(PlatformsPropertiesIdeas::class, 'Google_Service_Ideahub_Resource_PlatformsPropertiesIdeas');
67