Inheritance diagram for Orbipay.PaymentsApi.Client.Client.Configuration:

Public Member Functions
	Configuration ()
	Initializes a new instance of the Configuration class More...

	Configuration (IDictionary< string, string > defaultHeader, IDictionary< string, string > apiKey, IDictionary< string, string > apiKeyPrefix, string basePath="https://api.orbipay.com/payments/v1")
	Initializes a new instance of the Configuration class More...

	Configuration (ApiClient apiClient=null, IDictionary< string, string > defaultHeader=null, string username=null, string password=null, string accessToken=null, IDictionary< string, string > apiKey=null, IDictionary< string, string > apiKeyPrefix=null, string tempFolderPath=null, string dateTimeFormat=null, int timeout=100000, string userAgent="orbipay-paymentsapi-client/1.11.0/csharp")
	Initializes a new instance of the Configuration class with different settings More...

	Configuration (ApiClient apiClient)
	Initializes a new instance of the Configuration class. More...

string	GetApiKeyWithPrefix (string apiKeyIdentifier)
	Gets the API key with prefix. More...

void	AddDefaultHeader (string key, string value)
	Add default header. More...

ApiClient	CreateApiClient ()
	Creates a new ApiClient based on this Configuration instance. More...

void	AddApiKey (string key, string value)
	Add Api Key Header. More...

void	AddApiKeyPrefix (string key, string value)
	Sets the API key prefix. More...

Static Public Member Functions
static String	ToDebugReport ()
	Returns a string with essential information for debugging. More...

Public Attributes
const string	Version = "1.11.0"
	Version of the package. More...

const string	ISO8601_DATETIME_FORMAT = "o"
	Identifier for ISO 8601 DateTime Format More...

Static Public Attributes
static readonly ExceptionFactory	DefaultExceptionFactory
	Default creation of exceptions for a given method name and response object More...

Properties
static Configuration	Default `[get, set]`
	Gets or sets the default Configuration. More...

virtual ApiClient	ApiClient `[get]`
	Gets an instance of an ApiClient for this configuration More...

virtual string	BasePath `[get, set]`
	Gets or sets the base path for API access. More...

virtual string	ClientKey `[get, set]`
	Gets or sets the base path for API access. More...

virtual string	ClientSigKey `[get, set]`
	Gets or sets the client key for API access. More...

virtual string	ClientApiKey `[get, set]`
	Gets or sets the base path for API access. More...

virtual string	Algorithm `[get, set]`
	Gets or sets the Algorithm for API access. More...

virtual IDictionary< string, string >	DefaultHeader `[get, set]`
	Gets or sets the default header. More...

virtual int	Timeout `[get, set]`
	Gets or sets the HTTP timeout (milliseconds) of ApiClient. Default to 100000 milliseconds. More...

virtual string	UserAgent `[get, set]`
	Gets or sets the HTTP user agent. More...

virtual string	Username `[get, set]`
	Gets or sets the username (HTTP basic authentication). More...

virtual string	Password `[get, set]`
	Gets or sets the password (HTTP basic authentication). More...

virtual string	AccessToken `[get, set]`
	Gets or sets the access token for OAuth2 authentication. More...

virtual string	TempFolderPath `[get, set]`
	Gets or sets the temporary folder path to store the files downloaded from the server. More...

virtual string	DateTimeFormat `[get, set]`
	Gets or sets the the date time format used when serializing in the ApiClient By default, it's set to ISO 8601 - "o", for others see: https://msdn.microsoft.com/en-us/library/az4se3k1(v=vs.110).aspx and https://msdn.microsoft.com/en-us/library/8kb3ddd4(v=vs.110).aspx No validation is done to ensure that the string you're providing is valid More...

virtual IDictionary< string, string >	ApiKeyPrefix `[get, set]`
	Gets or sets the prefix (e.g. Token) of the API key based on the authentication name. More...

virtual IDictionary< string, string >	ApiKey `[get, set]`
	Gets or sets the API key based on the authentication name. More...

Properties inherited from Orbipay.PaymentsApi.Client.Client.IReadableConfiguration
string	AccessToken `[get]`
	Gets the access token. More...

IDictionary< string, string >	ApiKey `[get]`
	Gets the API key. More...

