# Copyright 2020 Google LLC
#
# 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 MybusinessverificationsV1
      # My Business Verifications API
      #
      # The My Business Verifications API provides an interface for taking
      #  verifications related actions for locations.
      #
      # @example
      #    require 'google/apis/mybusinessverifications_v1'
      #
      #    Mybusinessverifications = Google::Apis::MybusinessverificationsV1 # Alias the module
      #    service = Mybusinessverifications::MyBusinessVerificationsService.new
      #
      # @see https://developers.google.com/my-business/
      class MyBusinessVerificationsService < Google::Apis::Core::BaseService
        DEFAULT_ENDPOINT_TEMPLATE = "https://mybusinessverifications.$UNIVERSE_DOMAIN$/"

        # @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.
        attr_accessor :quota_user

        def initialize
          super(DEFAULT_ENDPOINT_TEMPLATE, '',
                client_name: 'google-apis-mybusinessverifications_v1',
                client_version: Google::Apis::MybusinessverificationsV1::GEM_VERSION)
          @batch_path = 'batch'
        end
        
        # Reports all eligible verification options for a location in a specific
        # language.
        # @param [String] location
        #   Required. The location to verify.
        # @param [Google::Apis::MybusinessverificationsV1::FetchVerificationOptionsRequest] fetch_verification_options_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.
        # @param [Google::Apis::RequestOptions] options
        #   Request-specific options
        #
        # @yield [result, err] Result & error if block supplied
        # @yieldparam result [Google::Apis::MybusinessverificationsV1::FetchVerificationOptionsResponse] parsed result object
        # @yieldparam err [StandardError] error object if request failed
        #
        # @return [Google::Apis::MybusinessverificationsV1::FetchVerificationOptionsResponse]
        #
        # @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 fetch_location_verification_options(location, fetch_verification_options_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
          command = make_simple_command(:post, 'v1/{+location}:fetchVerificationOptions', options)
          command.request_representation = Google::Apis::MybusinessverificationsV1::FetchVerificationOptionsRequest::Representation
          command.request_object = fetch_verification_options_request_object
          command.response_representation = Google::Apis::MybusinessverificationsV1::FetchVerificationOptionsResponse::Representation
          command.response_class = Google::Apis::MybusinessverificationsV1::FetchVerificationOptionsResponse
          command.params['location'] = location unless location.nil?
          command.query['fields'] = fields unless fields.nil?
          command.query['quotaUser'] = quota_user unless quota_user.nil?
          execute_or_queue_command(command, &block)
        end
        
        # Gets the VoiceOfMerchant state.
        # @param [String] name
        #   Required. Resource name of the location.
        # @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.
        # @param [Google::Apis::RequestOptions] options
        #   Request-specific options
        #
        # @yield [result, err] Result & error if block supplied
        # @yieldparam result [Google::Apis::MybusinessverificationsV1::VoiceOfMerchantState] parsed result object
        # @yieldparam err [StandardError] error object if request failed
        #
        # @return [Google::Apis::MybusinessverificationsV1::VoiceOfMerchantState]
        #
        # @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_location_voice_of_merchant_state(name, fields: nil, quota_user: nil, options: nil, &block)
          command = make_simple_command(:get, 'v1/{+name}/VoiceOfMerchantState', options)
          command.response_representation = Google::Apis::MybusinessverificationsV1::VoiceOfMerchantState::Representation
          command.response_class = Google::Apis::MybusinessverificationsV1::VoiceOfMerchantState
          command.params['name'] = name unless name.nil?
          command.query['fields'] = fields unless fields.nil?
          command.query['quotaUser'] = quota_user unless quota_user.nil?
          execute_or_queue_command(command, &block)
        end
        
        # Starts the verification process for a location.
        # @param [String] name
        #   Required. Resource name of the location to verify.
        # @param [Google::Apis::MybusinessverificationsV1::VerifyLocationRequest] verify_location_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.
        # @param [Google::Apis::RequestOptions] options
        #   Request-specific options
        #
        # @yield [result, err] Result & error if block supplied
        # @yieldparam result [Google::Apis::MybusinessverificationsV1::VerifyLocationResponse] parsed result object
        # @yieldparam err [StandardError] error object if request failed
        #
        # @return [Google::Apis::MybusinessverificationsV1::VerifyLocationResponse]
        #
        # @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 verify_location(name, verify_location_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
          command = make_simple_command(:post, 'v1/{+name}:verify', options)
          command.request_representation = Google::Apis::MybusinessverificationsV1::VerifyLocationRequest::Representation
          command.request_object = verify_location_request_object
          command.response_representation = Google::Apis::MybusinessverificationsV1::VerifyLocationResponse::Representation
          command.response_class = Google::Apis::MybusinessverificationsV1::VerifyLocationResponse
          command.params['name'] = name unless name.nil?
          command.query['fields'] = fields unless fields.nil?
          command.query['quotaUser'] = quota_user unless quota_user.nil?
          execute_or_queue_command(command, &block)
        end
        
        # Completes a `PENDING` verification. It is only necessary for non `AUTO`
        # verification methods. `AUTO` verification request is instantly `VERIFIED` upon
        # creation.
        # @param [String] name
        #   Required. Resource name of the verification to complete.
        # @param [Google::Apis::MybusinessverificationsV1::CompleteVerificationRequest] complete_verification_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.
        # @param [Google::Apis::RequestOptions] options
        #   Request-specific options
        #
        # @yield [result, err] Result & error if block supplied
        # @yieldparam result [Google::Apis::MybusinessverificationsV1::CompleteVerificationResponse] parsed result object
        # @yieldparam err [StandardError] error object if request failed
        #
        # @return [Google::Apis::MybusinessverificationsV1::CompleteVerificationResponse]
        #
        # @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 complete_verification(name, complete_verification_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
          command = make_simple_command(:post, 'v1/{+name}:complete', options)
          command.request_representation = Google::Apis::MybusinessverificationsV1::CompleteVerificationRequest::Representation
          command.request_object = complete_verification_request_object
          command.response_representation = Google::Apis::MybusinessverificationsV1::CompleteVerificationResponse::Representation
          command.response_class = Google::Apis::MybusinessverificationsV1::CompleteVerificationResponse
          command.params['name'] = name unless name.nil?
          command.query['fields'] = fields unless fields.nil?
          command.query['quotaUser'] = quota_user unless quota_user.nil?
          execute_or_queue_command(command, &block)
        end
        
        # List verifications of a location, ordered by create time.
        # @param [String] parent
        #   Required. Resource name of the location that verification requests belong to.
        # @param [Fixnum] page_size
        #   How many verification to include per page. Minimum is 1, and the default and
        #   maximum page size is 100.
        # @param [String] page_token
        #   If specified, returns the next page of verifications.
        # @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.
        # @param [Google::Apis::RequestOptions] options
        #   Request-specific options
        #
        # @yield [result, err] Result & error if block supplied
        # @yieldparam result [Google::Apis::MybusinessverificationsV1::ListVerificationsResponse] parsed result object
        # @yieldparam err [StandardError] error object if request failed
        #
        # @return [Google::Apis::MybusinessverificationsV1::ListVerificationsResponse]
        #
        # @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_location_verifications(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
          command = make_simple_command(:get, 'v1/{+parent}/verifications', options)
          command.response_representation = Google::Apis::MybusinessverificationsV1::ListVerificationsResponse::Representation
          command.response_class = Google::Apis::MybusinessverificationsV1::ListVerificationsResponse
          command.params['parent'] = parent unless parent.nil?
          command.query['pageSize'] = page_size unless page_size.nil?
          command.query['pageToken'] = page_token unless page_token.nil?
          command.query['fields'] = fields unless fields.nil?
          command.query['quotaUser'] = quota_user unless quota_user.nil?
          execute_or_queue_command(command, &block)
        end
        
        # Generate a token for the provided location data to verify the location.
        # @param [Google::Apis::MybusinessverificationsV1::GenerateInstantVerificationTokenRequest] generate_instant_verification_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.
        # @param [Google::Apis::RequestOptions] options
        #   Request-specific options
        #
        # @yield [result, err] Result & error if block supplied
        # @yieldparam result [Google::Apis::MybusinessverificationsV1::GenerateInstantVerificationTokenResponse] parsed result object
        # @yieldparam err [StandardError] error object if request failed
        #
        # @return [Google::Apis::MybusinessverificationsV1::GenerateInstantVerificationTokenResponse]
        #
        # @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 generate_verification_token(generate_instant_verification_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
          command = make_simple_command(:post, 'v1/verificationTokens:generate', options)
          command.request_representation = Google::Apis::MybusinessverificationsV1::GenerateInstantVerificationTokenRequest::Representation
          command.request_object = generate_instant_verification_token_request_object
          command.response_representation = Google::Apis::MybusinessverificationsV1::GenerateInstantVerificationTokenResponse::Representation
          command.response_class = Google::Apis::MybusinessverificationsV1::GenerateInstantVerificationTokenResponse
          command.query['fields'] = fields unless fields.nil?
          command.query['quotaUser'] = quota_user unless quota_user.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?
        end
      end
    end
  end
end
