[Summary view] [Print] [Text view]

   1  <?php
   2  /*
   3   * Copyright 2010 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  
  18  /**
  19   * Service definition for Audit (v1).
  20   *
  21   * <p>
  22   * Lets you access user activities in your enterprise made through various applications.
  23   * </p>
  24   *
  25   * <p>
  26   * For more information about this service, see the API
  27   * <a href="https://developers.google.com/google-apps/admin-audit/get_started" target="_blank">Documentation</a>
  28   * </p>
  29   *
  30   * @author Google, Inc.
  31   */
  32  class Google_Service_Audit extends Google_Service
  33  {
  34  
  35  
  36    public $activities;
  37    
  38  
  39    /**
  40     * Constructs the internal representation of the Audit service.
  41     *
  42     * @param Google_Client $client
  43     */
  44    public function __construct(Google_Client $client)
  45    {
  46      parent::__construct($client);
  47      $this->servicePath = 'apps/reporting/audit/v1/';
  48      $this->version = 'v1';
  49      $this->serviceName = 'audit';
  50  
  51      $this->activities = new Google_Service_Audit_Activities_Resource(
  52          $this,
  53          $this->serviceName,
  54          'activities',
  55          array(
  56            'methods' => array(
  57              'list' => array(
  58                'path' => '{customerId}/{applicationId}',
  59                'httpMethod' => 'GET',
  60                'parameters' => array(
  61                  'customerId' => array(
  62                    'location' => 'path',
  63                    'type' => 'string',
  64                    'required' => true,
  65                  ),
  66                  'applicationId' => array(
  67                    'location' => 'path',
  68                    'type' => 'string',
  69                    'required' => true,
  70                  ),
  71                  'actorEmail' => array(
  72                    'location' => 'query',
  73                    'type' => 'string',
  74                  ),
  75                  'actorApplicationId' => array(
  76                    'location' => 'query',
  77                    'type' => 'string',
  78                  ),
  79                  'actorIpAddress' => array(
  80                    'location' => 'query',
  81                    'type' => 'string',
  82                  ),
  83                  'caller' => array(
  84                    'location' => 'query',
  85                    'type' => 'string',
  86                  ),
  87                  'maxResults' => array(
  88                    'location' => 'query',
  89                    'type' => 'integer',
  90                  ),
  91                  'eventName' => array(
  92                    'location' => 'query',
  93                    'type' => 'string',
  94                  ),
  95                  'startTime' => array(
  96                    'location' => 'query',
  97                    'type' => 'string',
  98                  ),
  99                  'endTime' => array(
 100                    'location' => 'query',
 101                    'type' => 'string',
 102                  ),
 103                  'continuationToken' => array(
 104                    'location' => 'query',
 105                    'type' => 'string',
 106                  ),
 107                ),
 108              ),
 109            )
 110          )
 111      );
 112    }
 113  }
 114  
 115  
 116  /**
 117   * The "activities" collection of methods.
 118   * Typical usage is:
 119   *  <code>
 120   *   $auditService = new Google_Service_Audit(...);
 121   *   $activities = $auditService->activities;
 122   *  </code>
 123   */
 124  class Google_Service_Audit_Activities_Resource extends Google_Service_Resource
 125  {
 126  
 127    /**
 128     * Retrieves a list of activities for a specific customer and application.
 129     * (activities.listActivities)
 130     *
 131     * @param string $customerId
 132     * Represents the customer who is the owner of target object on which action was performed.
 133     * @param string $applicationId
 134     * Application ID of the application on which the event was performed.
 135     * @param array $optParams Optional parameters.
 136     *
 137     * @opt_param string actorEmail
 138     * Email address of the user who performed the action.
 139     * @opt_param string actorApplicationId
 140     * Application ID of the application which interacted on behalf of the user while performing the
 141      * event.
 142     * @opt_param string actorIpAddress
 143     * IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.
 144     * @opt_param string caller
 145     * Type of the caller.
 146     * @opt_param int maxResults
 147     * Number of activity records to be shown in each page.
 148     * @opt_param string eventName
 149     * Name of the event being queried.
 150     * @opt_param string startTime
 151     * Return events which occured at or after this time.
 152     * @opt_param string endTime
 153     * Return events which occured at or before this time.
 154     * @opt_param string continuationToken
 155     * Next page URL.
 156     * @return Google_Service_Audit_Activities
 157     */
 158    public function listActivities($customerId, $applicationId, $optParams = array())
 159    {
 160      $params = array('customerId' => $customerId, 'applicationId' => $applicationId);
 161      $params = array_merge($params, $optParams);
 162      return $this->call('list', array($params), "Google_Service_Audit_Activities");
 163    }
 164  }
 165  
 166  
 167  
 168  
 169  class Google_Service_Audit_Activities extends Google_Collection
 170  {
 171    protected $collection_key = 'items';
 172    protected $itemsType = 'Google_Service_Audit_Activity';
 173    protected $itemsDataType = 'array';
 174    public $kind;
 175    public $next;
 176  
 177    public function setItems($items)
 178    {
 179      $this->items = $items;
 180    }
 181  
 182    public function getItems()
 183    {
 184      return $this->items;
 185    }
 186  
 187    public function setKind($kind)
 188    {
 189      $this->kind = $kind;
 190    }
 191  
 192    public function getKind()
 193    {
 194      return $this->kind;
 195    }
 196  
 197    public function setNext($next)
 198    {
 199      $this->next = $next;
 200    }
 201  
 202    public function getNext()
 203    {
 204      return $this->next;
 205    }
 206  }
 207  
 208  class Google_Service_Audit_Activity extends Google_Collection
 209  {
 210    protected $collection_key = 'events';
 211    protected $actorType = 'Google_Service_Audit_ActivityActor';
 212    protected $actorDataType = '';
 213    protected $eventsType = 'Google_Service_Audit_ActivityEvents';
 214    protected $eventsDataType = 'array';
 215    protected $idType = 'Google_Service_Audit_ActivityId';
 216    protected $idDataType = '';
 217    public $ipAddress;
 218    public $kind;
 219    public $ownerDomain;
 220  
 221    public function setActor(Google_Service_Audit_ActivityActor $actor)
 222    {
 223      $this->actor = $actor;
 224    }
 225  
 226    public function getActor()
 227    {
 228      return $this->actor;
 229    }
 230  
 231    public function setEvents($events)
 232    {
 233      $this->events = $events;
 234    }
 235  
 236    public function getEvents()
 237    {
 238      return $this->events;
 239    }
 240  
 241    public function setId(Google_Service_Audit_ActivityId $id)
 242    {
 243      $this->id = $id;
 244    }
 245  
 246    public function getId()
 247    {
 248      return $this->id;
 249    }
 250  
 251    public function setIpAddress($ipAddress)
 252    {
 253      $this->ipAddress = $ipAddress;
 254    }
 255  
 256    public function getIpAddress()
 257    {
 258      return $this->ipAddress;
 259    }
 260  
 261    public function setKind($kind)
 262    {
 263      $this->kind = $kind;
 264    }
 265  
 266    public function getKind()
 267    {
 268      return $this->kind;
 269    }
 270  
 271    public function setOwnerDomain($ownerDomain)
 272    {
 273      $this->ownerDomain = $ownerDomain;
 274    }
 275  
 276    public function getOwnerDomain()
 277    {
 278      return $this->ownerDomain;
 279    }
 280  }
 281  
 282  class Google_Service_Audit_ActivityActor extends Google_Model
 283  {
 284    public $applicationId;
 285    public $callerType;
 286    public $email;
 287    public $key;
 288  
 289    public function setApplicationId($applicationId)
 290    {
 291      $this->applicationId = $applicationId;
 292    }
 293  
 294    public function getApplicationId()
 295    {
 296      return $this->applicationId;
 297    }
 298  
 299    public function setCallerType($callerType)
 300    {
 301      $this->callerType = $callerType;
 302    }
 303  
 304    public function getCallerType()
 305    {
 306      return $this->callerType;
 307    }
 308  
 309    public function setEmail($email)
 310    {
 311      $this->email = $email;
 312    }
 313  
 314    public function getEmail()
 315    {
 316      return $this->email;
 317    }
 318  
 319    public function setKey($key)
 320    {
 321      $this->key = $key;
 322    }
 323  
 324    public function getKey()
 325    {
 326      return $this->key;
 327    }
 328  }
 329  
 330  class Google_Service_Audit_ActivityEvents extends Google_Collection
 331  {
 332    protected $collection_key = 'parameters';
 333    public $eventType;
 334    public $name;
 335    protected $parametersType = 'Google_Service_Audit_ActivityEventsParameters';
 336    protected $parametersDataType = 'array';
 337  
 338    public function setEventType($eventType)
 339    {
 340      $this->eventType = $eventType;
 341    }
 342  
 343    public function getEventType()
 344    {
 345      return $this->eventType;
 346    }
 347  
 348    public function setName($name)
 349    {
 350      $this->name = $name;
 351    }
 352  
 353    public function getName()
 354    {
 355      return $this->name;
 356    }
 357  
 358    public function setParameters($parameters)
 359    {
 360      $this->parameters = $parameters;
 361    }
 362  
 363    public function getParameters()
 364    {
 365      return $this->parameters;
 366    }
 367  }
 368  
 369  class Google_Service_Audit_ActivityEventsParameters extends Google_Model
 370  {
 371    public $name;
 372    public $value;
 373  
 374    public function setName($name)
 375    {
 376      $this->name = $name;
 377    }
 378  
 379    public function getName()
 380    {
 381      return $this->name;
 382    }
 383  
 384    public function setValue($value)
 385    {
 386      $this->value = $value;
 387    }
 388  
 389    public function getValue()
 390    {
 391      return $this->value;
 392    }
 393  }
 394  
 395  class Google_Service_Audit_ActivityId extends Google_Model
 396  {
 397    public $applicationId;
 398    public $customerId;
 399    public $time;
 400    public $uniqQualifier;
 401  
 402    public function setApplicationId($applicationId)
 403    {
 404      $this->applicationId = $applicationId;
 405    }
 406  
 407    public function getApplicationId()
 408    {
 409      return $this->applicationId;
 410    }
 411  
 412    public function setCustomerId($customerId)
 413    {
 414      $this->customerId = $customerId;
 415    }
 416  
 417    public function getCustomerId()
 418    {
 419      return $this->customerId;
 420    }
 421  
 422    public function setTime($time)
 423    {
 424      $this->time = $time;
 425    }
 426  
 427    public function getTime()
 428    {
 429      return $this->time;
 430    }
 431  
 432    public function setUniqQualifier($uniqQualifier)
 433    {
 434      $this->uniqQualifier = $uniqQualifier;
 435    }
 436  
 437    public function getUniqQualifier()
 438    {
 439      return $this->uniqQualifier;
 440    }
 441  }