# 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 SiteVerificationV1 # Google Site Verification API # # Lets you programatically verify ownership of websites or domains with Google. # # @example # require 'google/apis/site_verification_v1' # # SiteVerification = Google::Apis::SiteVerificationV1 # Alias the module # service = SiteVerification::SiteVerificationService.new # # @see https://developers.google.com/site-verification/ class SiteVerificationService < 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/', 'siteVerification/v1/') end # Relinquish ownership of a website or domain. # @param [String] id # The id of a verified site or domain. # @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 delete_web_resource(id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'webResource/{id}' command = make_simple_command(:delete, path, options) command.params['id'] = id unless id.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 # Get the most current data for a website or domain. # @param [String] id # The id of a verified site or domain. # @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::SiteVerificationV1::SiteVerificationWebResourceResource] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource] # # @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_web_resource(id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'webResource/{id}' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Representation command.response_class = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource command.params['id'] = id unless id.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 # Get a verification token for placing on a website or domain. # @param [Google::Apis::SiteVerificationV1::GetWebResourceTokenRequest] get_web_resource_token_request_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 [Google::Apis::SiteVerificationV1::GetWebResourceTokenResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SiteVerificationV1::GetWebResourceTokenResponse] # # @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_token_web_resource(get_web_resource_token_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'token' command = make_simple_command(:post, path, options) command.request_representation = Google::Apis::SiteVerificationV1::GetWebResourceTokenRequest::Representation command.request_object = get_web_resource_token_request_object command.response_representation = Google::Apis::SiteVerificationV1::GetWebResourceTokenResponse::Representation command.response_class = Google::Apis::SiteVerificationV1::GetWebResourceTokenResponse 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 # Attempt verification of a website or domain. # @param [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource] site_verification_web_resource_resource_object # @param [String] verification_method # The method to use for verifying a site or domain. # @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::SiteVerificationV1::SiteVerificationWebResourceResource] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource] # # @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 insert_web_resource(site_verification_web_resource_resource_object = nil, verification_method: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'webResource' command = make_simple_command(:post, path, options) command.request_representation = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Representation command.request_object = site_verification_web_resource_resource_object command.response_representation = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Representation command.response_class = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource command.query['verificationMethod'] = verification_method unless verification_method.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 # Get the list of your verified websites and domains. # @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::SiteVerificationV1::ListWebResourceResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SiteVerificationV1::ListWebResourceResponse] # # @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_web_resources(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'webResource' command = make_simple_command(:get, path, options) command.response_representation = Google::Apis::SiteVerificationV1::ListWebResourceResponse::Representation command.response_class = Google::Apis::SiteVerificationV1::ListWebResourceResponse 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 # Modify the list of owners for your website or domain. This method supports # patch semantics. # @param [String] id # The id of a verified site or domain. # @param [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource] site_verification_web_resource_resource_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 [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource] # # @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 patch_web_resource(id, site_verification_web_resource_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'webResource/{id}' command = make_simple_command(:patch, path, options) command.request_representation = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Representation command.request_object = site_verification_web_resource_resource_object command.response_representation = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Representation command.response_class = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource command.params['id'] = id unless id.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 # Modify the list of owners for your website or domain. # @param [String] id # The id of a verified site or domain. # @param [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource] site_verification_web_resource_resource_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 [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource] # # @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 update_web_resource(id, site_verification_web_resource_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) path = 'webResource/{id}' command = make_simple_command(:put, path, options) command.request_representation = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Representation command.request_object = site_verification_web_resource_resource_object command.response_representation = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Representation command.response_class = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource command.params['id'] = id unless id.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