google-api-client 0.8.7 → 0.9.pre1

data/generated/google/apis/admin_reports_v1/representations.rb

@@ -0,0 +1,231 @@
+# Copyright 2015 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'date'
+require 'google/apis/core/base_service'
+require 'google/apis/core/json_representation'
+require 'google/apis/core/hashable'
+require 'google/apis/errors'
+
+module Google
+  module Apis
+    module AdminReportsV1
+      
+      class Activities
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      end
+      
+      class Activity
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+        
+        class Actor
+          class Representation < Google::Apis::Core::JsonRepresentation; end
+        end
+        
+        class Event
+          class Representation < Google::Apis::Core::JsonRepresentation; end
+          
+          class Parameter
+            class Representation < Google::Apis::Core::JsonRepresentation; end
+          end
+        end
+        
+        class Id
+          class Representation < Google::Apis::Core::JsonRepresentation; end
+        end
+      end
+      
+      class Channel
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      end
+      
+      class UsageReport
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+        
+        class Entity
+          class Representation < Google::Apis::Core::JsonRepresentation; end
+        end
+        
+        class Parameter
+          class Representation < Google::Apis::Core::JsonRepresentation; end
+        end
+      end
+      
+      class UsageReports
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+        
+        class Warning
+          class Representation < Google::Apis::Core::JsonRepresentation; end
+          
+          class Datum
+            class Representation < Google::Apis::Core::JsonRepresentation; end
+          end
+        end
+      end
+      
+      class Activities
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :etag, as: 'etag'
+          collection :items, as: 'items', class: Google::Apis::AdminReportsV1::Activity, decorator: Google::Apis::AdminReportsV1::Activity::Representation
+      
+          property :kind, as: 'kind'
+          property :next_page_token, as: 'nextPageToken'
+        end
+      end
+      
+      class Activity
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :actor, as: 'actor', class: Google::Apis::AdminReportsV1::Activity::Actor, decorator: Google::Apis::AdminReportsV1::Activity::Actor::Representation
+      
+          property :etag, as: 'etag'
+          collection :events, as: 'events', class: Google::Apis::AdminReportsV1::Activity::Event, decorator: Google::Apis::AdminReportsV1::Activity::Event::Representation
+      
+          property :id, as: 'id', class: Google::Apis::AdminReportsV1::Activity::Id, decorator: Google::Apis::AdminReportsV1::Activity::Id::Representation
+      
+          property :ip_address, as: 'ipAddress'
+          property :kind, as: 'kind'
+          property :owner_domain, as: 'ownerDomain'
+        end
+        
+        class Actor
+          # @private
+          class Representation < Google::Apis::Core::JsonRepresentation
+            property :caller_type, as: 'callerType'
+            property :email, as: 'email'
+            property :key, as: 'key'
+            property :profile_id, as: 'profileId'
+          end
+        end
+        
+        class Event
+          # @private
+          class Representation < Google::Apis::Core::JsonRepresentation
+            property :name, as: 'name'
+            collection :parameters, as: 'parameters', class: Google::Apis::AdminReportsV1::Activity::Event::Parameter, decorator: Google::Apis::AdminReportsV1::Activity::Event::Parameter::Representation
+        
+            property :type, as: 'type'
+          end
+          
+          class Parameter
+            # @private
+            class Representation < Google::Apis::Core::JsonRepresentation
+              property :bool_value, as: 'boolValue'
+              property :int_value, as: 'intValue'
+              collection :multi_int_value, as: 'multiIntValue'
+              collection :multi_value, as: 'multiValue'
+              property :name, as: 'name'
+              property :value, as: 'value'
+            end
+          end
+        end
+        
+        class Id
+          # @private
+          class Representation < Google::Apis::Core::JsonRepresentation
+            property :application_name, as: 'applicationName'
+            property :customer_id, as: 'customerId'
+            property :time, as: 'time', type: DateTime
+        
+            property :unique_qualifier, as: 'uniqueQualifier'
+          end
+        end
+      end
+      
+      class Channel
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :address, as: 'address'
+          property :expiration, as: 'expiration'
+          property :id, as: 'id'
+          property :kind, as: 'kind'
+          hash :params, as: 'params'
+          property :payload, as: 'payload'
+          property :resource_id, as: 'resourceId'
+          property :resource_uri, as: 'resourceUri'
+          property :token, as: 'token'
+          property :type, as: 'type'
+        end
+      end
+      
+      class UsageReport
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :date, as: 'date'
+          property :entity, as: 'entity', class: Google::Apis::AdminReportsV1::UsageReport::Entity, decorator: Google::Apis::AdminReportsV1::UsageReport::Entity::Representation
+      
+          property :etag, as: 'etag'
+          property :kind, as: 'kind'
+          collection :parameters, as: 'parameters', class: Google::Apis::AdminReportsV1::UsageReport::Parameter, decorator: Google::Apis::AdminReportsV1::UsageReport::Parameter::Representation
+      
+        end
+        
+        class Entity
+          # @private
+          class Representation < Google::Apis::Core::JsonRepresentation
+            property :customer_id, as: 'customerId'
+            property :profile_id, as: 'profileId'
+            property :type, as: 'type'
+            property :user_email, as: 'userEmail'
+          end
+        end
+        
+        class Parameter
+          # @private
+          class Representation < Google::Apis::Core::JsonRepresentation
+            property :bool_value, as: 'boolValue'
+            property :datetime_value, as: 'datetimeValue', type: DateTime
+        
+            property :int_value, as: 'intValue'
+            collection :msg_value, as: 'msgValue'
+            property :name, as: 'name'
+            property :string_value, as: 'stringValue'
+          end
+        end
+      end
+      
+      class UsageReports
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :etag, as: 'etag'
+          property :kind, as: 'kind'
+          property :next_page_token, as: 'nextPageToken'
+          collection :usage_reports, as: 'usageReports', class: Google::Apis::AdminReportsV1::UsageReport, decorator: Google::Apis::AdminReportsV1::UsageReport::Representation
+      
+          collection :warnings, as: 'warnings', class: Google::Apis::AdminReportsV1::UsageReports::Warning, decorator: Google::Apis::AdminReportsV1::UsageReports::Warning::Representation
+      
+        end
+        
+        class Warning
+          # @private
+          class Representation < Google::Apis::Core::JsonRepresentation
+            property :code, as: 'code'
+            collection :data, as: 'data', class: Google::Apis::AdminReportsV1::UsageReports::Warning::Datum, decorator: Google::Apis::AdminReportsV1::UsageReports::Warning::Datum::Representation
+        
+            property :message, as: 'message'
+          end
+          
+          class Datum
+            # @private
+            class Representation < Google::Apis::Core::JsonRepresentation
+              property :key, as: 'key'
+              property :value, as: 'value'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/generated/google/apis/admin_reports_v1/service.rb

