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

Inheritance diagram for DocuSign.eSign.Api.ConnectApi:

Classes
class	GetConnectAllUsersOptions
	Returns all users from the configured Connect service. More...

class	GetEventLogOptions
	Get the specified Connect log entry. Retrieves the specified Connect log entry for your account. ###### Note: The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded. More...

class	ListEventFailureLogsOptions
	Gets the Connect failure log information. Retrieves the Connect Failure Log information. It can be used to determine which envelopes failed to post, so a republish request can be created. More...

class	ListEventLogsOptions
	Gets the Connect log. Retrieves a list of connect log entries for your account. ###### Note: The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded. More...

class	ListUsersOptions
	Returns users from the configured Connect service. Returns users from the configured Connect service. More...

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

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

ConnectCustomConfiguration	CreateConfiguration (string accountId, ConnectCustomConfiguration connectCustomConfiguration=null)
	Creates a connect configuration for the specified account. Creates a DocuSign Custom Connect definition for your account. DocuSign Connect enables the sending of real-time data updates to external applications. These updates are generated by user transactions as the envelope progresses through actions to completion. The Connect Service provides updated information about the status of these transactions and returns updates that include the actual content of document form fields. Be aware that, these updates might or might not include the document itself. For more information about Connect, see the [ML:DocuSign Connect Service Guide]. ###### Note: Connect must be enabled for your account to use this function. This cannot be used to set up Connect configurations for Salesforce or eOriginal. More...

ApiResponse< ConnectCustomConfiguration >	CreateConfigurationWithHttpInfo (string accountId, ConnectCustomConfiguration connectCustomConfiguration=null)
	Creates a connect configuration for the specified account. Creates a DocuSign Custom Connect definition for your account. DocuSign Connect enables the sending of real-time data updates to external applications. These updates are generated by user transactions as the envelope progresses through actions to completion. The Connect Service provides updated information about the status of these transactions and returns updates that include the actual content of document form fields. Be aware that, these updates might or might not include the document itself. For more information about Connect, see the [ML:DocuSign Connect Service Guide]. ###### Note: Connect must be enabled for your account to use this function. This cannot be used to set up Connect configurations for Salesforce or eOriginal. More...

async System.Threading.Tasks.Task< ConnectCustomConfiguration >	CreateConfigurationAsync (string accountId, ConnectCustomConfiguration connectCustomConfiguration=null)
	Creates a connect configuration for the specified account. Creates a DocuSign Custom Connect definition for your account. DocuSign Connect enables the sending of real-time data updates to external applications. These updates are generated by user transactions as the envelope progresses through actions to completion. The Connect Service provides updated information about the status of these transactions and returns updates that include the actual content of document form fields. Be aware that, these updates might or might not include the document itself. For more information about Connect, see the [ML:DocuSign Connect Service Guide]. ###### Note: Connect must be enabled for your account to use this function. This cannot be used to set up Connect configurations for Salesforce or eOriginal. More...

async System.Threading.Tasks.Task< ApiResponse< ConnectCustomConfiguration > >	CreateConfigurationAsyncWithHttpInfo (string accountId, ConnectCustomConfiguration connectCustomConfiguration=null)
	Creates a connect configuration for the specified account. Creates a DocuSign Custom Connect definition for your account. DocuSign Connect enables the sending of real-time data updates to external applications. These updates are generated by user transactions as the envelope progresses through actions to completion. The Connect Service provides updated information about the status of these transactions and returns updates that include the actual content of document form fields. Be aware that, these updates might or might not include the document itself. For more information about Connect, see the [ML:DocuSign Connect Service Guide]. ###### Note: Connect must be enabled for your account to use this function. This cannot be used to set up Connect configurations for Salesforce or eOriginal. More...

ConnectOAuthConfig	CreateConnectOAuthConfig (string accountId, ConnectOAuthConfig connectOAuthConfig=null)
	Sets the Connect OAuth Config for the account. More...

ApiResponse< ConnectOAuthConfig >	CreateConnectOAuthConfigWithHttpInfo (string accountId, ConnectOAuthConfig connectOAuthConfig=null)
	Sets the Connect OAuth Config for the account. More...

async System.Threading.Tasks.Task< ConnectOAuthConfig >	CreateConnectOAuthConfigAsync (string accountId, ConnectOAuthConfig connectOAuthConfig=null)
	Sets the Connect OAuth Config for the account. More...

async System.Threading.Tasks.Task< ApiResponse< ConnectOAuthConfig > >	CreateConnectOAuthConfigAsyncWithHttpInfo (string accountId, ConnectOAuthConfig connectOAuthConfig=null)
	Sets the Connect OAuth Config for the account. More...

void	DeleteConfiguration (string accountId, string connectId)
	Deletes the specified connect configuration. Deletes the specified DocuSign Connect configuration. ###### Note: Connect must be enabled for your account to use this function. More...

ApiResponse< Object >	DeleteConfigurationWithHttpInfo (string accountId, string connectId)
	Deletes the specified connect configuration. Deletes the specified DocuSign Connect configuration. ###### Note: Connect must be enabled for your account to use this function. More...

async System.Threading.Tasks.Task	DeleteConfigurationAsync (string accountId, string connectId)
	Deletes the specified connect configuration. Deletes the specified DocuSign Connect configuration. ###### Note: Connect must be enabled for your account to use this function. More...

async System.Threading.Tasks.Task< ApiResponse< Object > >	DeleteConfigurationAsyncWithHttpInfo (string accountId, string connectId)
	Deletes the specified connect configuration. Deletes the specified DocuSign Connect configuration. ###### Note: Connect must be enabled for your account to use this function. More...

void	DeleteConnectOAuthConfig (string accountId)
	Sets the Connect OAuth Config for the account. More...

ApiResponse< Object >	DeleteConnectOAuthConfigWithHttpInfo (string accountId)
	Sets the Connect OAuth Config for the account. More...

async System.Threading.Tasks.Task	DeleteConnectOAuthConfigAsync (string accountId)
	Sets the Connect OAuth Config for the account. More...

async System.Threading.Tasks.Task< ApiResponse< Object > >	DeleteConnectOAuthConfigAsyncWithHttpInfo (string accountId)
	Sets the Connect OAuth Config for the account. More...

ConnectDeleteFailureResult	DeleteEventFailureLog (string accountId, string failureId)
	Deletes a Connect failure log entry. Deletes the Connect failure log information for the specified entry. More...

ApiResponse< ConnectDeleteFailureResult >	DeleteEventFailureLogWithHttpInfo (string accountId, string failureId)
	Deletes a Connect failure log entry. Deletes the Connect failure log information for the specified entry. More...

async System.Threading.Tasks.Task< ConnectDeleteFailureResult >	DeleteEventFailureLogAsync (string accountId, string failureId)
	Deletes a Connect failure log entry. Deletes the Connect failure log information for the specified entry. More...

async System.Threading.Tasks.Task< ApiResponse< ConnectDeleteFailureResult > >	DeleteEventFailureLogAsyncWithHttpInfo (string accountId, string failureId)
	Deletes a Connect failure log entry. Deletes the Connect failure log information for the specified entry. More...

void	DeleteEventLog (string accountId, string logId)
	Deletes a specified Connect log entry. Deletes a specified entry from the Connect Log. More...

ApiResponse< Object >	DeleteEventLogWithHttpInfo (string accountId, string logId)
	Deletes a specified Connect log entry. Deletes a specified entry from the Connect Log. More...

async System.Threading.Tasks.Task	DeleteEventLogAsync (string accountId, string logId)
	Deletes a specified Connect log entry. Deletes a specified entry from the Connect Log. More...

async System.Threading.Tasks.Task< ApiResponse< Object > >	DeleteEventLogAsyncWithHttpInfo (string accountId, string logId)
	Deletes a specified Connect log entry. Deletes a specified entry from the Connect Log. More...

void	DeleteEventLogs (string accountId)
	Gets a list of Connect log entries. Retrieves a list of connect log entries for your account. ###### Note: The `enableLog` property in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded. More...

ApiResponse< Object >	DeleteEventLogsWithHttpInfo (string accountId)
	Gets a list of Connect log entries. Retrieves a list of connect log entries for your account. ###### Note: The `enableLog` property in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded. More...

async System.Threading.Tasks.Task	DeleteEventLogsAsync (string accountId)
	Gets a list of Connect log entries. Retrieves a list of connect log entries for your account. ###### Note: The `enableLog` property in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded. More...

async System.Threading.Tasks.Task< ApiResponse< Object > >	DeleteEventLogsAsyncWithHttpInfo (string accountId)
	Gets a list of Connect log entries. Retrieves a list of connect log entries for your account. ###### Note: The `enableLog` property in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded. More...

MobileNotifierConfigurationInformation	DeleteMobileNotifiers (string accountId, MobileNotifierConfigurationInformation mobileNotifierConfigurationInformation=null)
	Reserved Reserved: More...

ApiResponse< MobileNotifierConfigurationInformation >	DeleteMobileNotifiersWithHttpInfo (string accountId, MobileNotifierConfigurationInformation mobileNotifierConfigurationInformation=null)
	Reserved Reserved: More...

async System.Threading.Tasks.Task< MobileNotifierConfigurationInformation >	DeleteMobileNotifiersAsync (string accountId, MobileNotifierConfigurationInformation mobileNotifierConfigurationInformation=null)
	Reserved Reserved: More...

async System.Threading.Tasks.Task< ApiResponse< MobileNotifierConfigurationInformation > >	DeleteMobileNotifiersAsyncWithHttpInfo (string accountId, MobileNotifierConfigurationInformation mobileNotifierConfigurationInformation=null)
	Reserved Reserved: More...

