Public Member Functions
void	SetBasePath (string value)

void	SetClientKey (string value)

void	SetClientSigKey (string value)

void	SetClientApiKey (string value)

void	SetAlgorithm (string value)

	ApiClient ()
	Initializes a new instance of the ApiClient class with default configuration. More...

	ApiClient (Configuration config)
	Initializes a new instance of the ApiClient class with default base path (https://api.orbipay.com/payments/v1). More...

	ApiClient (String basePath="https://api.orbipay.com/payments/v1")
	Initializes a new instance of the ApiClient class with default configuration. More...

	ApiClient (String clientKey, String clientSigKey, String basePath)

Object	CallApi (String path, RestSharp.Method method, List< KeyValuePair< String, String >> queryParams, Object postBody, Dictionary< String, String > headerParams, List< KeyValuePair< String, String >> formParams, Dictionary< String, FileParameter > fileParams, Dictionary< String, String > pathParams, String contentType)
	Makes the HTTP request (Sync). More...

async System.Threading.Tasks.Task < Object >	CallApiAsync (String path, RestSharp.Method method, List< KeyValuePair< String, String >> queryParams, Object postBody, Dictionary< String, String > headerParams, List< KeyValuePair< String, String >> formParams, Dictionary< String, FileParameter > fileParams, Dictionary< String, String > pathParams, String contentType)
	Makes the asynchronous HTTP request. More...

string	EscapeString (string str)
	Escape string (url-encoded). More...

FileParameter	ParameterToFile (string name, Stream stream)
	Create FileParameter based on Stream. More...

string	ParameterToString (object obj)
	If parameter is DateTime, output in a formatted string (default ISO 8601), customizable with Configuration.DateTime. If parameter is a list, join the list with ",". Otherwise just return the string. More...

object	Deserialize (IRestResponse response, Type type)
	Deserialize the JSON string into a proper object. More...

object	DeserializeString (string response, Type type)

String	Serialize (object obj)
	Serialize an input (model) into JSON string More...

bool	IsJsonMime (String mime)
	Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json More...

String	SelectHeaderContentType (String[] contentTypes)
	Select the Content-Type header's value from the given content-type array: if JSON type exists in the given array, use it; otherwise use the first one defined in 'consumes' More...

String	SelectHeaderAccept (String[] accepts)
	Select the Accept header's value from the given accepts array: if JSON exists in the given array, use it; otherwise use all of them (joining into a string) More...

IEnumerable< KeyValuePair < string, string > >	ParameterToKeyValuePairs (string collectionFormat, string name, object value)
	Convert params to key/value pairs. Use collectionFormat to properly format lists and collections. More...

Wrappers.InvocationContext	WrapHeaders (dynamic headers)

Static Public Member Functions
static string	Base64Encode (string text)
	Encode string in base64 format. More...

static dynamic	ConvertType (dynamic fromObject, Type toObject)
	Dynamically cast the object into target type. More...

static byte[]	ReadAsBytes (Stream inputStream)
	Convert stream to byte array More...

static string	UrlEncode (string input)
	URL encode a string Credit/Ref: https://github.com/restsharp/RestSharp/blob/master/RestSharp/Extensions/StringExtensions.cs#L50 More...

static string	SanitizeFilename (string filename)
	Sanitize filename by removing the path More...

Static Public Attributes
static string	UserAgent = "orbipay-paymentsapi-client/1.14.0/csharp"

static ApiClient	Default
	Gets or sets the default API client for making HTTP calls. More...

Properties
IReadableConfiguration	Configuration `[get, set]`
	Gets or sets an instance of the IReadableConfiguration. More...

RestClient	RestClient `[get, set]`
	Gets or sets the RestClient. More...

Detailed Description

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

Constructor & Destructor Documentation

Orbipay.PaymentsApi.Client.Client.ApiClient.ApiClient ( )

Initializes a new instance of the ApiClient class with default configuration.

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

Initializes a new instance of the ApiClient class with default base path (https://api.orbipay.com/payments/v1).

Parameters

config An instance of Configuration.

Orbipay.PaymentsApi.Client.Client.ApiClient.ApiClient ( String basePath = "https://api.orbipay.com/payments/v1" )

Initializes a new instance of the ApiClient class with default configuration.

Parameters

basePath The base path.

Orbipay.PaymentsApi.Client.Client.ApiClient.ApiClient	(	String	clientKey,
		String	clientSigKey,
		String	basePath
	)

Member Function Documentation

static string Orbipay.PaymentsApi.Client.Client.ApiClient.Base64Encode ( string text )

static

Encode string in base64 format.

Parameters

text	String to be encoded.

Returns: Encoded string.

Object Orbipay.PaymentsApi.Client.Client.ApiClient.CallApi	(	String	path,
		RestSharp.Method	method,
		List< KeyValuePair< String, String >>	queryParams,
		Object	postBody,
		Dictionary< String, String >	headerParams,
		List< KeyValuePair< String, String >>	formParams,
		Dictionary< String, FileParameter >	fileParams,
		Dictionary< String, String >	pathParams,
		String	contentType
	)

Makes the HTTP request (Sync).

Parameters

path	URL path.
method	HTTP method.
queryParams	Query parameters.
postBody	HTTP body (POST request).
headerParams	Header parameters.
formParams	Form parameters.
fileParams	File parameters.
pathParams	Path parameters.
contentType	Content Type of the request

Returns: Object

async System.Threading.Tasks.Task<Object> Orbipay.PaymentsApi.Client.Client.ApiClient.CallApiAsync	(	String	path,
		RestSharp.Method	method,
		List< KeyValuePair< String, String >>	queryParams,
		Object	postBody,
		Dictionary< String, String >	headerParams,
		List< KeyValuePair< String, String >>	formParams,
		Dictionary< String, FileParameter >	fileParams,
		Dictionary< String, String >	pathParams,
		String	contentType
	)

Makes the asynchronous HTTP request.

Parameters

path	URL path.
method	HTTP method.
queryParams	Query parameters.
postBody	HTTP body (POST request).
headerParams	Header parameters.
formParams	Form parameters.
fileParams	File parameters.
pathParams	Path parameters.
contentType	Content type.

Returns: The Task instance.

static dynamic Orbipay.PaymentsApi.Client.Client.ApiClient.ConvertType	(	dynamic	fromObject,
		Type	toObject
	)

static

Dynamically cast the object into target type.

Parameters

fromObject	Object to be casted
toObject	Target type

Returns: Casted object

object Orbipay.PaymentsApi.Client.Client.ApiClient.Deserialize	(	IRestResponse	response,
		Type	type
	)

Deserialize the JSON string into a proper object.

Parameters

response	The HTTP response.
type	Object type.

Returns: Object representation of the JSON string.

object Orbipay.PaymentsApi.Client.Client.ApiClient.DeserializeString	(	string	response,
		Type	type
	)

string Orbipay.PaymentsApi.Client.Client.ApiClient.EscapeString ( string str )

Escape string (url-encoded).

Parameters

str	String to be escaped.

Returns: Escaped string.

bool Orbipay.PaymentsApi.Client.Client.ApiClient.IsJsonMime ( String mime )

Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json

Parameters

mime MIME

Returns: Returns True if MIME type is json.

FileParameter Orbipay.PaymentsApi.Client.Client.ApiClient.ParameterToFile	(	string	name,
		Stream	stream
	)

Create FileParameter based on Stream.

Parameters

name	Parameter name.
stream	Input stream.

Returns: FileParameter.

IEnumerable<KeyValuePair<string, string> > Orbipay.PaymentsApi.Client.Client.ApiClient.ParameterToKeyValuePairs	(	string	collectionFormat,
		string	name,
		object	value
	)

Convert params to key/value pairs. Use collectionFormat to properly format lists and collections.

Parameters

name	Key name.
value	Value object.

Returns: A list of KeyValuePairs

string Orbipay.PaymentsApi.Client.Client.ApiClient.ParameterToString ( object obj )

If parameter is DateTime, output in a formatted string (default ISO 8601), customizable with Configuration.DateTime. If parameter is a list, join the list with ",". Otherwise just return the string.

Parameters

obj	The parameter (header, path, query, form).

Returns: Formatted string.

static byte [] Orbipay.PaymentsApi.Client.Client.ApiClient.ReadAsBytes ( Stream inputStream )

static

Convert stream to byte array

Parameters

inputStream Input stream to be converted

Returns: Byte array

static string Orbipay.PaymentsApi.Client.Client.ApiClient.SanitizeFilename ( string filename )

static

Sanitize filename by removing the path

Parameters

filename Filename

Returns: Filename

String Orbipay.PaymentsApi.Client.Client.ApiClient.SelectHeaderAccept ( String[] accepts )

Select the Accept header's value from the given accepts array: if JSON exists in the given array, use it; otherwise use all of them (joining into a string)

Parameters

accepts The accepts array to select from.

Returns: The Accept header to use.

String Orbipay.PaymentsApi.Client.Client.ApiClient.SelectHeaderContentType ( String[] contentTypes )

Select the Content-Type header's value from the given content-type array: if JSON type exists in the given array, use it; otherwise use the first one defined in 'consumes'

Parameters

contentTypes The Content-Type array to select from.

Returns: The Content-Type header to use.

String Orbipay.PaymentsApi.Client.Client.ApiClient.Serialize ( object obj )

Serialize an input (model) into JSON string

Parameters

obj Object.

Returns: JSON string.

void Orbipay.PaymentsApi.Client.Client.ApiClient.SetAlgorithm ( string value )

void Orbipay.PaymentsApi.Client.Client.ApiClient.SetBasePath ( string value )

void Orbipay.PaymentsApi.Client.Client.ApiClient.SetClientApiKey ( string value )

void Orbipay.PaymentsApi.Client.Client.ApiClient.SetClientKey ( string value )

void Orbipay.PaymentsApi.Client.Client.ApiClient.SetClientSigKey ( string value )

static string Orbipay.PaymentsApi.Client.Client.ApiClient.UrlEncode ( string input )

static

URL encode a string Credit/Ref: https://github.com/restsharp/RestSharp/blob/master/RestSharp/Extensions/StringExtensions.cs#L50

Parameters

input String to be URL encoded

Returns: Byte array

Wrappers.InvocationContext Orbipay.PaymentsApi.Client.Client.ApiClient.WrapHeaders ( dynamic headers )

Member Data Documentation

ApiClient Orbipay.PaymentsApi.Client.Client.ApiClient.Default

static

Gets or sets the default API client for making HTTP calls.

The default API client.

string Orbipay.PaymentsApi.Client.Client.ApiClient.UserAgent = "orbipay-paymentsapi-client/1.14.0/csharp"

static

Property Documentation

IReadableConfiguration Orbipay.PaymentsApi.Client.Client.ApiClient.Configuration

getset

Gets or sets an instance of the IReadableConfiguration.

An instance of the IReadableConfiguration.

IReadableConfiguration helps us to avoid modifying possibly global configuration values from within a given client. It does not guarantee thread-safety of the Configuration instance in any way.

RestClient Orbipay.PaymentsApi.Client.Client.ApiClient.RestClient

getset

Gets or sets the RestClient.

An instance of the RestClient

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

src/Orbipay.PaymentsApi.Client/Client/ApiClient.cs

Public Member Functions

Static Public Member Functions

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