@@ -0,0 +1,341 @@
+# Copyright 2015 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'google/apis/core/base_service'
+require 'google/apis/core/json_representation'
+require 'google/apis/core/hashable'
+require 'google/apis/errors'
+
+module Google
+  module Apis
+    module AdminReportsV1
+      # Admin Reports API
+      #
+      # Allows the administrators of Google Apps customers to fetch reports about the
+      #  usage, collaboration, security and risk for their users.
+      #
+      # @example
+      #    require 'google/apis/admin_reports_v1'
+      #
+      #    Admin = Google::Apis::AdminReportsV1 # Alias the module
+      #    service = Admin::ReportsService.new
+      #
+      # @see https://developers.google.com/admin-sdk/reports/
+      class ReportsService < Google::Apis::Core::BaseService
+        # @return [String]
+        #  API key. Your API key identifies your project and provides you with API access,
+        #  quota, and reports. Required unless you provide an OAuth 2.0 token.
+        attr_accessor :key
+
+        # @return [String]
+        #  Available to use for quota purposes for server-side applications. Can be any
+        #  arbitrary string assigned to a user, but should not exceed 40 characters.
+        #  Overrides userIp if both are provided.
+        attr_accessor :quota_user
+
+        # @return [String]
+        #  IP address of the site where the request originates. Use this if you want to
+        #  enforce per-user limits.
+        attr_accessor :user_ip
+
+        def initialize
+          super('https://www.googleapis.com/', 'admin/reports/v1/')
+        end
+        
+        # Retrieves a list of activities for a specific customer and application.
+        # @param [String] user_key
+        #   Represents the profile id or the user email for which the data should be
+        #   filtered. When 'all' is specified as the userKey, it returns usageReports for
+        #   all users.
+        # @param [String] application_name
+        #   Application name for which the events are to be retrieved.
+        # @param [String] actor_ip_address
+        #   IP Address of host where the event was performed. Supports both IPv4 and IPv6
+        #   addresses.
+        # @param [String] customer_id
+        #   Represents the customer for which the data is to be fetched.
+        # @param [String] end_time
+        #   Return events which occured at or before this time.
+        # @param [String] event_name
+        #   Name of the event being queried.
+        # @param [String] filters
+        #   Event parameters in the form [parameter1 name][operator][parameter1 value],[
+        #   parameter2 name][operator][parameter2 value],...
+        # @param [Fixnum] max_results
+        #   Number of activity records to be shown in each page.
+        # @param [String] page_token
+        #   Token to specify next page.
+        # @param [String] start_time
+        #   Return events which occured at or after this time.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        #   Overrides userIp if both are provided.
+        # @param [String] user_ip
+        #   IP address of the site where the request originates. Use this if you want to
+        #   enforce per-user limits.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::AdminReportsV1::Activities] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AdminReportsV1::Activities]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def list_activities(user_key, application_name, actor_ip_address: nil, customer_id: nil, end_time: nil, event_name: nil, filters: nil, max_results: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
+          path = 'activity/users/{userKey}/applications/{applicationName}'
+          command =  make_simple_command(:get, path, options)
+          command.response_representation = Google::Apis::AdminReportsV1::Activities::Representation
+          command.response_class = Google::Apis::AdminReportsV1::Activities
+          command.params['userKey'] = user_key unless user_key.nil?
+          command.params['applicationName'] = application_name unless application_name.nil?
+          command.query['actorIpAddress'] = actor_ip_address unless actor_ip_address.nil?
+          command.query['customerId'] = customer_id unless customer_id.nil?
+          command.query['endTime'] = end_time unless end_time.nil?
+          command.query['eventName'] = event_name unless event_name.nil?
+          command.query['filters'] = filters unless filters.nil?
+          command.query['maxResults'] = max_results unless max_results.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['startTime'] = start_time unless start_time.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          command.query['userIp'] = user_ip unless user_ip.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Push changes to activities
+        # @param [String] user_key
+        #   Represents the profile id or the user email for which the data should be
+        #   filtered. When 'all' is specified as the userKey, it returns usageReports for
+        #   all users.
+        # @param [String] application_name
+        #   Application name for which the events are to be retrieved.
+        # @param [Google::Apis::AdminReportsV1::Channel] channel_object
+        # @param [String] actor_ip_address
+        #   IP Address of host where the event was performed. Supports both IPv4 and IPv6
+        #   addresses.
+        # @param [String] customer_id
+        #   Represents the customer for which the data is to be fetched.
+        # @param [String] end_time
+        #   Return events which occured at or before this time.
+        # @param [String] event_name
+        #   Name of the event being queried.
+        # @param [String] filters
+        #   Event parameters in the form [parameter1 name][operator][parameter1 value],[
+        #   parameter2 name][operator][parameter2 value],...
+        # @param [Fixnum] max_results
+        #   Number of activity records to be shown in each page.
+        # @param [String] page_token
+        #   Token to specify next page.
+        # @param [String] start_time
+        #   Return events which occured at or after this time.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        #   Overrides userIp if both are provided.
+        # @param [String] user_ip
+        #   IP address of the site where the request originates. Use this if you want to
+        #   enforce per-user limits.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::AdminReportsV1::Channel] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AdminReportsV1::Channel]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def watch_activity(user_key, application_name, channel_object = nil, actor_ip_address: nil, customer_id: nil, end_time: nil, event_name: nil, filters: nil, max_results: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
+          path = 'activity/users/{userKey}/applications/{applicationName}/watch'
+          command =  make_simple_command(:post, path, options)
+          command.request_representation = Google::Apis::AdminReportsV1::Channel::Representation
+          command.request_object = channel_object
+          command.response_representation = Google::Apis::AdminReportsV1::Channel::Representation
+          command.response_class = Google::Apis::AdminReportsV1::Channel
+          command.params['userKey'] = user_key unless user_key.nil?
+          command.params['applicationName'] = application_name unless application_name.nil?
+          command.query['actorIpAddress'] = actor_ip_address unless actor_ip_address.nil?
+          command.query['customerId'] = customer_id unless customer_id.nil?
+          command.query['endTime'] = end_time unless end_time.nil?
+          command.query['eventName'] = event_name unless event_name.nil?
+          command.query['filters'] = filters unless filters.nil?
+          command.query['maxResults'] = max_results unless max_results.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['startTime'] = start_time unless start_time.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          command.query['userIp'] = user_ip unless user_ip.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Stop watching resources through this channel
+        # @param [Google::Apis::AdminReportsV1::Channel] channel_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        #   Overrides userIp if both are provided.
+        # @param [String] user_ip
+        #   IP address of the site where the request originates. Use this if you want to
+        #   enforce per-user limits.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [NilClass] No result returned for this method
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [void]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def stop_channel(channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
+          path = '/admin/reports_v1/channels/stop'
+          command =  make_simple_command(:post, path, options)
+          command.request_representation = Google::Apis::AdminReportsV1::Channel::Representation
+          command.request_object = channel_object
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          command.query['userIp'] = user_ip unless user_ip.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Retrieves a report which is a collection of properties / statistics for a
+        # specific customer.
+        # @param [String] date
+        #   Represents the date in yyyy-mm-dd format for which the data is to be fetched.
+        # @param [String] customer_id
+        #   Represents the customer for which the data is to be fetched.
+        # @param [String] page_token
+        #   Token to specify next page.
+        # @param [String] parameters
+        #   Represents the application name, parameter name pairs to fetch in csv as
+        #   app_name1:param_name1, app_name2:param_name2.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        #   Overrides userIp if both are provided.
+        # @param [String] user_ip
+        #   IP address of the site where the request originates. Use this if you want to
+        #   enforce per-user limits.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::AdminReportsV1::UsageReports] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AdminReportsV1::UsageReports]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def get_customer_usage_report(date, customer_id: nil, page_token: nil, parameters: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
+          path = 'usage/dates/{date}'
+          command =  make_simple_command(:get, path, options)
+          command.response_representation = Google::Apis::AdminReportsV1::UsageReports::Representation
+          command.response_class = Google::Apis::AdminReportsV1::UsageReports
+          command.params['date'] = date unless date.nil?
+          command.query['customerId'] = customer_id unless customer_id.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['parameters'] = parameters unless parameters.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          command.query['userIp'] = user_ip unless user_ip.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Retrieves a report which is a collection of properties / statistics for a set
+        # of users.
+        # @param [String] user_key
+        #   Represents the profile id or the user email for which the data should be
+        #   filtered.
+        # @param [String] date
+        #   Represents the date in yyyy-mm-dd format for which the data is to be fetched.
+        # @param [String] customer_id
+        #   Represents the customer for which the data is to be fetched.
+        # @param [String] filters
+        #   Represents the set of filters including parameter operator value.
+        # @param [Fixnum] max_results
+        #   Maximum number of results to return. Maximum allowed is 1000
+        # @param [String] page_token
+        #   Token to specify next page.
+        # @param [String] parameters
+        #   Represents the application name, parameter name pairs to fetch in csv as
+        #   app_name1:param_name1, app_name2:param_name2.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        #   Overrides userIp if both are provided.
+        # @param [String] user_ip
+        #   IP address of the site where the request originates. Use this if you want to
+        #   enforce per-user limits.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::AdminReportsV1::UsageReports] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AdminReportsV1::UsageReports]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def get_user_usage_report(user_key, date, customer_id: nil, filters: nil, max_results: nil, page_token: nil, parameters: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
+          path = 'usage/users/{userKey}/dates/{date}'
+          command =  make_simple_command(:get, path, options)
+          command.response_representation = Google::Apis::AdminReportsV1::UsageReports::Representation
+          command.response_class = Google::Apis::AdminReportsV1::UsageReports
+          command.params['userKey'] = user_key unless user_key.nil?
+          command.params['date'] = date unless date.nil?
+          command.query['customerId'] = customer_id unless customer_id.nil?
+          command.query['filters'] = filters unless filters.nil?
+          command.query['maxResults'] = max_results unless max_results.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['parameters'] = parameters unless parameters.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          command.query['userIp'] = user_ip unless user_ip.nil?
+          execute_or_queue_command(command, &block)
+        end
+
+        protected
+
+        def apply_command_defaults(command)
+          command.query['key'] = key unless key.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          command.query['userIp'] = user_ip unless user_ip.nil?
+        end
+      end
+    end
+  end
+end