ConnectConfigResults	GetConfiguration (string accountId, string connectId)
	Get a Connect Configuration Information Retrieves the information for the specified DocuSign Connect configuration. ###### Note: Connect must be enabled for your account to use this function. More...

ApiResponse< ConnectConfigResults >	GetConfigurationWithHttpInfo (string accountId, string connectId)
	Get a Connect Configuration Information Retrieves the information for the specified DocuSign Connect configuration. ###### Note: Connect must be enabled for your account to use this function. More...

async System.Threading.Tasks.Task< ConnectConfigResults >	GetConfigurationAsync (string accountId, string connectId)
	Get a Connect Configuration Information Retrieves the information for the specified DocuSign Connect configuration. ###### Note: Connect must be enabled for your account to use this function. More...

async System.Threading.Tasks.Task< ApiResponse< ConnectConfigResults > >	GetConfigurationAsyncWithHttpInfo (string accountId, string connectId)
	Get a Connect Configuration Information Retrieves the information for the specified DocuSign Connect configuration. ###### Note: Connect must be enabled for your account to use this function. More...

IntegratedConnectUserInfoList	GetConnectAllUsers (string accountId, string connectId, ConnectApi.GetConnectAllUsersOptions options=null)
	Returns all users from the configured Connect service. More...

ApiResponse< IntegratedConnectUserInfoList >	GetConnectAllUsersWithHttpInfo (string accountId, string connectId, ConnectApi.GetConnectAllUsersOptions options=null)
	Returns all users from the configured Connect service. More...

async System.Threading.Tasks.Task< IntegratedConnectUserInfoList >	GetConnectAllUsersAsync (string accountId, string connectId, ConnectApi.GetConnectAllUsersOptions options=null)
	Returns all users from the configured Connect service. More...

async System.Threading.Tasks.Task< ApiResponse< IntegratedConnectUserInfoList > >	GetConnectAllUsersAsyncWithHttpInfo (string accountId, string connectId, ConnectApi.GetConnectAllUsersOptions options=null)
	Returns all users from the configured Connect service. More...

ConnectOAuthConfig	GetConnectOAuthConfig (string accountId)
	Sets the Connect OAuth Config for the account. More...

ApiResponse< ConnectOAuthConfig >	GetConnectOAuthConfigWithHttpInfo (string accountId)
	Sets the Connect OAuth Config for the account. More...

async System.Threading.Tasks.Task< ConnectOAuthConfig >	GetConnectOAuthConfigAsync (string accountId)
	Sets the Connect OAuth Config for the account. More...

async System.Threading.Tasks.Task< ApiResponse< ConnectOAuthConfig > >	GetConnectOAuthConfigAsyncWithHttpInfo (string accountId)
	Sets the Connect OAuth Config for the account. More...

ConnectLog	GetEventLog (string accountId, string logId, ConnectApi.GetEventLogOptions options=null)
	Get the specified Connect log entry. Retrieves the specified Connect log entry for your account. ###### Note: The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded. More...

ApiResponse< ConnectLog >	GetEventLogWithHttpInfo (string accountId, string logId, ConnectApi.GetEventLogOptions options=null)
	Get the specified Connect log entry. Retrieves the specified Connect log entry for your account. ###### Note: The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded. More...

async System.Threading.Tasks.Task< ConnectLog >	GetEventLogAsync (string accountId, string logId, ConnectApi.GetEventLogOptions options=null)
	Get the specified Connect log entry. Retrieves the specified Connect log entry for your account. ###### Note: The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded. More...

async System.Threading.Tasks.Task< ApiResponse< ConnectLog > >	GetEventLogAsyncWithHttpInfo (string accountId, string logId, ConnectApi.GetEventLogOptions options=null)
	Get the specified Connect log entry. Retrieves the specified Connect log entry for your account. ###### Note: The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded. More...

ConnectConfigResults	ListConfigurations (string accountId)
	Get Connect Configuration Information Retrieves all the DocuSign Custom Connect definitions for the specified account. ###### Note: Connect must be enabled for your account to use this function. This does not retrieve information for Connect configurations for Box, eOriginal, or Salesforce. More...

ApiResponse< ConnectConfigResults >	ListConfigurationsWithHttpInfo (string accountId)
	Get Connect Configuration Information Retrieves all the DocuSign Custom Connect definitions for the specified account. ###### Note: Connect must be enabled for your account to use this function. This does not retrieve information for Connect configurations for Box, eOriginal, or Salesforce. More...

async System.Threading.Tasks.Task< ConnectConfigResults >	ListConfigurationsAsync (string accountId)
	Get Connect Configuration Information Retrieves all the DocuSign Custom Connect definitions for the specified account. ###### Note: Connect must be enabled for your account to use this function. This does not retrieve information for Connect configurations for Box, eOriginal, or Salesforce. More...

async System.Threading.Tasks.Task< ApiResponse< ConnectConfigResults > >	ListConfigurationsAsyncWithHttpInfo (string accountId)
	Get Connect Configuration Information Retrieves all the DocuSign Custom Connect definitions for the specified account. ###### Note: Connect must be enabled for your account to use this function. This does not retrieve information for Connect configurations for Box, eOriginal, or Salesforce. More...

ConnectLogs	ListEventFailureLogs (string accountId, ConnectApi.ListEventFailureLogsOptions options=null)
	Gets the Connect failure log information. Retrieves the Connect Failure Log information. It can be used to determine which envelopes failed to post, so a republish request can be created. More...

ApiResponse< ConnectLogs >	ListEventFailureLogsWithHttpInfo (string accountId, ConnectApi.ListEventFailureLogsOptions options=null)
	Gets the Connect failure log information. Retrieves the Connect Failure Log information. It can be used to determine which envelopes failed to post, so a republish request can be created. More...

async System.Threading.Tasks.Task< ConnectLogs >	ListEventFailureLogsAsync (string accountId, ConnectApi.ListEventFailureLogsOptions options=null)
	Gets the Connect failure log information. Retrieves the Connect Failure Log information. It can be used to determine which envelopes failed to post, so a republish request can be created. More...

async System.Threading.Tasks.Task< ApiResponse< ConnectLogs > >	ListEventFailureLogsAsyncWithHttpInfo (string accountId, ConnectApi.ListEventFailureLogsOptions options=null)
	Gets the Connect failure log information. Retrieves the Connect Failure Log information. It can be used to determine which envelopes failed to post, so a republish request can be created. More...

ConnectLogs	ListEventLogs (string accountId, ConnectApi.ListEventLogsOptions options=null)
	Gets the Connect log. Retrieves a list of connect log entries for your account. ###### Note: The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded. More...

ApiResponse< ConnectLogs >	ListEventLogsWithHttpInfo (string accountId, ConnectApi.ListEventLogsOptions options=null)
	Gets the Connect log. Retrieves a list of connect log entries for your account. ###### Note: The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded. More...

async System.Threading.Tasks.Task< ConnectLogs >	ListEventLogsAsync (string accountId, ConnectApi.ListEventLogsOptions options=null)
	Gets the Connect log. Retrieves a list of connect log entries for your account. ###### Note: The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded. More...

async System.Threading.Tasks.Task< ApiResponse< ConnectLogs > >	ListEventLogsAsyncWithHttpInfo (string accountId, ConnectApi.ListEventLogsOptions options=null)
	Gets the Connect log. Retrieves a list of connect log entries for your account. ###### Note: The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded. More...

MobileNotifierConfigurationInformation	ListMobileNotifiers (string accountId)
	Reserved Reserved: More...

ApiResponse< MobileNotifierConfigurationInformation >	ListMobileNotifiersWithHttpInfo (string accountId)
	Reserved Reserved: More...

async System.Threading.Tasks.Task< MobileNotifierConfigurationInformation >	ListMobileNotifiersAsync (string accountId)
	Reserved Reserved: More...

async System.Threading.Tasks.Task< ApiResponse< MobileNotifierConfigurationInformation > >	ListMobileNotifiersAsyncWithHttpInfo (string accountId)
	Reserved Reserved: More...

IntegratedUserInfoList	ListUsers (string accountId, string connectId, ConnectApi.ListUsersOptions options=null)
	Returns users from the configured Connect service. Returns users from the configured Connect service. More...

ApiResponse< IntegratedUserInfoList >	ListUsersWithHttpInfo (string accountId, string connectId, ConnectApi.ListUsersOptions options=null)
	Returns users from the configured Connect service. Returns users from the configured Connect service. More...

async System.Threading.Tasks.Task< IntegratedUserInfoList >	ListUsersAsync (string accountId, string connectId, ConnectApi.ListUsersOptions options=null)
	Returns users from the configured Connect service. Returns users from the configured Connect service. More...

async System.Threading.Tasks.Task< ApiResponse< IntegratedUserInfoList > >	ListUsersAsyncWithHttpInfo (string accountId, string connectId, ConnectApi.ListUsersOptions options=null)
	Returns users from the configured Connect service. Returns users from the configured Connect service. More...

ConnectFailureResults	RetryEventForEnvelope (string accountId, string envelopeId)
	Republishes Connect information for the specified envelope. Republishes Connect information for the specified envelope. More...

ApiResponse< ConnectFailureResults >	RetryEventForEnvelopeWithHttpInfo (string accountId, string envelopeId)
	Republishes Connect information for the specified envelope. Republishes Connect information for the specified envelope. More...

async System.Threading.Tasks.Task< ConnectFailureResults >	RetryEventForEnvelopeAsync (string accountId, string envelopeId)
	Republishes Connect information for the specified envelope. Republishes Connect information for the specified envelope. More...

