IReadableConfiguration.mustache

{{>partial_header}}

using System.Collections.Generic;
using Amazon.SellingPartnerAPIAA;

namespace {{packageName}}.Client
{
    /// <summary>
    /// Represents a readable-only configuration contract.
    /// </summary>
    public interface IReadableConfiguration
    {
        /// <summary>
        /// Gets the access token.
        /// </summary>
        /// <value>Access token.</value>
        string AccessToken { get; }

        /// <summary>
        /// Gets the API key.
        /// </summary>
        /// <value>API key.</value>
        IDictionary<string, string> ApiKey { get; }

        /// <summary>
        /// Gets the API key prefix.
        /// </summary>
        /// <value>API key prefix.</value>
        IDictionary<string, string> ApiKeyPrefix { get; }

        /// <summary>
        /// Gets the base path.
        /// </summary>
        /// <value>Base path.</value>
        string BasePath { get; }

        /// <summary>
        /// Gets the date time format.
        /// </summary>
        /// <value>Date time foramt.</value>
        string DateTimeFormat { get; }

        /// <summary>
        /// Gets the default header.
        /// </summary>
        /// <value>Default header.</value>
        IDictionary<string, string> DefaultHeader { get; }

        /// <summary>
        /// Gets the temp folder path.
        /// </summary>
        /// <value>Temp folder path.</value>
        string TempFolderPath { get; }

        /// <summary>
        /// Gets the HTTP connection timeout (in milliseconds)
        /// </summary>
        /// <value>HTTP connection timeout.</value>
        int Timeout { get; }

        /// <summary>
        /// Gets the user agent.
        /// </summary>
        /// <value>User agent.</value>
        string UserAgent { get; }

        /// <summary>
        /// Gets the username.
        /// </summary>
        /// <value>Username.</value>
        string Username { get; }

        /// <summary>
        /// Gets the password.
        /// </summary>
        /// <value>Password.</value>
        string Password { get; }

        /// <summary>
        /// Gets the API key with prefix.
        /// </summary>
        /// <param name="apiKeyIdentifier">API key identifier (authentication scheme).</param>
        /// <returns>API key with prefix.</returns>
        string GetApiKeyWithPrefix(string apiKeyIdentifier);

        /// <summary>
        /// Gets the LWAAuthorizationCredentials for Amazon Selling Partner API Authorization
        /// </summary>
        /// <value>AuthorizationCredentials</value>
        LWAAuthorizationCredentials AuthorizationCredentials { get; }

        /// <summary>
        /// Gets the AWSAuthenticationCredentials for Amazon Selling Partner API Authentication
        /// </summary>
        /// <value>AuthenticationCredentials</value>
        AWSAuthenticationCredentials AuthenticationCredentials { get; }

        /// <summary>
        /// Gets the AWSAuthenticationCredentialsProvider for Amazon Selling Partner API Authentication
        /// </summary>
        /// <value>AWSAuthenticationCredentialsProvider</value>
        AWSAuthenticationCredentialsProvider AuthenticationCredentialsProvider { get; }
    }
}