Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for DocuSign.eSign.Api.InsightsApi:

Public Member Functions
	InsightsApi (DocuSignClient aplClient)
	Initializes a new instance of the InsightsApi class using AplClient object More...

String	GetBasePath ()
	Gets the base path of the API client. More...

RecommendationsListResponse	CreateRecommendationsIntent (string accountId, string type, string envelopeId, RecommendationsListRequest recommendationsListRequest=null)
	Sets recommendations for an envelope More...

ApiResponse< RecommendationsListResponse >	CreateRecommendationsIntentWithHttpInfo (string accountId, string type, string envelopeId, RecommendationsListRequest recommendationsListRequest=null)
	Sets recommendations for an envelope More...

async System.Threading.Tasks.Task< RecommendationsListResponse >	CreateRecommendationsIntentAsync (string accountId, string type, string envelopeId, RecommendationsListRequest recommendationsListRequest=null)
	Sets recommendations for an envelope More...

async System.Threading.Tasks.Task< ApiResponse< RecommendationsListResponse > >	CreateRecommendationsIntentAsyncWithHttpInfo (string accountId, string type, string envelopeId, RecommendationsListRequest recommendationsListRequest=null)
	Sets recommendations for an envelope More...

RecommendationsListResponse	GetRecommendationsIntent (string accountId, string type, string envelopeId)
	Gets Recommendations associated with an envelope More...

ApiResponse< RecommendationsListResponse >	GetRecommendationsIntentWithHttpInfo (string accountId, string type, string envelopeId)
	Gets Recommendations associated with an envelope More...

async System.Threading.Tasks.Task< RecommendationsListResponse >	GetRecommendationsIntentAsync (string accountId, string type, string envelopeId)
	Gets Recommendations associated with an envelope More...

async System.Threading.Tasks.Task< ApiResponse< RecommendationsListResponse > >	GetRecommendationsIntentAsyncWithHttpInfo (string accountId, string type, string envelopeId)
	Gets Recommendations associated with an envelope More...

RecommendationsListResponse	GetRecommendationsList (string accountId, string type)
	Gets available Recommendations More...

ApiResponse< RecommendationsListResponse >	GetRecommendationsListWithHttpInfo (string accountId, string type)
	Gets available Recommendations More...

async System.Threading.Tasks.Task< RecommendationsListResponse >	GetRecommendationsListAsync (string accountId, string type)
	Gets available Recommendations More...

async System.Threading.Tasks.Task< ApiResponse< RecommendationsListResponse > >	GetRecommendationsListAsyncWithHttpInfo (string accountId, string type)
	Gets available Recommendations More...

Properties
DocuSignClient	ApiClient `[get, set]`
	Gets or sets the ApiClient object More...

DocuSign.eSign.Client.ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

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

ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

◆ InsightsApi()

DocuSign.eSign.Api.InsightsApi.InsightsApi ( DocuSignClient aplClient )

inline

Initializes a new instance of the InsightsApi class using AplClient object

Parameters

aplClient An instance of AplClient

Returns

Member Function Documentation

◆ CreateRecommendationsIntent()

RecommendationsListResponse DocuSign.eSign.Api.InsightsApi.CreateRecommendationsIntent	(	string	accountId,
		string	type,
		string	envelopeId,
		RecommendationsListRequest	recommendationsListRequest = `null`
	)

inline

Sets recommendations for an envelope

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
type
envelopeId	The envelopeId Guid of the envelope being accessed.
recommendationsListRequest	(optional)

Returns: RecommendationsListResponse

Implements DocuSign.eSign.Api.IInsightsApi.

◆ CreateRecommendationsIntentAsync()

async System.Threading.Tasks.Task<RecommendationsListResponse> DocuSign.eSign.Api.InsightsApi.CreateRecommendationsIntentAsync	(	string	accountId,
		string	type,
		string	envelopeId,
		RecommendationsListRequest	recommendationsListRequest = `null`
	)

inline

Sets recommendations for an envelope

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
type
envelopeId	The envelopeId Guid of the envelope being accessed.
recommendationsListRequest	(optional)

Returns: Task of RecommendationsListResponse

Implements DocuSign.eSign.Api.IInsightsApi.

◆ CreateRecommendationsIntentAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<RecommendationsListResponse> > DocuSign.eSign.Api.InsightsApi.CreateRecommendationsIntentAsyncWithHttpInfo	(	string	accountId,
		string	type,
		string	envelopeId,
		RecommendationsListRequest	recommendationsListRequest = `null`
	)

inline

Sets recommendations for an envelope

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
type
envelopeId	The envelopeId Guid of the envelope being accessed.
recommendationsListRequest	(optional)

Returns: Task of ApiResponse (RecommendationsListResponse)

Implements DocuSign.eSign.Api.IInsightsApi.

◆ CreateRecommendationsIntentWithHttpInfo()

ApiResponse<RecommendationsListResponse> DocuSign.eSign.Api.InsightsApi.CreateRecommendationsIntentWithHttpInfo	(	string	accountId,
		string	type,
		string	envelopeId,
		RecommendationsListRequest	recommendationsListRequest = `null`
	)