async System.Threading.Tasks.Task< ApiResponse< ConnectFailureResults > >	RetryEventForEnvelopeAsyncWithHttpInfo (string accountId, string envelopeId)
	Republishes Connect information for the specified envelope. Republishes Connect information for the specified envelope. More...

ConnectFailureResults	RetryEventForEnvelopes (string accountId, ConnectFailureFilter connectFailureFilter=null)
	Republishes Connect information for multiple envelopes. Republishes Connect information for the specified set of envelopes. The primary use is to republish Connect post failures by including envelope IDs for the envelopes that failed to post in the request. The list of envelope IDs that failed to post correctly can be retrieved by calling to [ML:GetConnectLog] retrieve the failure log. More...

ApiResponse< ConnectFailureResults >	RetryEventForEnvelopesWithHttpInfo (string accountId, ConnectFailureFilter connectFailureFilter=null)
	Republishes Connect information for multiple envelopes. Republishes Connect information for the specified set of envelopes. The primary use is to republish Connect post failures by including envelope IDs for the envelopes that failed to post in the request. The list of envelope IDs that failed to post correctly can be retrieved by calling to [ML:GetConnectLog] retrieve the failure log. More...

async System.Threading.Tasks.Task< ConnectFailureResults >	RetryEventForEnvelopesAsync (string accountId, ConnectFailureFilter connectFailureFilter=null)
	Republishes Connect information for multiple envelopes. Republishes Connect information for the specified set of envelopes. The primary use is to republish Connect post failures by including envelope IDs for the envelopes that failed to post in the request. The list of envelope IDs that failed to post correctly can be retrieved by calling to [ML:GetConnectLog] retrieve the failure log. More...

async System.Threading.Tasks.Task< ApiResponse< ConnectFailureResults > >	RetryEventForEnvelopesAsyncWithHttpInfo (string accountId, ConnectFailureFilter connectFailureFilter=null)
	Republishes Connect information for multiple envelopes. Republishes Connect information for the specified set of envelopes. The primary use is to republish Connect post failures by including envelope IDs for the envelopes that failed to post in the request. The list of envelope IDs that failed to post correctly can be retrieved by calling to [ML:GetConnectLog] retrieve the failure log. More...

ConnectCustomConfiguration	UpdateConfiguration (string accountId, ConnectCustomConfiguration connectCustomConfiguration=null)
	Updates a specified Connect configuration. Updates the specified DocuSign Connect configuration in your account. ###### Note: Connect must be enabled for your account to use this function. This cannot be used to update Connect configurations for Box, eOriginal, or Salesforce. More...

ApiResponse< ConnectCustomConfiguration >	UpdateConfigurationWithHttpInfo (string accountId, ConnectCustomConfiguration connectCustomConfiguration=null)
	Updates a specified Connect configuration. Updates the specified DocuSign Connect configuration in your account. ###### Note: Connect must be enabled for your account to use this function. This cannot be used to update Connect configurations for Box, eOriginal, or Salesforce. More...

async System.Threading.Tasks.Task< ConnectCustomConfiguration >	UpdateConfigurationAsync (string accountId, ConnectCustomConfiguration connectCustomConfiguration=null)
	Updates a specified Connect configuration. Updates the specified DocuSign Connect configuration in your account. ###### Note: Connect must be enabled for your account to use this function. This cannot be used to update Connect configurations for Box, eOriginal, or Salesforce. More...

async System.Threading.Tasks.Task< ApiResponse< ConnectCustomConfiguration > >	UpdateConfigurationAsyncWithHttpInfo (string accountId, ConnectCustomConfiguration connectCustomConfiguration=null)
	Updates a specified Connect configuration. Updates the specified DocuSign Connect configuration in your account. ###### Note: Connect must be enabled for your account to use this function. This cannot be used to update Connect configurations for Box, eOriginal, or Salesforce. More...

ConnectOAuthConfig	UpdateConnectOAuthConfig (string accountId, ConnectOAuthConfig connectOAuthConfig=null)
	Updates the existing Connect OAuth Config for the account. More...

ApiResponse< ConnectOAuthConfig >	UpdateConnectOAuthConfigWithHttpInfo (string accountId, ConnectOAuthConfig connectOAuthConfig=null)
	Updates the existing Connect OAuth Config for the account. More...

async System.Threading.Tasks.Task< ConnectOAuthConfig >	UpdateConnectOAuthConfigAsync (string accountId, ConnectOAuthConfig connectOAuthConfig=null)
	Updates the existing Connect OAuth Config for the account. More...

async System.Threading.Tasks.Task< ApiResponse< ConnectOAuthConfig > >	UpdateConnectOAuthConfigAsyncWithHttpInfo (string accountId, ConnectOAuthConfig connectOAuthConfig=null)
	Updates the existing Connect OAuth Config for the account. More...

MobileNotifierConfigurationInformation	UpdateMobileNotifiers (string accountId, MobileNotifierConfigurationInformation mobileNotifierConfigurationInformation=null)
	Reserved Reserved: More...

ApiResponse< MobileNotifierConfigurationInformation >	UpdateMobileNotifiersWithHttpInfo (string accountId, MobileNotifierConfigurationInformation mobileNotifierConfigurationInformation=null)
	Reserved Reserved: More...

async System.Threading.Tasks.Task< MobileNotifierConfigurationInformation >	UpdateMobileNotifiersAsync (string accountId, MobileNotifierConfigurationInformation mobileNotifierConfigurationInformation=null)
	Reserved Reserved: More...

async System.Threading.Tasks.Task< ApiResponse< MobileNotifierConfigurationInformation > >	UpdateMobileNotifiersAsyncWithHttpInfo (string accountId, MobileNotifierConfigurationInformation mobileNotifierConfigurationInformation=null)
	Reserved Reserved: More...

Public Member Functions inherited from DocuSign.eSign.Api.IConnectApi
IntegratedConnectUserInfoList	GetConnectAllUsers (string accountId, string connectId, ConnectApi.GetConnectAllUsersOptions options=null)
	Returns all users from the configured Connect service. More...

ApiResponse< IntegratedConnectUserInfoList >	GetConnectAllUsersWithHttpInfo (string accountId, string connectId, ConnectApi.GetConnectAllUsersOptions options=null)
	Returns all users from the configured Connect service. More...

ConnectLog	GetEventLog (string accountId, string logId, ConnectApi.GetEventLogOptions options=null)
	Get the specified Connect log entry. More...

ApiResponse< ConnectLog >	GetEventLogWithHttpInfo (string accountId, string logId, ConnectApi.GetEventLogOptions options=null)
	Get the specified Connect log entry. More...

ConnectLogs	ListEventFailureLogs (string accountId, ConnectApi.ListEventFailureLogsOptions options=null)
	Gets the Connect failure log information. More...

ApiResponse< ConnectLogs >	ListEventFailureLogsWithHttpInfo (string accountId, ConnectApi.ListEventFailureLogsOptions options=null)
	Gets the Connect failure log information. More...

ConnectLogs	ListEventLogs (string accountId, ConnectApi.ListEventLogsOptions options=null)
	Gets the Connect log. More...

ApiResponse< ConnectLogs >	ListEventLogsWithHttpInfo (string accountId, ConnectApi.ListEventLogsOptions options=null)
	Gets the Connect log. More...

IntegratedUserInfoList	ListUsers (string accountId, string connectId, ConnectApi.ListUsersOptions options=null)
	Returns users from the configured Connect service. More...

ApiResponse< IntegratedUserInfoList >	ListUsersWithHttpInfo (string accountId, string connectId, ConnectApi.ListUsersOptions options=null)
	Returns users from the configured Connect service. More...

System.Threading.Tasks.Task< IntegratedConnectUserInfoList >	GetConnectAllUsersAsync (string accountId, string connectId, ConnectApi.GetConnectAllUsersOptions options=null)
	Returns all users from the configured Connect service. More...

System.Threading.Tasks.Task< ApiResponse< IntegratedConnectUserInfoList > >	GetConnectAllUsersAsyncWithHttpInfo (string accountId, string connectId, ConnectApi.GetConnectAllUsersOptions options=null)
	Returns all users from the configured Connect service. More...

System.Threading.Tasks.Task< ConnectLog >	GetEventLogAsync (string accountId, string logId, ConnectApi.GetEventLogOptions options=null)
	Get the specified Connect log entry. More...

System.Threading.Tasks.Task< ApiResponse< ConnectLog > >	GetEventLogAsyncWithHttpInfo (string accountId, string logId, ConnectApi.GetEventLogOptions options=null)
	Get the specified Connect log entry. More...

System.Threading.Tasks.Task< ConnectLogs >	ListEventFailureLogsAsync (string accountId, ConnectApi.ListEventFailureLogsOptions options=null)
	Gets the Connect failure log information. More...

System.Threading.Tasks.Task< ApiResponse< ConnectLogs > >	ListEventFailureLogsAsyncWithHttpInfo (string accountId, ConnectApi.ListEventFailureLogsOptions options=null)
	Gets the Connect failure log information. More...

System.Threading.Tasks.Task< ConnectLogs >	ListEventLogsAsync (string accountId, ConnectApi.ListEventLogsOptions options=null)
	Gets the Connect log. More...

System.Threading.Tasks.Task< ApiResponse< ConnectLogs > >	ListEventLogsAsyncWithHttpInfo (string accountId, ConnectApi.ListEventLogsOptions options=null)
	Gets the Connect log. More...

System.Threading.Tasks.Task< IntegratedUserInfoList >	ListUsersAsync (string accountId, string connectId, ConnectApi.ListUsersOptions options=null)
	Returns users from the configured Connect service. More...

System.Threading.Tasks.Task< ApiResponse< IntegratedUserInfoList > >	ListUsersAsyncWithHttpInfo (string accountId, string connectId, ConnectApi.ListUsersOptions options=null)
	Returns users from the configured Connect service. 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