IDictionary< string, string >	ApiKeyPrefix `[get]`
	Gets the API key prefix. More...

string	BasePath `[get]`
	Gets the base path. More...

string	DateTimeFormat `[get]`
	Gets the date time format. More...

IDictionary< string, string >	DefaultHeader `[get]`
	Gets the default header. More...

string	TempFolderPath `[get]`
	Gets the temp folder path. More...

int	Timeout `[get]`
	Gets the HTTP connection timeout (in milliseconds) More...

string	UserAgent `[get]`
	Gets the user agent. More...

string	Username `[get]`
	Gets the username. More...

string	Password `[get]`
	Gets the password. More...

Detailed Description

This class subject to change without prior notice, Please dont use this class directly.

Constructor & Destructor Documentation

Orbipay.PaymentsApi.Client.Client.Configuration.Configuration ( )

Initializes a new instance of the Configuration class

Orbipay.PaymentsApi.Client.Client.Configuration.Configuration	(	IDictionary< string, string >	defaultHeader,
		IDictionary< string, string >	apiKey,
		IDictionary< string, string >	apiKeyPrefix,
		string	basePath = `"https://api.orbipay.com/payments/v1"`
	)

Initializes a new instance of the Configuration class

Orbipay.PaymentsApi.Client.Client.Configuration.Configuration	(	ApiClient	apiClient = `null`,
		IDictionary< string, string >	defaultHeader = `null`,
		string	username = `null`,
		string	password = `null`,
		string	accessToken = `null`,
		IDictionary< string, string >	apiKey = `null`,
		IDictionary< string, string >	apiKeyPrefix = `null`,
		string	tempFolderPath = `null`,
		string	dateTimeFormat = `null`,
		int	timeout = `100000`,
		string	userAgent = `"orbipay-paymentsapi-client/1.11.0/csharp"`
	)

Initializes a new instance of the Configuration class with different settings

Parameters

apiClient	Api client
defaultHeader	Dictionary of default HTTP header
username	Username
password	Password
accessToken	accessToken
apiKey	Dictionary of API key
apiKeyPrefix	Dictionary of API key prefix
tempFolderPath	Temp folder path
dateTimeFormat	DateTime format string
timeout	HTTP connection timeout (in milliseconds)
userAgent	HTTP user agent

Orbipay.PaymentsApi.Client.Client.Configuration.Configuration ( ApiClient apiClient )

Initializes a new instance of the Configuration class.

Parameters

apiClient Api client.

Member Function Documentation

void Orbipay.PaymentsApi.Client.Client.Configuration.AddApiKey	(	string	key,
		string	value
	)

Add Api Key Header.

Parameters

key	Api Key name.
value	Api Key value.

Returns

void Orbipay.PaymentsApi.Client.Client.Configuration.AddApiKeyPrefix	(	string	key,
		string	value
	)

Sets the API key prefix.

Parameters

key	Api Key name.
value	Api Key value.

void Orbipay.PaymentsApi.Client.Client.Configuration.AddDefaultHeader	(	string	key,
		string	value
	)

Add default header.

Parameters

key	Header field name.
value	Header field value.

Returns

ApiClient Orbipay.PaymentsApi.Client.Client.Configuration.CreateApiClient ( )

Creates a new ApiClient based on this Configuration instance.

Returns

string Orbipay.PaymentsApi.Client.Client.Configuration.GetApiKeyWithPrefix ( string apiKeyIdentifier )

Gets the API key with prefix.

Parameters

apiKeyIdentifier API key identifier (authentication scheme).

Returns: API key with prefix.

Implements Orbipay.PaymentsApi.Client.Client.IReadableConfiguration.

static String Orbipay.PaymentsApi.Client.Client.Configuration.ToDebugReport ( )

static

Returns a string with essential information for debugging.

Member Data Documentation

readonly ExceptionFactory Orbipay.PaymentsApi.Client.Client.Configuration.DefaultExceptionFactory

static

Initial value:

