google-api-client 0.8.6 → 0.9

data/generated/google/apis/oauth2_v2.rb

@@ -0,0 +1,43 @@
+# 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/oauth2_v2/service.rb'
+require 'google/apis/oauth2_v2/classes.rb'
+require 'google/apis/oauth2_v2/representations.rb'
+
+module Google
+  module Apis
+    # Google OAuth2 API
+    #
+    # Lets you access OAuth2 protocol related APIs.
+    #
+    # @see https://developers.google.com/accounts/docs/OAuth2
+    module Oauth2V2
+      VERSION = 'V2'
+      REVISION = '20151215'
+
+      # Know your basic profile info and list of people in your circles.
+      AUTH_PLUS_LOGIN = 'https://www.googleapis.com/auth/plus.login'
+
+      # Know who you are on Google
+      AUTH_PLUS_ME = 'https://www.googleapis.com/auth/plus.me'
+
+      # View your email address
+      AUTH_USERINFO_EMAIL = 'https://www.googleapis.com/auth/userinfo.email'
+
+      # View your basic profile info
+      AUTH_USERINFO_PROFILE = 'https://www.googleapis.com/auth/userinfo.profile'
+    end
+  end
+end

data/generated/google/apis/oauth2_v2/classes.rb

@@ -0,0 +1,245 @@
+# 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 Oauth2V2
+      
+      # 
+      class Jwk
+        include Google::Apis::Core::Hashable
+      
+        # 
+        # Corresponds to the JSON property `keys`
+        # @return [Array<Google::Apis::Oauth2V2::Jwk::Key>]
+        attr_accessor :keys
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @keys = args[:keys] unless args[:keys].nil?
+        end
+        
+        # 
+        class Key
+          include Google::Apis::Core::Hashable
+        
+          # 
+          # Corresponds to the JSON property `alg`
+          # @return [String]
+          attr_accessor :alg
+        
+          # 
+          # Corresponds to the JSON property `e`
+          # @return [String]
+          attr_accessor :e
+        
+          # 
+          # Corresponds to the JSON property `kid`
+          # @return [String]
+          attr_accessor :kid
+        
+          # 
+          # Corresponds to the JSON property `kty`
+          # @return [String]
+          attr_accessor :kty
+        
+          # 
+          # Corresponds to the JSON property `n`
+          # @return [String]
+          attr_accessor :n
+        
+          # 
+          # Corresponds to the JSON property `use`
+          # @return [String]
+          attr_accessor :use
+        
+          def initialize(**args)
+             update!(**args)
+          end
+        
+          # Update properties of this object
+          def update!(**args)
+            @alg = args[:alg] unless args[:alg].nil?
+            @e = args[:e] unless args[:e].nil?
+            @kid = args[:kid] unless args[:kid].nil?
+            @kty = args[:kty] unless args[:kty].nil?
+            @n = args[:n] unless args[:n].nil?
+            @use = args[:use] unless args[:use].nil?
+          end
+        end
+      end
+      
+      # 
+      class Tokeninfo
+        include Google::Apis::Core::Hashable
+      
+        # The access type granted with this token. It can be offline or online.
+        # Corresponds to the JSON property `access_type`
+        # @return [String]
+        attr_accessor :access_type
+      
+        # Who is the intended audience for this token. In general the same as issued_to.
+        # Corresponds to the JSON property `audience`
+        # @return [String]
+        attr_accessor :audience
+      
+        # The email address of the user. Present only if the email scope is present in
+        # the request.
+        # Corresponds to the JSON property `email`
+        # @return [String]
+        attr_accessor :email
+      
+        # The expiry time of the token, as number of seconds left until expiry.
+        # Corresponds to the JSON property `expires_in`
+        # @return [Fixnum]
+        attr_accessor :expires_in
+      
+        # To whom was the token issued to. In general the same as audience.
+        # Corresponds to the JSON property `issued_to`
+        # @return [String]
+        attr_accessor :issued_to
+      
+        # The space separated list of scopes granted to this token.
+        # Corresponds to the JSON property `scope`
+        # @return [String]
+        attr_accessor :scope
+      
+        # The token handle associated with this token.
+        # Corresponds to the JSON property `token_handle`
+        # @return [String]
+        attr_accessor :token_handle
+      
+        # The obfuscated user id.
+        # Corresponds to the JSON property `user_id`
+        # @return [String]
+        attr_accessor :user_id
+      
+        # Boolean flag which is true if the email address is verified. Present only if
+        # the email scope is present in the request.
+        # Corresponds to the JSON property `verified_email`
+        # @return [Boolean]
+        attr_accessor :verified_email
+        alias_method :verified_email?, :verified_email
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @access_type = args[:access_type] unless args[:access_type].nil?
+          @audience = args[:audience] unless args[:audience].nil?
+          @email = args[:email] unless args[:email].nil?
+          @expires_in = args[:expires_in] unless args[:expires_in].nil?
+          @issued_to = args[:issued_to] unless args[:issued_to].nil?
+          @scope = args[:scope] unless args[:scope].nil?
+          @token_handle = args[:token_handle] unless args[:token_handle].nil?
+          @user_id = args[:user_id] unless args[:user_id].nil?
+          @verified_email = args[:verified_email] unless args[:verified_email].nil?
+        end
+      end
+      
+      # 
+      class Userinfoplus
+        include Google::Apis::Core::Hashable
+      
+        # The user's email address.
+        # Corresponds to the JSON property `email`
+        # @return [String]
+        attr_accessor :email
+      
+        # The user's last name.
+        # Corresponds to the JSON property `family_name`
+        # @return [String]
+        attr_accessor :family_name
+      
+        # The user's gender.
+        # Corresponds to the JSON property `gender`
+        # @return [String]
+        attr_accessor :gender
+      
+        # The user's first name.
+        # Corresponds to the JSON property `given_name`
+        # @return [String]
+        attr_accessor :given_name
+      
+        # The hosted domain e.g. example.com if the user is Google apps user.
+        # Corresponds to the JSON property `hd`
+        # @return [String]
+        attr_accessor :hd
+      
+        # The obfuscated ID of the user.
+        # Corresponds to the JSON property `id`
+        # @return [String]
+        attr_accessor :id
+      
+        # URL of the profile page.
+        # Corresponds to the JSON property `link`
+        # @return [String]
+        attr_accessor :link
+      
+        # The user's preferred locale.
+        # Corresponds to the JSON property `locale`
+        # @return [String]
+        attr_accessor :locale
+      
+        # The user's full name.
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # URL of the user's picture image.
+        # Corresponds to the JSON property `picture`
+        # @return [String]
+        attr_accessor :picture
+      
+        # Boolean flag which is true if the email address is verified. Always verified
+        # because we only return the user's primary email address.
+        # Corresponds to the JSON property `verified_email`
+        # @return [Boolean]
+        attr_accessor :verified_email
+        alias_method :verified_email?, :verified_email
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @email = args[:email] unless args[:email].nil?
+          @family_name = args[:family_name] unless args[:family_name].nil?
+          @gender = args[:gender] unless args[:gender].nil?
+          @given_name = args[:given_name] unless args[:given_name].nil?
+          @hd = args[:hd] unless args[:hd].nil?
+          @id = args[:id] unless args[:id].nil?
+          @link = args[:link] unless args[:link].nil?
+          @locale = args[:locale] unless args[:locale].nil?
+          @name = args[:name] unless args[:name].nil?
+          @picture = args[:picture] unless args[:picture].nil?
+          @verified_email = args[:verified_email] unless args[:verified_email].nil?
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,94 @@
+# 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 Oauth2V2
+      
+      class Jwk
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+        
+        class Key
+          class Representation < Google::Apis::Core::JsonRepresentation; end
+        end
+      end
+      
+      class Tokeninfo
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      end
+      
+      class Userinfoplus
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      end
+      
+      class Jwk
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :keys, as: 'keys', class: Google::Apis::Oauth2V2::Jwk::Key, decorator: Google::Apis::Oauth2V2::Jwk::Key::Representation
+      
+        end
+        
+        class Key
+          # @private
+          class Representation < Google::Apis::Core::JsonRepresentation
+            property :alg, as: 'alg'
+            property :e, as: 'e'
+            property :kid, as: 'kid'
+            property :kty, as: 'kty'
+            property :n, as: 'n'
+            property :use, as: 'use'
+          end
+        end
+      end
+      
+      class Tokeninfo
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :access_type, as: 'access_type'
+          property :audience, as: 'audience'
+          property :email, as: 'email'
+          property :expires_in, as: 'expires_in'
+          property :issued_to, as: 'issued_to'
+          property :scope, as: 'scope'
+          property :token_handle, as: 'token_handle'
+          property :user_id, as: 'user_id'
+          property :verified_email, as: 'verified_email'
+        end
+      end
+      
+      class Userinfoplus
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :email, as: 'email'
+          property :family_name, as: 'family_name'
+          property :gender, as: 'gender'
+          property :given_name, as: 'given_name'
+          property :hd, as: 'hd'
+          property :id, as: 'id'
+          property :link, as: 'link'
+          property :locale, as: 'locale'
+          property :name, as: 'name'
+          property :picture, as: 'picture'
+          property :verified_email, as: 'verified_email'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,199 @@
+# 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 Oauth2V2
+      # Google OAuth2 API
+      #
+      # Lets you access OAuth2 protocol related APIs.
+      #
+      # @example
+      #    require 'google/apis/oauth2_v2'
+      #
+      #    Oauth2 = Google::Apis::Oauth2V2 # Alias the module
+      #    service = Oauth2::Oauth2Service.new
+      #
+      # @see https://developers.google.com/accounts/docs/OAuth2
+      class Oauth2Service < 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/', '')
+        end
+        
+        # 
+        # @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::Oauth2V2::Jwk] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::Oauth2V2::Jwk]
+        #
+        # @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_cert_for_open_id_connect(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
+          command =  make_simple_command(:get, 'oauth2/v2/certs', options)
+          command.response_representation = Google::Apis::Oauth2V2::Jwk::Representation
+          command.response_class = Google::Apis::Oauth2V2::Jwk
+          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
+        
+        # 
+        # @param [String] access_token
+        # @param [String] id_token
+        # @param [String] token_handle
+        # @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::Oauth2V2::Tokeninfo] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::Oauth2V2::Tokeninfo]
+        #
+        # @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 tokeninfo(access_token: nil, id_token: nil, token_handle: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
+          command =  make_simple_command(:post, 'oauth2/v2/tokeninfo', options)
+          command.response_representation = Google::Apis::Oauth2V2::Tokeninfo::Representation
+          command.response_class = Google::Apis::Oauth2V2::Tokeninfo
+          command.query['access_token'] = access_token unless access_token.nil?
+          command.query['id_token'] = id_token unless id_token.nil?
+          command.query['token_handle'] = token_handle unless token_handle.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
+        
+        # 
+        # @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::Oauth2V2::Userinfoplus] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::Oauth2V2::Userinfoplus]
+        #
+        # @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_userinfo(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
+          command =  make_simple_command(:get, 'oauth2/v2/userinfo', options)
+          command.response_representation = Google::Apis::Oauth2V2::Userinfoplus::Representation
+          command.response_class = Google::Apis::Oauth2V2::Userinfoplus
+          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
+        
+        # 
+        # @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::Oauth2V2::Userinfoplus] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::Oauth2V2::Userinfoplus]
+        #
+        # @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_userinfo_v2(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
+          command =  make_simple_command(:get, 'userinfo/v2/me', options)
+          command.response_representation = Google::Apis::Oauth2V2::Userinfoplus::Representation
+          command.response_class = Google::Apis::Oauth2V2::Userinfoplus
+          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