◆ ConnectApi()

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

inline

Initializes a new instance of the ConnectApi class using AplClient object

Parameters

aplClient An instance of AplClient

Returns

Member Function Documentation

◆ CreateConfiguration()

ConnectCustomConfiguration DocuSign.eSign.Api.ConnectApi.CreateConfiguration	(	string	accountId,
		ConnectCustomConfiguration	connectCustomConfiguration = `null`
	)

inline

Creates a connect configuration for the specified account. Creates a DocuSign Custom Connect definition for your account. DocuSign Connect enables the sending of real-time data updates to external applications. These updates are generated by user transactions as the envelope progresses through actions to completion. The Connect Service provides updated information about the status of these transactions and returns updates that include the actual content of document form fields. Be aware that, these updates might or might not include the document itself. For more information about Connect, see the [ML:DocuSign Connect Service Guide]. ###### Note: Connect must be enabled for your account to use this function. This cannot be used to set up Connect configurations for Salesforce or eOriginal.

Exceptions

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

Parameters

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

Returns: ConnectCustomConfiguration

Implements DocuSign.eSign.Api.IConnectApi.

◆ CreateConfigurationAsync()

async System.Threading.Tasks.Task<ConnectCustomConfiguration> DocuSign.eSign.Api.ConnectApi.CreateConfigurationAsync	(	string	accountId,
		ConnectCustomConfiguration	connectCustomConfiguration = `null`
	)

inline

Creates a connect configuration for the specified account. Creates a DocuSign Custom Connect definition for your account. DocuSign Connect enables the sending of real-time data updates to external applications. These updates are generated by user transactions as the envelope progresses through actions to completion. The Connect Service provides updated information about the status of these transactions and returns updates that include the actual content of document form fields. Be aware that, these updates might or might not include the document itself. For more information about Connect, see the [ML:DocuSign Connect Service Guide]. ###### Note: Connect must be enabled for your account to use this function. This cannot be used to set up Connect configurations for Salesforce or eOriginal.

Exceptions

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

Parameters

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

Returns: Task of ConnectCustomConfiguration

Implements DocuSign.eSign.Api.IConnectApi.

◆ CreateConfigurationAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<ConnectCustomConfiguration> > DocuSign.eSign.Api.ConnectApi.CreateConfigurationAsyncWithHttpInfo	(	string	accountId,
		ConnectCustomConfiguration	connectCustomConfiguration = `null`
	)

inline

Creates a connect configuration for the specified account. Creates a DocuSign Custom Connect definition for your account. DocuSign Connect enables the sending of real-time data updates to external applications. These updates are generated by user transactions as the envelope progresses through actions to completion. The Connect Service provides updated information about the status of these transactions and returns updates that include the actual content of document form fields. Be aware that, these updates might or might not include the document itself. For more information about Connect, see the [ML:DocuSign Connect Service Guide]. ###### Note: Connect must be enabled for your account to use this function. This cannot be used to set up Connect configurations for Salesforce or eOriginal.

Exceptions

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

Parameters

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

Returns: Task of ApiResponse (ConnectCustomConfiguration)

Implements DocuSign.eSign.Api.IConnectApi.

◆ CreateConfigurationWithHttpInfo()

ApiResponse<ConnectCustomConfiguration> DocuSign.eSign.Api.ConnectApi.CreateConfigurationWithHttpInfo	(	string	accountId,
		ConnectCustomConfiguration	connectCustomConfiguration = `null`
	)

inline

Creates a connect configuration for the specified account. Creates a DocuSign Custom Connect definition for your account. DocuSign Connect enables the sending of real-time data updates to external applications. These updates are generated by user transactions as the envelope progresses through actions to completion. The Connect Service provides updated information about the status of these transactions and returns updates that include the actual content of document form fields. Be aware that, these updates might or might not include the document itself. For more information about Connect, see the [ML:DocuSign Connect Service Guide]. ###### Note: Connect must be enabled for your account to use this function. This cannot be used to set up Connect configurations for Salesforce or eOriginal.

Exceptions

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

Parameters

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

Returns: ApiResponse of ConnectCustomConfiguration

Implements DocuSign.eSign.Api.IConnectApi.

◆ CreateConnectOAuthConfig()

ConnectOAuthConfig DocuSign.eSign.Api.ConnectApi.CreateConnectOAuthConfig	(	string	accountId,
		ConnectOAuthConfig	connectOAuthConfig = `null`
	)

inline

Sets the Connect OAuth Config for the account.

Exceptions

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

Parameters

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

Returns: ConnectOAuthConfig

Implements DocuSign.eSign.Api.IConnectApi.

◆ CreateConnectOAuthConfigAsync()

async System.Threading.Tasks.Task<ConnectOAuthConfig> DocuSign.eSign.Api.ConnectApi.CreateConnectOAuthConfigAsync	(	string	accountId,
		ConnectOAuthConfig	connectOAuthConfig = `null`
	)

inline

Sets the Connect OAuth Config for the account.

Exceptions

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

Parameters

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

Returns: Task of ConnectOAuthConfig

Implements DocuSign.eSign.Api.IConnectApi.

◆ CreateConnectOAuthConfigAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<ConnectOAuthConfig> > DocuSign.eSign.Api.ConnectApi.CreateConnectOAuthConfigAsyncWithHttpInfo	(	string	accountId,
		ConnectOAuthConfig	connectOAuthConfig = `null`
	)

inline

Sets the Connect OAuth Config for the account.

Exceptions

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

Parameters

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

Returns: Task of ApiResponse (ConnectOAuthConfig)

Implements DocuSign.eSign.Api.IConnectApi.

◆ CreateConnectOAuthConfigWithHttpInfo()

ApiResponse<ConnectOAuthConfig> DocuSign.eSign.Api.ConnectApi.CreateConnectOAuthConfigWithHttpInfo	(	string	accountId,
		ConnectOAuthConfig	connectOAuthConfig = `null`
	)

inline

Sets the Connect OAuth Config for the account.

Exceptions

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

Parameters

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

Returns: ApiResponse of ConnectOAuthConfig

Implements DocuSign.eSign.Api.IConnectApi.

◆ DeleteConfiguration()

void DocuSign.eSign.Api.ConnectApi.DeleteConfiguration	(	string	accountId,
		string	connectId
	)

inline

Deletes the specified connect configuration. Deletes the specified DocuSign Connect configuration. ###### Note: Connect must be enabled for your account to use this function.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
connectId	The ID of the custom Connect configuration being accessed.

Returns

Implements DocuSign.eSign.Api.IConnectApi.

◆ DeleteConfigurationAsync()

async System.Threading.Tasks.Task DocuSign.eSign.Api.ConnectApi.DeleteConfigurationAsync	(	string	accountId,
		string	connectId
	)

inline

Deletes the specified connect configuration. Deletes the specified DocuSign Connect configuration. ###### Note: Connect must be enabled for your account to use this function.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
connectId	The ID of the custom Connect configuration being accessed.

Returns: Task of void

Implements DocuSign.eSign.Api.IConnectApi.

◆ DeleteConfigurationAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.ConnectApi.DeleteConfigurationAsyncWithHttpInfo	(	string	accountId,
		string	connectId
	)

inline

Deletes the specified connect configuration. Deletes the specified DocuSign Connect configuration. ###### Note: Connect must be enabled for your account to use this function.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
connectId	The ID of the custom Connect configuration being accessed.

Returns: Task of ApiResponse

Implements DocuSign.eSign.Api.IConnectApi.

◆ DeleteConfigurationWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.ConnectApi.DeleteConfigurationWithHttpInfo	(	string	accountId,
		string	connectId
	)

inline

Deletes the specified connect configuration. Deletes the specified DocuSign Connect configuration. ###### Note: Connect must be enabled for your account to use this function.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
connectId	The ID of the custom Connect configuration being accessed.

Returns: ApiResponse of Object(void)

Implements DocuSign.eSign.Api.IConnectApi.

◆ DeleteConnectOAuthConfig()

void DocuSign.eSign.Api.ConnectApi.DeleteConnectOAuthConfig ( string accountId )

inline

Sets the Connect OAuth Config for the account.

Exceptions

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

Parameters

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

Returns

Implements DocuSign.eSign.Api.IConnectApi.

◆ DeleteConnectOAuthConfigAsync()

async System.Threading.Tasks.Task DocuSign.eSign.Api.ConnectApi.DeleteConnectOAuthConfigAsync ( string accountId )

inline

Sets the Connect OAuth Config for the account.

Exceptions

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

Parameters

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

Returns: Task of void

Implements DocuSign.eSign.Api.IConnectApi.

◆ DeleteConnectOAuthConfigAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.ConnectApi.DeleteConnectOAuthConfigAsyncWithHttpInfo ( string accountId )

inline

Sets the Connect OAuth Config for the account.

Exceptions

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

Parameters

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

Returns: Task of ApiResponse

Implements DocuSign.eSign.Api.IConnectApi.

◆ DeleteConnectOAuthConfigWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.ConnectApi.DeleteConnectOAuthConfigWithHttpInfo ( string accountId )

inline

Sets the Connect OAuth Config for the account.

Exceptions

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

Parameters

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

Returns: ApiResponse of Object(void)

Implements DocuSign.eSign.Api.IConnectApi.

◆ DeleteEventFailureLog()

ConnectDeleteFailureResult DocuSign.eSign.Api.ConnectApi.DeleteEventFailureLog	(	string	accountId,
		string	failureId
	)

inline

Deletes a Connect failure log entry. Deletes the Connect failure log information for the specified entry.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
failureId	The ID of the failed connect log entry.

Returns: ConnectDeleteFailureResult

