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\Dfareporting\Resource;
19
20use Google\Service\Dfareporting\CitiesListResponse;
21
22/**
23 * The "cities" collection of methods.
24 * Typical usage is:
25 *  <code>
26 *   $dfareportingService = new Google\Service\Dfareporting(...);
27 *   $cities = $dfareportingService->cities;
28 *  </code>
29 */
30class Cities extends \Google\Service\Resource
31{
32  /**
33   * Retrieves a list of cities, possibly filtered. (cities.listCities)
34   *
35   * @param string $profileId User profile ID associated with this request.
36   * @param array $optParams Optional parameters.
37   *
38   * @opt_param string countryDartIds Select only cities from these countries.
39   * @opt_param string dartIds Select only cities with these DART IDs.
40   * @opt_param string namePrefix Select only cities with names starting with this
41   * prefix.
42   * @opt_param string regionDartIds Select only cities from these regions.
43   * @return CitiesListResponse
44   */
45  public function listCities($profileId, $optParams = [])
46  {
47    $params = ['profileId' => $profileId];
48    $params = array_merge($params, $optParams);
49    return $this->call('list', [$params], CitiesListResponse::class);
50  }
51}
52
53// Adding a class alias for backwards compatibility with the previous class name.
54class_alias(Cities::class, 'Google_Service_Dfareporting_Resource_Cities');
55