inline

Sets recommendations for an envelope

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
type
envelopeId	The envelopeId Guid of the envelope being accessed.
recommendationsListRequest	(optional)

Returns: ApiResponse of RecommendationsListResponse

Implements DocuSign.eSign.Api.IInsightsApi.

◆ GetBasePath()

String DocuSign.eSign.Api.InsightsApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

Implements DocuSign.eSign.Client.IApiAccessor.

◆ GetRecommendationsIntent()

RecommendationsListResponse DocuSign.eSign.Api.InsightsApi.GetRecommendationsIntent	(	string	accountId,
		string	type,
		string	envelopeId
	)

inline

Gets Recommendations associated with an envelope

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
type
envelopeId	The envelopeId Guid of the envelope being accessed.

Returns: RecommendationsListResponse

Implements DocuSign.eSign.Api.IInsightsApi.

◆ GetRecommendationsIntentAsync()

async System.Threading.Tasks.Task<RecommendationsListResponse> DocuSign.eSign.Api.InsightsApi.GetRecommendationsIntentAsync	(	string	accountId,
		string	type,
		string	envelopeId
	)

inline

Gets Recommendations associated with an envelope

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
type
envelopeId	The envelopeId Guid of the envelope being accessed.

Returns: Task of RecommendationsListResponse

Implements DocuSign.eSign.Api.IInsightsApi.

◆ GetRecommendationsIntentAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<RecommendationsListResponse> > DocuSign.eSign.Api.InsightsApi.GetRecommendationsIntentAsyncWithHttpInfo	(	string	accountId,
		string	type,
		string	envelopeId
	)

inline

Gets Recommendations associated with an envelope

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
type
envelopeId	The envelopeId Guid of the envelope being accessed.

Returns: Task of ApiResponse (RecommendationsListResponse)

Implements DocuSign.eSign.Api.IInsightsApi.

◆ GetRecommendationsIntentWithHttpInfo()

ApiResponse<RecommendationsListResponse> DocuSign.eSign.Api.InsightsApi.GetRecommendationsIntentWithHttpInfo	(	string	accountId,
		string	type,
		string	envelopeId
	)

inline

Gets Recommendations associated with an envelope

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
type
envelopeId	The envelopeId Guid of the envelope being accessed.

Returns: ApiResponse of RecommendationsListResponse

Implements DocuSign.eSign.Api.IInsightsApi.

◆ GetRecommendationsList()

RecommendationsListResponse DocuSign.eSign.Api.InsightsApi.GetRecommendationsList	(	string	accountId,
		string	type
	)

inline

Gets available Recommendations

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
type

Returns: RecommendationsListResponse

Implements DocuSign.eSign.Api.IInsightsApi.

◆ GetRecommendationsListAsync()

async System.Threading.Tasks.Task<RecommendationsListResponse> DocuSign.eSign.Api.InsightsApi.GetRecommendationsListAsync	(	string	accountId,
		string	type
	)

inline

Gets available Recommendations

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
type

Returns: Task of RecommendationsListResponse

Implements DocuSign.eSign.Api.IInsightsApi.

◆ GetRecommendationsListAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<RecommendationsListResponse> > DocuSign.eSign.Api.InsightsApi.GetRecommendationsListAsyncWithHttpInfo	(	string	accountId,
		string	type
	)

inline

Gets available Recommendations

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
type

Returns: Task of ApiResponse (RecommendationsListResponse)

Implements DocuSign.eSign.Api.IInsightsApi.

◆ GetRecommendationsListWithHttpInfo()

ApiResponse<RecommendationsListResponse> DocuSign.eSign.Api.InsightsApi.GetRecommendationsListWithHttpInfo	(	string	accountId,
		string	type
	)

inline

Gets available Recommendations

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
type

Returns: ApiResponse of RecommendationsListResponse

Implements DocuSign.eSign.Api.IInsightsApi.

Property Documentation

◆ ApiClient

DocuSignClient DocuSign.eSign.Api.InsightsApi.ApiClient

getset

Gets or sets the ApiClient object

An instance of the ApiClient

◆ ExceptionFactory

DocuSign.eSign.Client.ExceptionFactory DocuSign.eSign.Api.InsightsApi.ExceptionFactory

getset

Provides a factory method hook for the creation of exceptions.

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

sdk/src/DocuSign.eSign/Api/InsightsApi.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ InsightsApi()

Member Function Documentation

◆ CreateRecommendationsIntent()

◆ CreateRecommendationsIntentAsync()

◆ CreateRecommendationsIntentAsyncWithHttpInfo()

◆ CreateRecommendationsIntentWithHttpInfo()

◆ GetBasePath()

◆ GetRecommendationsIntent()

◆ GetRecommendationsIntentAsync()

◆ GetRecommendationsIntentAsyncWithHttpInfo()

◆ GetRecommendationsIntentWithHttpInfo()

◆ GetRecommendationsList()

◆ GetRecommendationsListAsync()

◆ GetRecommendationsListAsyncWithHttpInfo()

◆ GetRecommendationsListWithHttpInfo()

Property Documentation

◆ ApiClient

◆ ExceptionFactory