Implements DocuSign.eSign.Api.IConnectApi.

◆ DeleteEventFailureLogAsync()

async System.Threading.Tasks.Task<ConnectDeleteFailureResult> DocuSign.eSign.Api.ConnectApi.DeleteEventFailureLogAsync	(	string	accountId,
		string	failureId
	)

inline

Deletes a Connect failure log entry. Deletes the Connect failure log information for the specified entry.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
failureId	The ID of the failed connect log entry.

Returns: Task of ConnectDeleteFailureResult

Implements DocuSign.eSign.Api.IConnectApi.

◆ DeleteEventFailureLogAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<ConnectDeleteFailureResult> > DocuSign.eSign.Api.ConnectApi.DeleteEventFailureLogAsyncWithHttpInfo	(	string	accountId,
		string	failureId
	)

inline

Deletes a Connect failure log entry. Deletes the Connect failure log information for the specified entry.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
failureId	The ID of the failed connect log entry.

Returns: Task of ApiResponse (ConnectDeleteFailureResult)

Implements DocuSign.eSign.Api.IConnectApi.

◆ DeleteEventFailureLogWithHttpInfo()

ApiResponse<ConnectDeleteFailureResult> DocuSign.eSign.Api.ConnectApi.DeleteEventFailureLogWithHttpInfo	(	string	accountId,
		string	failureId
	)

inline

Deletes a Connect failure log entry. Deletes the Connect failure log information for the specified entry.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
failureId	The ID of the failed connect log entry.

Returns: ApiResponse of ConnectDeleteFailureResult

Implements DocuSign.eSign.Api.IConnectApi.

◆ DeleteEventLog()

void DocuSign.eSign.Api.ConnectApi.DeleteEventLog	(	string	accountId,
		string	logId
	)

inline

Deletes a specified Connect log entry. Deletes a specified entry from the Connect Log.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
logId	The ID of the connect log entry

Returns

Implements DocuSign.eSign.Api.IConnectApi.

◆ DeleteEventLogAsync()

async System.Threading.Tasks.Task DocuSign.eSign.Api.ConnectApi.DeleteEventLogAsync	(	string	accountId,
		string	logId
	)

inline

Deletes a specified Connect log entry. Deletes a specified entry from the Connect Log.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
logId	The ID of the connect log entry

Returns: Task of void

Implements DocuSign.eSign.Api.IConnectApi.

◆ DeleteEventLogAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.ConnectApi.DeleteEventLogAsyncWithHttpInfo	(	string	accountId,
		string	logId
	)

inline

Deletes a specified Connect log entry. Deletes a specified entry from the Connect Log.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
logId	The ID of the connect log entry

Returns: Task of ApiResponse

Implements DocuSign.eSign.Api.IConnectApi.

◆ DeleteEventLogs()

void DocuSign.eSign.Api.ConnectApi.DeleteEventLogs ( string accountId )

inline

Gets a list of Connect log entries. Retrieves a list of connect log entries for your account. ###### Note: The `enableLog` property in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded.

Exceptions

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

Parameters

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

Returns

Implements DocuSign.eSign.Api.IConnectApi.

◆ DeleteEventLogsAsync()

async System.Threading.Tasks.Task DocuSign.eSign.Api.ConnectApi.DeleteEventLogsAsync ( string accountId )

inline

Gets a list of Connect log entries. Retrieves a list of connect log entries for your account. ###### Note: The `enableLog` property in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded.

Exceptions

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

Parameters

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

Returns: Task of void

Implements DocuSign.eSign.Api.IConnectApi.

◆ DeleteEventLogsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.ConnectApi.DeleteEventLogsAsyncWithHttpInfo ( string accountId )

inline

Gets a list of Connect log entries. Retrieves a list of connect log entries for your account. ###### Note: The `enableLog` property in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded.

Exceptions

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

Parameters

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

Returns: Task of ApiResponse

Implements DocuSign.eSign.Api.IConnectApi.

◆ DeleteEventLogsWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.ConnectApi.DeleteEventLogsWithHttpInfo ( string accountId )

inline

Gets a list of Connect log entries. Retrieves a list of connect log entries for your account. ###### Note: The `enableLog` property in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded.

Exceptions

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

Parameters

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

Returns: ApiResponse of Object(void)

Implements DocuSign.eSign.Api.IConnectApi.

◆ DeleteEventLogWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.ConnectApi.DeleteEventLogWithHttpInfo	(	string	accountId,
		string	logId
	)

inline

Deletes a specified Connect log entry. Deletes a specified entry from the Connect Log.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
logId	The ID of the connect log entry

Returns: ApiResponse of Object(void)

Implements DocuSign.eSign.Api.IConnectApi.

◆ DeleteMobileNotifiers()

MobileNotifierConfigurationInformation DocuSign.eSign.Api.ConnectApi.DeleteMobileNotifiers	(	string	accountId,
		MobileNotifierConfigurationInformation	mobileNotifierConfigurationInformation = `null`
	)

inline

Reserved Reserved:

Exceptions

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

Parameters

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

Returns: MobileNotifierConfigurationInformation

Implements DocuSign.eSign.Api.IConnectApi.

◆ DeleteMobileNotifiersAsync()

async System.Threading.Tasks.Task<MobileNotifierConfigurationInformation> DocuSign.eSign.Api.ConnectApi.DeleteMobileNotifiersAsync	(	string	accountId,
		MobileNotifierConfigurationInformation	mobileNotifierConfigurationInformation = `null`
	)

inline

Reserved Reserved:

Exceptions

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

Parameters

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

Returns: Task of MobileNotifierConfigurationInformation

Implements DocuSign.eSign.Api.IConnectApi.

◆ DeleteMobileNotifiersAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<MobileNotifierConfigurationInformation> > DocuSign.eSign.Api.ConnectApi.DeleteMobileNotifiersAsyncWithHttpInfo	(	string	accountId,
		MobileNotifierConfigurationInformation	mobileNotifierConfigurationInformation = `null`
	)

inline

Reserved Reserved:

Exceptions

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

Parameters

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

Returns: Task of ApiResponse (MobileNotifierConfigurationInformation)

Implements DocuSign.eSign.Api.IConnectApi.

◆ DeleteMobileNotifiersWithHttpInfo()

ApiResponse<MobileNotifierConfigurationInformation> DocuSign.eSign.Api.ConnectApi.DeleteMobileNotifiersWithHttpInfo	(	string	accountId,
		MobileNotifierConfigurationInformation	mobileNotifierConfigurationInformation = `null`
	)

inline

Reserved Reserved:

Exceptions

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

Parameters

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

Returns: ApiResponse of MobileNotifierConfigurationInformation

Implements DocuSign.eSign.Api.IConnectApi.

◆ GetBasePath()

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

inline

Gets the base path of the API client.

The base path

Implements DocuSign.eSign.Client.IApiAccessor.

◆ GetConfiguration()

ConnectConfigResults DocuSign.eSign.Api.ConnectApi.GetConfiguration	(	string	accountId,
		string	connectId
	)

inline

Get a Connect Configuration Information Retrieves the information for the specified DocuSign Connect configuration. ###### Note: Connect must be enabled for your account to use this function.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
connectId	The ID of the custom Connect configuration being accessed.

Returns: ConnectConfigResults

Implements DocuSign.eSign.Api.IConnectApi.

◆ GetConfigurationAsync()

async System.Threading.Tasks.Task<ConnectConfigResults> DocuSign.eSign.Api.ConnectApi.GetConfigurationAsync	(	string	accountId,
		string	connectId
	)

inline

Get a Connect Configuration Information Retrieves the information for the specified DocuSign Connect configuration. ###### Note: Connect must be enabled for your account to use this function.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
connectId	The ID of the custom Connect configuration being accessed.

Returns: Task of ConnectConfigResults

Implements DocuSign.eSign.Api.IConnectApi.

◆ GetConfigurationAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<ConnectConfigResults> > DocuSign.eSign.Api.ConnectApi.GetConfigurationAsyncWithHttpInfo	(	string	accountId,
		string	connectId
	)

inline

Get a Connect Configuration Information Retrieves the information for the specified DocuSign Connect configuration. ###### Note: Connect must be enabled for your account to use this function.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
connectId	The ID of the custom Connect configuration being accessed.

Returns: Task of ApiResponse (ConnectConfigResults)

Implements DocuSign.eSign.Api.IConnectApi.

◆ GetConfigurationWithHttpInfo()

ApiResponse<ConnectConfigResults> DocuSign.eSign.Api.ConnectApi.GetConfigurationWithHttpInfo	(	string	accountId,
		string	connectId
	)

inline

Get a Connect Configuration Information Retrieves the information for the specified DocuSign Connect configuration. ###### Note: Connect must be enabled for your account to use this function.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
connectId	The ID of the custom Connect configuration being accessed.

Returns: ApiResponse of ConnectConfigResults

Implements DocuSign.eSign.Api.IConnectApi.

◆ GetConnectAllUsers()

IntegratedConnectUserInfoList DocuSign.eSign.Api.ConnectApi.GetConnectAllUsers	(	string	accountId,
		string	connectId,
		ConnectApi.GetConnectAllUsersOptions	options = `null`
	)

inline

Returns all users from the configured Connect service.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
connectId	The ID of the custom Connect configuration being accessed.
options	Options for modifying the behavior of the function.

Returns: IntegratedConnectUserInfoList

◆ GetConnectAllUsersAsync()

async System.Threading.Tasks.Task<IntegratedConnectUserInfoList> DocuSign.eSign.Api.ConnectApi.GetConnectAllUsersAsync	(	string	accountId,
		string	connectId,
		ConnectApi.GetConnectAllUsersOptions	options = `null`
	)

