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\ChangeLog;
21use Google\Service\Dfareporting\ChangeLogsListResponse;
22
23/**
24 * The "changeLogs" collection of methods.
25 * Typical usage is:
26 *  <code>
27 *   $dfareportingService = new Google\Service\Dfareporting(...);
28 *   $changeLogs = $dfareportingService->changeLogs;
29 *  </code>
30 */
31class ChangeLogs extends \Google\Service\Resource
32{
33  /**
34   * Gets one change log by ID. (changeLogs.get)
35   *
36   * @param string $profileId User profile ID associated with this request.
37   * @param string $id Change log ID.
38   * @param array $optParams Optional parameters.
39   * @return ChangeLog
40   */
41  public function get($profileId, $id, $optParams = [])
42  {
43    $params = ['profileId' => $profileId, 'id' => $id];
44    $params = array_merge($params, $optParams);
45    return $this->call('get', [$params], ChangeLog::class);
46  }
47  /**
48   * Retrieves a list of change logs. This method supports paging.
49   * (changeLogs.listChangeLogs)
50   *
51   * @param string $profileId User profile ID associated with this request.
52   * @param array $optParams Optional parameters.
53   *
54   * @opt_param string action Select only change logs with the specified action.
55   * @opt_param string ids Select only change logs with these IDs.
56   * @opt_param string maxChangeTime Select only change logs whose change time is
57   * before the specified maxChangeTime.The time should be formatted as an RFC3339
58   * date/time string. For example, for 10:54 PM on July 18th, 2015, in the
59   * America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In
60   * other words, the year, month, day, the letter T, the hour (24-hour clock
61   * system), minute, second, and then the time zone offset.
62   * @opt_param int maxResults Maximum number of results to return.
63   * @opt_param string minChangeTime Select only change logs whose change time is
64   * after the specified minChangeTime.The time should be formatted as an RFC3339
65   * date/time string. For example, for 10:54 PM on July 18th, 2015, in the
66   * America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In
67   * other words, the year, month, day, the letter T, the hour (24-hour clock
68   * system), minute, second, and then the time zone offset.
69   * @opt_param string objectIds Select only change logs with these object IDs.
70   * @opt_param string objectType Select only change logs with the specified
71   * object type.
72   * @opt_param string pageToken Value of the nextPageToken from the previous
73   * result page.
74   * @opt_param string searchString Select only change logs whose object ID, user
75   * name, old or new values match the search string.
76   * @opt_param string userProfileIds Select only change logs with these user
77   * profile IDs.
78   * @return ChangeLogsListResponse
79   */
80  public function listChangeLogs($profileId, $optParams = [])
81  {
82    $params = ['profileId' => $profileId];
83    $params = array_merge($params, $optParams);
84    return $this->call('list', [$params], ChangeLogsListResponse::class);
85  }
86}
87
88// Adding a class alias for backwards compatibility with the previous class name.
89class_alias(ChangeLogs::class, 'Google_Service_Dfareporting_Resource_ChangeLogs');
90