001/*
002 *   Copyright 2024 Vonage
003 *
004 *   Licensed under the Apache License, Version 2.0 (the "License");
005 *   you may not use this file except in compliance with the License.
006 *   You may obtain a copy of the License at
007 *
008 *        http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *   Unless required by applicable law or agreed to in writing, software
011 *   distributed under the License is distributed on an "AS IS" BASIS,
012 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *   See the License for the specific language governing permissions and
014 *   limitations under the License.
015 */
016package com.vonage.client.auth;
017
018import java.util.Map;
019
020/**
021 * Auth methods that are appended to the request's query parameters.
022 *
023 * @since 8.8.0
024 */
025public interface QueryParamsAuthMethod extends AuthMethod {
026
027    /**
028     * Gets the auth parameters to be included in the query string.
029     *
030     * @param requestParams List of existing request parameters, which may be used in the computation.
031     *
032     * @return A new Map containing only the authentication parameters.
033     */
034    Map<String, String> getAuthParams(RequestQueryParams requestParams);
035}