inline

Returns all users from the configured Connect service.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
connectId	The ID of the custom Connect configuration being accessed.
options	Options for modifying the behavior of the function.

Returns: Task of IntegratedConnectUserInfoList

◆ GetConnectAllUsersAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<IntegratedConnectUserInfoList> > DocuSign.eSign.Api.ConnectApi.GetConnectAllUsersAsyncWithHttpInfo	(	string	accountId,
		string	connectId,
		ConnectApi.GetConnectAllUsersOptions	options = `null`
	)

inline

Returns all users from the configured Connect service.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
connectId	The ID of the custom Connect configuration being accessed.
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (IntegratedConnectUserInfoList)

◆ GetConnectAllUsersWithHttpInfo()

ApiResponse<IntegratedConnectUserInfoList> DocuSign.eSign.Api.ConnectApi.GetConnectAllUsersWithHttpInfo	(	string	accountId,
		string	connectId,
		ConnectApi.GetConnectAllUsersOptions	options = `null`
	)

inline

Returns all users from the configured Connect service.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
connectId	The ID of the custom Connect configuration being accessed.
options	Options for modifying the behavior of the function.

Returns: ApiResponse of IntegratedConnectUserInfoList

◆ GetConnectOAuthConfig()

ConnectOAuthConfig DocuSign.eSign.Api.ConnectApi.GetConnectOAuthConfig ( string accountId )

inline

Sets the Connect OAuth Config for the account.

Exceptions

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

Parameters

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

Returns: ConnectOAuthConfig

Implements DocuSign.eSign.Api.IConnectApi.

◆ GetConnectOAuthConfigAsync()

async System.Threading.Tasks.Task<ConnectOAuthConfig> DocuSign.eSign.Api.ConnectApi.GetConnectOAuthConfigAsync ( string accountId )

inline

Sets the Connect OAuth Config for the account.

Exceptions

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

Parameters

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

Returns: Task of ConnectOAuthConfig

Implements DocuSign.eSign.Api.IConnectApi.

◆ GetConnectOAuthConfigAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<ConnectOAuthConfig> > DocuSign.eSign.Api.ConnectApi.GetConnectOAuthConfigAsyncWithHttpInfo ( string accountId )

inline

Sets the Connect OAuth Config for the account.

Exceptions

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

Parameters

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

Returns: Task of ApiResponse (ConnectOAuthConfig)

Implements DocuSign.eSign.Api.IConnectApi.

◆ GetConnectOAuthConfigWithHttpInfo()

ApiResponse<ConnectOAuthConfig> DocuSign.eSign.Api.ConnectApi.GetConnectOAuthConfigWithHttpInfo ( string accountId )

inline

Sets the Connect OAuth Config for the account.

Exceptions

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

Parameters

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

Returns: ApiResponse of ConnectOAuthConfig

Implements DocuSign.eSign.Api.IConnectApi.

◆ GetEventLog()

ConnectLog DocuSign.eSign.Api.ConnectApi.GetEventLog	(	string	accountId,
		string	logId,
		ConnectApi.GetEventLogOptions	options = `null`
	)

inline

Get the specified Connect log entry. Retrieves the specified Connect log entry for your account. ###### Note: The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
logId	The ID of the connect log entry
options	Options for modifying the behavior of the function.

Returns: ConnectLog

◆ GetEventLogAsync()

async System.Threading.Tasks.Task<ConnectLog> DocuSign.eSign.Api.ConnectApi.GetEventLogAsync	(	string	accountId,
		string	logId,
		ConnectApi.GetEventLogOptions	options = `null`
	)

inline

Get the specified Connect log entry. Retrieves the specified Connect log entry for your account. ###### Note: The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
logId	The ID of the connect log entry
options	Options for modifying the behavior of the function.

Returns: Task of ConnectLog

◆ GetEventLogAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<ConnectLog> > DocuSign.eSign.Api.ConnectApi.GetEventLogAsyncWithHttpInfo	(	string	accountId,
		string	logId,
		ConnectApi.GetEventLogOptions	options = `null`
	)

inline

Get the specified Connect log entry. Retrieves the specified Connect log entry for your account. ###### Note: The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
logId	The ID of the connect log entry
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (ConnectLog)

◆ GetEventLogWithHttpInfo()

ApiResponse<ConnectLog> DocuSign.eSign.Api.ConnectApi.GetEventLogWithHttpInfo	(	string	accountId,
		string	logId,
		ConnectApi.GetEventLogOptions	options = `null`
	)

inline

Get the specified Connect log entry. Retrieves the specified Connect log entry for your account. ###### Note: The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
logId	The ID of the connect log entry
options	Options for modifying the behavior of the function.

Returns: ApiResponse of ConnectLog

◆ ListConfigurations()

ConnectConfigResults DocuSign.eSign.Api.ConnectApi.ListConfigurations ( string accountId )

inline

Get Connect Configuration Information Retrieves all the DocuSign Custom Connect definitions for the specified account. ###### Note: Connect must be enabled for your account to use this function. This does not retrieve information for Connect configurations for Box, eOriginal, or Salesforce.

Exceptions

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

Parameters

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

Returns: ConnectConfigResults

Implements DocuSign.eSign.Api.IConnectApi.

◆ ListConfigurationsAsync()

async System.Threading.Tasks.Task<ConnectConfigResults> DocuSign.eSign.Api.ConnectApi.ListConfigurationsAsync ( string accountId )

inline

Get Connect Configuration Information Retrieves all the DocuSign Custom Connect definitions for the specified account. ###### Note: Connect must be enabled for your account to use this function. This does not retrieve information for Connect configurations for Box, eOriginal, or Salesforce.

Exceptions

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

Parameters

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

Returns: Task of ConnectConfigResults

Implements DocuSign.eSign.Api.IConnectApi.

◆ ListConfigurationsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<ConnectConfigResults> > DocuSign.eSign.Api.ConnectApi.ListConfigurationsAsyncWithHttpInfo ( string accountId )

inline

Get Connect Configuration Information Retrieves all the DocuSign Custom Connect definitions for the specified account. ###### Note: Connect must be enabled for your account to use this function. This does not retrieve information for Connect configurations for Box, eOriginal, or Salesforce.

Exceptions

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

Parameters

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

Returns: Task of ApiResponse (ConnectConfigResults)

Implements DocuSign.eSign.Api.IConnectApi.

◆ ListConfigurationsWithHttpInfo()

ApiResponse<ConnectConfigResults> DocuSign.eSign.Api.ConnectApi.ListConfigurationsWithHttpInfo ( string accountId )

inline

Get Connect Configuration Information Retrieves all the DocuSign Custom Connect definitions for the specified account. ###### Note: Connect must be enabled for your account to use this function. This does not retrieve information for Connect configurations for Box, eOriginal, or Salesforce.

Exceptions

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

Parameters

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

Returns: ApiResponse of ConnectConfigResults

Implements DocuSign.eSign.Api.IConnectApi.

◆ ListEventFailureLogs()

ConnectLogs DocuSign.eSign.Api.ConnectApi.ListEventFailureLogs	(	string	accountId,
		ConnectApi.ListEventFailureLogsOptions	options = `null`
	)

inline

Gets the Connect failure log information. Retrieves the Connect Failure Log information. It can be used to determine which envelopes failed to post, so a republish request can be created.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: ConnectLogs

◆ ListEventFailureLogsAsync()

async System.Threading.Tasks.Task<ConnectLogs> DocuSign.eSign.Api.ConnectApi.ListEventFailureLogsAsync	(	string	accountId,
		ConnectApi.ListEventFailureLogsOptions	options = `null`
	)

inline

Gets the Connect failure log information. Retrieves the Connect Failure Log information. It can be used to determine which envelopes failed to post, so a republish request can be created.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: Task of ConnectLogs

◆ ListEventFailureLogsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<ConnectLogs> > DocuSign.eSign.Api.ConnectApi.ListEventFailureLogsAsyncWithHttpInfo	(	string	accountId,
		ConnectApi.ListEventFailureLogsOptions	options = `null`
	)

inline

Gets the Connect failure log information. Retrieves the Connect Failure Log information. It can be used to determine which envelopes failed to post, so a republish request can be created.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (ConnectLogs)

◆ ListEventFailureLogsWithHttpInfo()

ApiResponse<ConnectLogs> DocuSign.eSign.Api.ConnectApi.ListEventFailureLogsWithHttpInfo	(	string	accountId,
		ConnectApi.ListEventFailureLogsOptions	options = `null`
	)

inline

Gets the Connect failure log information. Retrieves the Connect Failure Log information. It can be used to determine which envelopes failed to post, so a republish request can be created.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: ApiResponse of ConnectLogs

◆ ListEventLogs()

ConnectLogs DocuSign.eSign.Api.ConnectApi.ListEventLogs	(	string	accountId,
		ConnectApi.ListEventLogsOptions	options = `null`
	)

inline

Gets the Connect log. Retrieves a list of connect log entries for your account. ###### Note: The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: ConnectLogs

◆ ListEventLogsAsync()

async System.Threading.Tasks.Task<ConnectLogs> DocuSign.eSign.Api.ConnectApi.ListEventLogsAsync	(	string	accountId,
		ConnectApi.ListEventLogsOptions	options = `null`
	)

inline

Gets the Connect log. Retrieves a list of connect log entries for your account. ###### Note: The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: Task of ConnectLogs

◆ ListEventLogsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<ConnectLogs> > DocuSign.eSign.Api.ConnectApi.ListEventLogsAsyncWithHttpInfo	(	string	accountId,
		ConnectApi.ListEventLogsOptions	options = `null`
	)

inline

Gets the Connect log. Retrieves a list of connect log entries for your account. ###### Note: The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (ConnectLogs)

