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;
017
018import java.util.Map;
019
020/**
021 * Indicates that a request object has query parameters. This interface
022 * is an internal implementation detail and not part of the SDK's public API.
023 *
024 * @since 7.7.0
025 */
026public interface QueryParamsRequest {
027
028        /**
029         * Internal method for serializing the fields of this class into query parameters.
030         * The Map should be mutable so that subclasses can add fields, otherwise the
031         * method or implementing class should be marked as {@code final}. Duplicate entries
032         * can be handled by mapping the key to a list of the entries.
033         *
034         * @return The query parameters as unique key-value pairs.
035         */
036        Map<String, ?> makeParams();
037}