= (methodName, response, headers) =>
        {
            var status = (int)response.StatusCode;
            if (status >= 400)
            {
                return new ApiException(status, response.StatusDescription, response.Content, headers);
            }
            if (status == 0)
            {
        if (response.ErrorException.GetBaseException() is System.Net.Sockets.SocketException || response.ErrorException.GetBaseException() is System.Net.WebException)
                {
                    log.Warn(response.ErrorMessage);
                    return new ApiException(status, response.ErrorMessage, null, headers, true);
                }
                return new ApiException(status,
                    string.Format("Error calling {0}: {1}", methodName, response.ErrorMessage), response.ErrorMessage, headers);
            }
            return null;
        }

Default creation of exceptions for a given method name and response object

const string Orbipay.PaymentsApi.Client.Client.Configuration.ISO8601_DATETIME_FORMAT = "o"

Identifier for ISO 8601 DateTime Format

See https://msdn.microsoft.com/en-us/library/az4se3k1(v=vs.110).aspx#Anchor_8 for more information.

const string Orbipay.PaymentsApi.Client.Client.Configuration.Version = "1.11.0"

Version of the package.

Property Documentation

virtual string Orbipay.PaymentsApi.Client.Client.Configuration.AccessToken

getset

Gets or sets the access token for OAuth2 authentication.

The access token.

virtual string Orbipay.PaymentsApi.Client.Client.Configuration.Algorithm

getset

Gets or sets the Algorithm for API access.

virtual ApiClient Orbipay.PaymentsApi.Client.Client.Configuration.ApiClient

get

Gets an instance of an ApiClient for this configuration

virtual IDictionary<string, string> Orbipay.PaymentsApi.Client.Client.Configuration.ApiKey

getset

Gets or sets the API key based on the authentication name.

The API key.

virtual IDictionary<string, string> Orbipay.PaymentsApi.Client.Client.Configuration.ApiKeyPrefix

getset

Gets or sets the prefix (e.g. Token) of the API key based on the authentication name.

The prefix of the API key.

virtual string Orbipay.PaymentsApi.Client.Client.Configuration.BasePath

getset

Gets or sets the base path for API access.

virtual string Orbipay.PaymentsApi.Client.Client.Configuration.ClientApiKey

getset

Gets or sets the base path for API access.

virtual string Orbipay.PaymentsApi.Client.Client.Configuration.ClientKey

getset

Gets or sets the base path for API access.

virtual string Orbipay.PaymentsApi.Client.Client.Configuration.ClientSigKey

getset

Gets or sets the client key for API access.

virtual string Orbipay.PaymentsApi.Client.Client.Configuration.DateTimeFormat

getset

Gets or sets the the date time format used when serializing in the ApiClient By default, it's set to ISO 8601 - "o", for others see: https://msdn.microsoft.com/en-us/library/az4se3k1(v=vs.110).aspx and https://msdn.microsoft.com/en-us/library/8kb3ddd4(v=vs.110).aspx No validation is done to ensure that the string you're providing is valid

The DateTimeFormat string

Configuration Orbipay.PaymentsApi.Client.Client.Configuration.Default

staticgetset

Gets or sets the default Configuration.

Configuration.

virtual IDictionary<string, string> Orbipay.PaymentsApi.Client.Client.Configuration.DefaultHeader

getset

Gets or sets the default header.

virtual string Orbipay.PaymentsApi.Client.Client.Configuration.Password

getset

Gets or sets the password (HTTP basic authentication).

The password.

virtual string Orbipay.PaymentsApi.Client.Client.Configuration.TempFolderPath

getset

Gets or sets the temporary folder path to store the files downloaded from the server.

Folder path.

virtual int Orbipay.PaymentsApi.Client.Client.Configuration.Timeout

getset

Gets or sets the HTTP timeout (milliseconds) of ApiClient. Default to 100000 milliseconds.

virtual string Orbipay.PaymentsApi.Client.Client.Configuration.UserAgent

getset

Gets or sets the HTTP user agent.

Http user agent.

virtual string Orbipay.PaymentsApi.Client.Client.Configuration.Username

getset

Gets or sets the username (HTTP basic authentication).

The username.

The documentation for this class was generated from the following file:

src/Orbipay.PaymentsApi.Client/Client/Configuration.cs

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Properties

Detailed Description

This class subject to change without prior notice, Please dont use this class directly.

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation