API client is mainly responsible for making the HTTP call to the API backend. More...

Inheritance diagram for DocuSign.eSign.Client.ApiClient:

Public Member Functions
	ApiClient ()
	Initializes a new instance of the ApiClient class with default configuration and base path (https://demo.docusign.net/restapi). More...

	ApiClient (Configuration configuration)
	Initializes a new instance of the ApiClient class with default base path (https://demo.docusign.net/restapi). More...

	ApiClient (String apiBase, IWebProxy proxy=null)
	Initializes a new instance of the ApiClient class with default configuration. More...

	ApiClient (String apiBase, String oAuthBase, IWebProxy proxy=null)
	Initializes a new instance of the ApiClient class with default configuration. More...

Public Member Functions inherited from DocuSign.eSign.Client.DocuSignClient
virtual void	InterceptRequest (DocuSignRequest request)
	Allows for extending request processing for DocuSignClient generated code. More...

virtual void	InterceptResponse (DocuSignRequest request, DocuSignResponse response)
	Allows for extending response processing for DocuSignClient generated code. More...

	DocuSignClient ()
	Initializes a new instance of DocuSignClient with default with default base path (https://demo.docusign.net/restapi). More...

	DocuSignClient (Configuration configuration)
	Initializes a new instance of DocuSignClient using the provided configuration with the default base path (https://demo.docusign.net/restapi). More...

	DocuSignClient (String apiBase, IWebProxy proxy=null)
	Initializes a new instance of DocuSignClient configured with the provided API base path and optional IWebProxy object More...

	DocuSignClient (String apiBase, String oAuthBase, IWebProxy proxy=null)
	Initializes a new instance of DocuSignClient with the provided API base path, OAuth base path, and optional IWebProxy object More...

	DocuSignClient (string apiBase, HttpClient apiClient)
	Initializes a new instance of DocuSignClient with the provided API base path and pre-configured HttpClient object More...

	DocuSignClient (string apiBase, IHttpClient client)
	Initializes a new instance of DocuSignClient with the provided API base path and pre-configured IHttpClient object More...

String	GetBasePath ()

DocuSignRequest	PrepareOAuthRequest (string oAuthBasePath, string path, HttpMethod method, List< KeyValuePair< string, string >> headerParams=null, List< KeyValuePair< string, string >> formParams=null)

DocuSignRequest	PrepareRequest (string path, HttpMethod method, List< KeyValuePair< string, string >> queryParams=null, object postBody=null, List< KeyValuePair< string, string >> headerParams=null, List< KeyValuePair< string, string >> formParams=null, List< KeyValuePair< string, string >> pathParams=null, List< FileParameter > fileParams=null, string contentType=null, string contentDisposition=null)

DocuSignResponse	CallApi (DocuSignRequest request)

async Task< DocuSignResponse >	CallApiAsync (DocuSignRequest request)

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 (DocuSignResponse response, Type type)
	Deserialize the JSON string into a proper object. More...

String	Serialize (object obj, string contentType="application/json")
	Serialize an input (model) into JSON string More...

String	SelectHeaderContentType (String[] contentTypes)
	Select the Content-Type header's value from the given content-type array: if JSON 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...

Uri	GetAuthorizationUri (string clientId, List< string > scopes, string redirectUri, string responseType, string state=null)
	Helper method to configure the OAuth accessCode/implicit flow parameters More...

void	SetBasePath (string basePath)
	Use this method to Set Base Path More...

void	SetOAuthBasePath (string oauthBaseUri=null)
	Use this method to set custom OAuth Base Path. More...

OAuth.OAuthToken	GenerateAccessToken (string clientId, string clientSecret, string code)
	GenerateAccessToken will exchange the authorization code for an access token and refresh tokens. More...

async Task< OAuth.OAuthToken >	GenerateAccessTokenAsync (string clientId, string clientSecret, string code, CancellationToken cancellationToken)
	GenerateAccessTokenAsync will exchange the authorization code for an access token and refresh tokens. More...

OAuth.UserInfo	GetUserInfo (string accessToken)
	GetUserInfo method takes the accessToken to retrieve User Account Data. More...

async Task< OAuth.UserInfo >	GetUserInfoAsync (string accessToken, CancellationToken cancellationToken)
	GetUserInfoAsync method takes the accessToken to retrieve User Account Data. More...

OAuth.OAuthToken	RequestJWTUserToken (string clientId, string userId, string oauthBasePath, Stream privateKeyStream, int expiresInHours, List< string > scopes=null)
	RequestJWTUserToken Configures the current instance of ApiClient with a fresh OAuth JWT access token from Docusign More...

Task< OAuth.OAuthToken >	RequestJWTUserTokenAsync (string clientId, string userId, string oauthBasePath, Stream privateKeyStream, int expiresInHours, List< string > scopes=null, CancellationToken cancellationToken=default)
	RequestJWTUserTokenAsync Configures the current instance of ApiClient with a fresh OAuth JWT access token from Docusign More...

OAuth.OAuthToken	RequestJWTUserToken (string clientId, string userId, string oauthBasePath, byte[] privateKeyBytes, int expiresInHours, List< string > scopes=null)
	RequestJWTUserToken Configures the current instance of ApiClient with a fresh OAuth JWT access token from Docusign More...

async Task< OAuth.OAuthToken >	RequestJWTUserTokenAsync (string clientId, string userId, string oauthBasePath, byte[] privateKeyBytes, int expiresInHours, List< string > scopes=null, CancellationToken cancellationToken=default)
	RequestJWTUserTokenAsync Configures the current instance of ApiClient with a fresh OAuth JWT access token from Docusign More...

OAuth.OAuthToken	RequestJWTApplicationToken (string clientId, string oauthBasePath, byte[] privateKeyBytes, int expiresInHours, List< string > scopes=null)
	RESERVED FOR PARTNERS RequestJWTApplicationToken More...

async Task< OAuth.OAuthToken >	RequestJWTApplicationTokenAsync (string clientId, string oauthBasePath, byte[] privateKeyBytes, int expiresInHours, List< string > scopes=null, CancellationToken cancellationToken=default)
	RESERVED FOR PARTNERS RequestJWTApplicationTokenAsync More...

Additional Inherited Members
Static Public Member Functions inherited from DocuSign.eSign.Client.DocuSignClient
static String	SerializeCsvToString (object obj)
	SerializeCsvToString - Interim method to Serialize the Request Object to CSV format More...

static String	SerializeCsvToString< T > (List< T > obj)
	SerializeCsvToString - Interim method to Serialize the Request Object to CSV format More...

static string	Base64Encode (string text)
	Encode string in base64 format. More...

static dynamic	ConvertType (dynamic source, Type dest)
	Dynamically cast the object into target type. Ref: http://stackoverflow.com/questions/4925718/c-dynamic-runtime-cast More...

static byte []	ReadAsBytes (Stream input)
	Convert stream to byte array Credit/Ref: http://stackoverflow.com/a/221941/677735 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...

Public Attributes inherited from DocuSign.eSign.Client.DocuSignClient
const string	Production_REST_BasePath = "https://www.docusign.net/restapi"

const string	Demo_REST_BasePath = "https://demo.docusign.net/restapi"

const string	Stage_REST_BasePath = "https://stage.docusign.net/restapi"

Protected Member Functions inherited from DocuSign.eSign.Client.DocuSignClient
string	BuildQueryString (string clientId, string scopes, string redirectUri, string responseType, string state)
	Builds a QueryString with the given parameters More...

string	GetOAuthBasePath ()
	GetOAuthBasePath sets the basePath for the user account. More...

Static Protected Member Functions inherited from DocuSign.eSign.Client.DocuSignClient
static IHttpClient	buildDefaultHttpClient (int timeout=Configuration.DefaultTimeoutValue, IWebProxy proxy=null)

static RSA	CreateRSAKeyFromPem (string key)
	Creates an RSA Key from the given PEM key. More...

Protected Attributes inherited from DocuSign.eSign.Client.DocuSignClient
string	basePath = Demo_REST_BasePath

Uri	baseUri => Uri.TryCreate(basePath, UriKind.Absolute, out Uri uri) ? uri : new Uri(Demo_REST_BasePath)

string	oAuthBasePath = OAuth.Demo_OAuth_BasePath

string	oAuthBasePathWithScheme => $"https://{oAuthBasePath}/"

Uri	oAuthBaseUri => Uri.TryCreate(oAuthBasePathWithScheme, UriKind.Absolute, out Uri uri) ? uri : new Uri(OAuth.Demo_OAuth_BasePath)

JsonSerializerSettings	serializerSettings

Properties inherited from DocuSign.eSign.Client.DocuSignClient
Configuration	Configuration `[get, set]`
	Gets or sets the Configuration. More...

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

IWebProxy	Proxy .[/\\](.)$" `[get, set]`
	Gets or sets the Proxy of ApiClient. Default to null More...

Detailed Description

API client is mainly responsible for making the HTTP call to the API backend.

Constructor & Destructor Documentation

◆ ApiClient() [1/4]

DocuSign.eSign.Client.ApiClient.ApiClient ( )

inline

Initializes a new instance of the ApiClient class with default configuration and base path (https://demo.docusign.net/restapi).

◆ ApiClient() [2/4]

DocuSign.eSign.Client.ApiClient.ApiClient ( Configuration configuration )

inline

Initializes a new instance of the ApiClient class with default base path (https://demo.docusign.net/restapi).

Parameters

configuration An instance of Configuration.

◆ ApiClient() [3/4]

DocuSign.eSign.Client.ApiClient.ApiClient	(	String	apiBase,
		IWebProxy	proxy = `null`
	)

inline

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

Parameters

apiBase	The base path.
proxy	An optional WebProxy instance.

◆ ApiClient() [4/4]

DocuSign.eSign.Client.ApiClient.ApiClient	(	String	apiBase,
		String	oAuthBase,
		IWebProxy	proxy = `null`
	)

inline

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

Parameters

apiBase	The base path.
oAuthBase	The oAuth base path.
proxy	An optional WebProxy instance.

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

sdk/src/DocuSign.eSign/Client/ApiClient.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ApiClient() [1/4]

◆ ApiClient() [2/4]

◆ ApiClient() [3/4]

◆ ApiClient() [4/4]