◆ ListEventLogsWithHttpInfo()

ApiResponse<ConnectLogs> DocuSign.eSign.Api.ConnectApi.ListEventLogsWithHttpInfo	(	string	accountId,
		ConnectApi.ListEventLogsOptions	options = `null`
	)

inline

Gets the Connect log. Retrieves a list of connect log entries for your account. ###### Note: The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: ApiResponse of ConnectLogs

◆ ListMobileNotifiers()

MobileNotifierConfigurationInformation DocuSign.eSign.Api.ConnectApi.ListMobileNotifiers ( string accountId )

inline

Reserved Reserved:

Exceptions

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

Parameters

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

Returns: MobileNotifierConfigurationInformation

Implements DocuSign.eSign.Api.IConnectApi.

◆ ListMobileNotifiersAsync()

async System.Threading.Tasks.Task<MobileNotifierConfigurationInformation> DocuSign.eSign.Api.ConnectApi.ListMobileNotifiersAsync ( string accountId )

inline

Reserved Reserved:

Exceptions

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

Parameters

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

Returns: Task of MobileNotifierConfigurationInformation

Implements DocuSign.eSign.Api.IConnectApi.

◆ ListMobileNotifiersAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<MobileNotifierConfigurationInformation> > DocuSign.eSign.Api.ConnectApi.ListMobileNotifiersAsyncWithHttpInfo ( string accountId )

inline

Reserved Reserved:

Exceptions

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

Parameters

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

Returns: Task of ApiResponse (MobileNotifierConfigurationInformation)

Implements DocuSign.eSign.Api.IConnectApi.

◆ ListMobileNotifiersWithHttpInfo()

ApiResponse<MobileNotifierConfigurationInformation> DocuSign.eSign.Api.ConnectApi.ListMobileNotifiersWithHttpInfo ( string accountId )

inline

Reserved Reserved:

Exceptions

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

Parameters

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

Returns: ApiResponse of MobileNotifierConfigurationInformation

Implements DocuSign.eSign.Api.IConnectApi.

◆ ListUsers()

IntegratedUserInfoList DocuSign.eSign.Api.ConnectApi.ListUsers	(	string	accountId,
		string	connectId,
		ConnectApi.ListUsersOptions	options = `null`
	)

inline

Returns users from the configured Connect service. Returns users from the configured Connect service.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
connectId	The ID of the custom Connect configuration being accessed.
options	Options for modifying the behavior of the function.

Returns: IntegratedUserInfoList

◆ ListUsersAsync()

async System.Threading.Tasks.Task<IntegratedUserInfoList> DocuSign.eSign.Api.ConnectApi.ListUsersAsync	(	string	accountId,
		string	connectId,
		ConnectApi.ListUsersOptions	options = `null`
	)

inline

Returns users from the configured Connect service. Returns users from the configured Connect service.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
connectId	The ID of the custom Connect configuration being accessed.
options	Options for modifying the behavior of the function.

Returns: Task of IntegratedUserInfoList

◆ ListUsersAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<IntegratedUserInfoList> > DocuSign.eSign.Api.ConnectApi.ListUsersAsyncWithHttpInfo	(	string	accountId,
		string	connectId,
		ConnectApi.ListUsersOptions	options = `null`
	)

inline

Returns users from the configured Connect service. Returns users from the configured Connect service.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
connectId	The ID of the custom Connect configuration being accessed.
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (IntegratedUserInfoList)

◆ ListUsersWithHttpInfo()

ApiResponse<IntegratedUserInfoList> DocuSign.eSign.Api.ConnectApi.ListUsersWithHttpInfo	(	string	accountId,
		string	connectId,
		ConnectApi.ListUsersOptions	options = `null`
	)

inline

Returns users from the configured Connect service. Returns users from the configured Connect service.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
connectId	The ID of the custom Connect configuration being accessed.
options	Options for modifying the behavior of the function.

Returns: ApiResponse of IntegratedUserInfoList

◆ RetryEventForEnvelope()

ConnectFailureResults DocuSign.eSign.Api.ConnectApi.RetryEventForEnvelope	(	string	accountId,
		string	envelopeId
	)

inline

Republishes Connect information for the specified envelope. Republishes Connect information for the specified envelope.

Exceptions

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

Parameters

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

Returns: ConnectFailureResults

Implements DocuSign.eSign.Api.IConnectApi.

◆ RetryEventForEnvelopeAsync()

async System.Threading.Tasks.Task<ConnectFailureResults> DocuSign.eSign.Api.ConnectApi.RetryEventForEnvelopeAsync	(	string	accountId,
		string	envelopeId
	)

inline

Republishes Connect information for the specified envelope. Republishes Connect information for the specified envelope.

Exceptions

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

Parameters

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

Returns: Task of ConnectFailureResults

Implements DocuSign.eSign.Api.IConnectApi.

◆ RetryEventForEnvelopeAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<ConnectFailureResults> > DocuSign.eSign.Api.ConnectApi.RetryEventForEnvelopeAsyncWithHttpInfo	(	string	accountId,
		string	envelopeId
	)

inline

Republishes Connect information for the specified envelope. Republishes Connect information for the specified envelope.

Exceptions

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

Parameters

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

Returns: Task of ApiResponse (ConnectFailureResults)

Implements DocuSign.eSign.Api.IConnectApi.

◆ RetryEventForEnvelopes()

ConnectFailureResults DocuSign.eSign.Api.ConnectApi.RetryEventForEnvelopes	(	string	accountId,
		ConnectFailureFilter	connectFailureFilter = `null`
	)

inline

Republishes Connect information for multiple envelopes. Republishes Connect information for the specified set of envelopes. The primary use is to republish Connect post failures by including envelope IDs for the envelopes that failed to post in the request. The list of envelope IDs that failed to post correctly can be retrieved by calling to [ML:GetConnectLog] retrieve the failure log.

Exceptions

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

Parameters

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

Returns: ConnectFailureResults

Implements DocuSign.eSign.Api.IConnectApi.

◆ RetryEventForEnvelopesAsync()

async System.Threading.Tasks.Task<ConnectFailureResults> DocuSign.eSign.Api.ConnectApi.RetryEventForEnvelopesAsync	(	string	accountId,
		ConnectFailureFilter	connectFailureFilter = `null`
	)

inline

Republishes Connect information for multiple envelopes. Republishes Connect information for the specified set of envelopes. The primary use is to republish Connect post failures by including envelope IDs for the envelopes that failed to post in the request. The list of envelope IDs that failed to post correctly can be retrieved by calling to [ML:GetConnectLog] retrieve the failure log.

Exceptions

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

Parameters

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

Returns: Task of ConnectFailureResults

Implements DocuSign.eSign.Api.IConnectApi.

◆ RetryEventForEnvelopesAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<ConnectFailureResults> > DocuSign.eSign.Api.ConnectApi.RetryEventForEnvelopesAsyncWithHttpInfo	(	string	accountId,
		ConnectFailureFilter	connectFailureFilter = `null`
	)

inline

Republishes Connect information for multiple envelopes. Republishes Connect information for the specified set of envelopes. The primary use is to republish Connect post failures by including envelope IDs for the envelopes that failed to post in the request. The list of envelope IDs that failed to post correctly can be retrieved by calling to [ML:GetConnectLog] retrieve the failure log.

Exceptions

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

Parameters

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

Returns: Task of ApiResponse (ConnectFailureResults)

Implements DocuSign.eSign.Api.IConnectApi.

◆ RetryEventForEnvelopesWithHttpInfo()

ApiResponse<ConnectFailureResults> DocuSign.eSign.Api.ConnectApi.RetryEventForEnvelopesWithHttpInfo	(	string	accountId,
		ConnectFailureFilter	connectFailureFilter = `null`
	)

inline

Republishes Connect information for multiple envelopes. Republishes Connect information for the specified set of envelopes. The primary use is to republish Connect post failures by including envelope IDs for the envelopes that failed to post in the request. The list of envelope IDs that failed to post correctly can be retrieved by calling to [ML:GetConnectLog] retrieve the failure log.

Exceptions

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

Parameters

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

Returns: ApiResponse of ConnectFailureResults

Implements DocuSign.eSign.Api.IConnectApi.

◆ RetryEventForEnvelopeWithHttpInfo()

ApiResponse<ConnectFailureResults> DocuSign.eSign.Api.ConnectApi.RetryEventForEnvelopeWithHttpInfo	(	string	accountId,
		string	envelopeId
	)

inline

Republishes Connect information for the specified envelope. Republishes Connect information for the specified envelope.

Exceptions

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

Parameters

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

Returns: ApiResponse of ConnectFailureResults

Implements DocuSign.eSign.Api.IConnectApi.

◆ UpdateConfiguration()

ConnectCustomConfiguration DocuSign.eSign.Api.ConnectApi.UpdateConfiguration	(	string	accountId,
		ConnectCustomConfiguration	connectCustomConfiguration = `null`
	)

inline

Updates a specified Connect configuration. Updates the specified DocuSign Connect configuration in your account. ###### Note: Connect must be enabled for your account to use this function. This cannot be used to update Connect configurations for Box, eOriginal, or Salesforce.

Exceptions

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

Parameters

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

Returns: ConnectCustomConfiguration

Implements DocuSign.eSign.Api.IConnectApi.

◆ UpdateConfigurationAsync()

async System.Threading.Tasks.Task<ConnectCustomConfiguration> DocuSign.eSign.Api.ConnectApi.UpdateConfigurationAsync	(	string	accountId,
		ConnectCustomConfiguration	connectCustomConfiguration = `null`
	)

inline

