/* SPDX-License-Identifier: Apache-2.0
*
* The OpenSearch Contributors require contributions made to
* this file be licensed under the Apache-2.0 license or a
* compatible open source license.
*/
/*
* Modifications Copyright OpenSearch Contributors. See
* GitHub history for details.
*
*  Licensed to Elasticsearch B.V. under one or more contributor
*  license agreements. See the NOTICE file distributed with
*  this work for additional information regarding copyright
*  ownership. Elasticsearch B.V. licenses this file to you 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.
*/

using System.Collections.Generic;

// ReSharper disable once CheckNamespace
namespace OpenSearch.Net
{
	public interface IRequestParameters
	{
		HttpMethod DefaultHttpMethod { get; }

		bool SupportsBody { get; }

		/// <summary> Allows you to completely circumvent the serializer to build the final response.</summary>
		CustomResponseBuilderBase CustomResponseBuilder { get; set; }

		/// <summary>
		/// The querystring that should be appended to the path of the request
		/// </summary>
		Dictionary<string, object> QueryString { get; set; }

		/// <summary>
		/// Configuration for this specific request, i.e disable sniffing, custom timeouts etcetera.
		/// </summary>
		IRequestConfiguration RequestConfiguration { get; set; }

		/// <summary> Sets a query string param. If <paramref name="value" /> is null and the parameter exists it will be removed </summary>
		/// <param name="name">The query string parameter to add</param>
		/// <param name="value">The value to set, if null removes <paramref name="name" /> from the query string if it exists</param>
		void SetQueryString(string name, object value);

		bool ContainsQueryString(string name);

		/// <summary>
		/// Get's the value as its stored on the querystring using its original type
		/// </summary>
		TOut GetQueryStringValue<TOut>(string name);

		/// <summary>
		/// Gets the stringified representation of a query string value as it would be sent to OpenSearch.
		/// </summary>
		string GetResolvedQueryStringValue(string n, IConnectionConfigurationValues s);

		/// <summary>
		/// Gets the HTTP Accept Header value from the shortened name. If the shortened name is not recognized,
		/// <c>null</c> is returned.
		/// </summary>
		string AcceptHeaderFromFormat(string format);
	}
}