Updates a specified Connect configuration. Updates the specified DocuSign Connect configuration in your account. ###### Note: Connect must be enabled for your account to use this function. This cannot be used to update Connect configurations for Box, eOriginal, or Salesforce.

Exceptions

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

Parameters

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

Returns: Task of ConnectCustomConfiguration

Implements DocuSign.eSign.Api.IConnectApi.

◆ UpdateConfigurationAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<ConnectCustomConfiguration> > DocuSign.eSign.Api.ConnectApi.UpdateConfigurationAsyncWithHttpInfo	(	string	accountId,
		ConnectCustomConfiguration	connectCustomConfiguration = `null`
	)

inline

Updates a specified Connect configuration. Updates the specified DocuSign Connect configuration in your account. ###### Note: Connect must be enabled for your account to use this function. This cannot be used to update Connect configurations for Box, eOriginal, or Salesforce.

Exceptions

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

Parameters

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

Returns: Task of ApiResponse (ConnectCustomConfiguration)

Implements DocuSign.eSign.Api.IConnectApi.

◆ UpdateConfigurationWithHttpInfo()

ApiResponse<ConnectCustomConfiguration> DocuSign.eSign.Api.ConnectApi.UpdateConfigurationWithHttpInfo	(	string	accountId,
		ConnectCustomConfiguration	connectCustomConfiguration = `null`
	)

inline

Updates a specified Connect configuration. Updates the specified DocuSign Connect configuration in your account. ###### Note: Connect must be enabled for your account to use this function. This cannot be used to update Connect configurations for Box, eOriginal, or Salesforce.

Exceptions

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

Parameters

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

Returns: ApiResponse of ConnectCustomConfiguration

Implements DocuSign.eSign.Api.IConnectApi.

◆ UpdateConnectOAuthConfig()

ConnectOAuthConfig DocuSign.eSign.Api.ConnectApi.UpdateConnectOAuthConfig	(	string	accountId,
		ConnectOAuthConfig	connectOAuthConfig = `null`
	)

inline

Updates the existing Connect OAuth Config for the account.

Exceptions

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

Parameters

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

Returns: ConnectOAuthConfig

Implements DocuSign.eSign.Api.IConnectApi.

◆ UpdateConnectOAuthConfigAsync()

async System.Threading.Tasks.Task<ConnectOAuthConfig> DocuSign.eSign.Api.ConnectApi.UpdateConnectOAuthConfigAsync	(	string	accountId,
		ConnectOAuthConfig	connectOAuthConfig = `null`
	)

inline

Updates the existing Connect OAuth Config for the account.

Exceptions

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

Parameters

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

Returns: Task of ConnectOAuthConfig

Implements DocuSign.eSign.Api.IConnectApi.

◆ UpdateConnectOAuthConfigAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<ConnectOAuthConfig> > DocuSign.eSign.Api.ConnectApi.UpdateConnectOAuthConfigAsyncWithHttpInfo	(	string	accountId,
		ConnectOAuthConfig	connectOAuthConfig = `null`
	)

inline

Updates the existing Connect OAuth Config for the account.

Exceptions

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

Parameters

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

Returns: Task of ApiResponse (ConnectOAuthConfig)

Implements DocuSign.eSign.Api.IConnectApi.

◆ UpdateConnectOAuthConfigWithHttpInfo()

ApiResponse<ConnectOAuthConfig> DocuSign.eSign.Api.ConnectApi.UpdateConnectOAuthConfigWithHttpInfo	(	string	accountId,
		ConnectOAuthConfig	connectOAuthConfig = `null`
	)

inline

Updates the existing Connect OAuth Config for the account.

Exceptions

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

Parameters

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

Returns: ApiResponse of ConnectOAuthConfig

Implements DocuSign.eSign.Api.IConnectApi.

◆ UpdateMobileNotifiers()

MobileNotifierConfigurationInformation DocuSign.eSign.Api.ConnectApi.UpdateMobileNotifiers	(	string	accountId,
		MobileNotifierConfigurationInformation	mobileNotifierConfigurationInformation = `null`
	)

inline

Reserved Reserved:

Exceptions

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

Parameters

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

Returns: MobileNotifierConfigurationInformation

Implements DocuSign.eSign.Api.IConnectApi.

◆ UpdateMobileNotifiersAsync()

async System.Threading.Tasks.Task<MobileNotifierConfigurationInformation> DocuSign.eSign.Api.ConnectApi.UpdateMobileNotifiersAsync	(	string	accountId,
		MobileNotifierConfigurationInformation	mobileNotifierConfigurationInformation = `null`
	)

inline

Reserved Reserved:

Exceptions

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

Parameters

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

Returns: Task of MobileNotifierConfigurationInformation

Implements DocuSign.eSign.Api.IConnectApi.

◆ UpdateMobileNotifiersAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<MobileNotifierConfigurationInformation> > DocuSign.eSign.Api.ConnectApi.UpdateMobileNotifiersAsyncWithHttpInfo	(	string	accountId,
		MobileNotifierConfigurationInformation	mobileNotifierConfigurationInformation = `null`
	)

inline

Reserved Reserved:

Exceptions

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

Parameters

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

Returns: Task of ApiResponse (MobileNotifierConfigurationInformation)

Implements DocuSign.eSign.Api.IConnectApi.

◆ UpdateMobileNotifiersWithHttpInfo()

ApiResponse<MobileNotifierConfigurationInformation> DocuSign.eSign.Api.ConnectApi.UpdateMobileNotifiersWithHttpInfo	(	string	accountId,
		MobileNotifierConfigurationInformation	mobileNotifierConfigurationInformation = `null`
	)

inline

Reserved Reserved:

Exceptions

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

Parameters

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

Returns: ApiResponse of MobileNotifierConfigurationInformation

Implements DocuSign.eSign.Api.IConnectApi.

Property Documentation

◆ ApiClient

DocuSignClient DocuSign.eSign.Api.ConnectApi.ApiClient

getset

Gets or sets the ApiClient object

An instance of the ApiClient

◆ ExceptionFactory

DocuSign.eSign.Client.ExceptionFactory DocuSign.eSign.Api.ConnectApi.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/ConnectApi.cs

Classes

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ ConnectApi()

Member Function Documentation

◆ CreateConfiguration()

◆ CreateConfigurationAsync()

◆ CreateConfigurationAsyncWithHttpInfo()

◆ CreateConfigurationWithHttpInfo()

◆ CreateConnectOAuthConfig()

◆ CreateConnectOAuthConfigAsync()

◆ CreateConnectOAuthConfigAsyncWithHttpInfo()

◆ CreateConnectOAuthConfigWithHttpInfo()

◆ DeleteConfiguration()

◆ DeleteConfigurationAsync()

◆ DeleteConfigurationAsyncWithHttpInfo()

◆ DeleteConfigurationWithHttpInfo()

◆ DeleteConnectOAuthConfig()

◆ DeleteConnectOAuthConfigAsync()

◆ DeleteConnectOAuthConfigAsyncWithHttpInfo()

◆ DeleteConnectOAuthConfigWithHttpInfo()

◆ DeleteEventFailureLog()

◆ DeleteEventFailureLogAsync()

◆ DeleteEventFailureLogAsyncWithHttpInfo()

◆ DeleteEventFailureLogWithHttpInfo()

◆ DeleteEventLog()

◆ DeleteEventLogAsync()

◆ DeleteEventLogAsyncWithHttpInfo()

◆ DeleteEventLogs()

◆ DeleteEventLogsAsync()

◆ DeleteEventLogsAsyncWithHttpInfo()

◆ DeleteEventLogsWithHttpInfo()

◆ DeleteEventLogWithHttpInfo()

◆ DeleteMobileNotifiers()

◆ DeleteMobileNotifiersAsync()

◆ DeleteMobileNotifiersAsyncWithHttpInfo()

◆ DeleteMobileNotifiersWithHttpInfo()

◆ GetBasePath()

◆ GetConfiguration()

◆ GetConfigurationAsync()

◆ GetConfigurationAsyncWithHttpInfo()

◆ GetConfigurationWithHttpInfo()

◆ GetConnectAllUsers()

◆ GetConnectAllUsersAsync()

◆ GetConnectAllUsersAsyncWithHttpInfo()

◆ GetConnectAllUsersWithHttpInfo()

◆ GetConnectOAuthConfig()

◆ GetConnectOAuthConfigAsync()

◆ GetConnectOAuthConfigAsyncWithHttpInfo()

◆ GetConnectOAuthConfigWithHttpInfo()

◆ GetEventLog()

◆ GetEventLogAsync()

◆ GetEventLogAsyncWithHttpInfo()

◆ GetEventLogWithHttpInfo()

◆ ListConfigurations()

◆ ListConfigurationsAsync()

◆ ListConfigurationsAsyncWithHttpInfo()

◆ ListConfigurationsWithHttpInfo()

◆ ListEventFailureLogs()

◆ ListEventFailureLogsAsync()

◆ ListEventFailureLogsAsyncWithHttpInfo()

◆ ListEventFailureLogsWithHttpInfo()

◆ ListEventLogs()

◆ ListEventLogsAsync()

◆ ListEventLogsAsyncWithHttpInfo()

◆ ListEventLogsWithHttpInfo()

◆ ListMobileNotifiers()

◆ ListMobileNotifiersAsync()

◆ ListMobileNotifiersAsyncWithHttpInfo()

◆ ListMobileNotifiersWithHttpInfo()

◆ ListUsers()

◆ ListUsersAsync()

◆ ListUsersAsyncWithHttpInfo()

◆ ListUsersWithHttpInfo()

◆ RetryEventForEnvelope()

◆ RetryEventForEnvelopeAsync()

◆ RetryEventForEnvelopeAsyncWithHttpInfo()

◆ RetryEventForEnvelopes()