com.docusign.esign.api

Class ConnectApi

java.lang.Object

com.docusign.esign.api.ConnectApi

public class ConnectApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ConnectApi.GetEventLogOptions
class	ConnectApi.ListEventFailureLogsOptions
class	ConnectApi.ListEventLogsOptions
class	ConnectApi.ListUsersOptions

Constructor Summary

Constructors

Constructor and Description
ConnectApi()
ConnectApi(ApiClient apiClient)

Method Summary

Methods

Modifier and Type	Method and Description
ConnectCustomConfiguration	createConfiguration(String accountId, ConnectCustomConfiguration connectCustomConfiguration) Creates a connect configuration for the specified account.
void	deleteConfiguration(String accountId, String connectId) Deletes the specified connect configuration.
void	deleteEventFailureLog(String accountId, String failureId) Deletes a Connect failure log entry.
void	deleteEventLog(String accountId, String logId) Deletes a specified Connect log entry.
void	deleteEventLogs(String accountId) Gets a list of Connect log entries.
ApiClient	getApiClient()
ConnectConfigResults	getConfiguration(String accountId, String connectId) Get a Connect Configuration Information Retrieves the information for the specified DocuSign Connect configuration.
ConnectLog	getEventLog(String accountId, String logId) Get the specified Connect log entry.
ConnectLog	getEventLog(String accountId, String logId, ConnectApi.GetEventLogOptions options) Get the specified Connect log entry.
ConnectConfigResults	listConfigurations(String accountId) Get Connect Configuration Information Retrieves all the DocuSign Custom Connect definitions for the specified account.
ConnectLogs	listEventFailureLogs(String accountId) Gets the Connect failure log information.
ConnectLogs	listEventFailureLogs(String accountId, ConnectApi.ListEventFailureLogsOptions options) Gets the Connect failure log information.
ConnectLogs	listEventLogs(String accountId) Gets the Connect log.
ConnectLogs	listEventLogs(String accountId, ConnectApi.ListEventLogsOptions options) Gets the Connect log.
IntegratedUserInfoList	listUsers(String accountId, String connectId) Returns users from the configured Connect service.
IntegratedUserInfoList	listUsers(String accountId, String connectId, ConnectApi.ListUsersOptions options) Returns users from the configured Connect service.
ConnectFailureResults	retryEventForEnvelope(String accountId, String envelopeId) Republishes Connect information for the specified envelope.
ConnectFailureResults	retryEventForEnvelopes(String accountId, ConnectFailureFilter connectFailureFilter) Republishes Connect information for multiple envelopes.
void	setApiClient(ApiClient apiClient)
ConnectCustomConfiguration	updateConfiguration(String accountId, ConnectCustomConfiguration connectCustomConfiguration) Updates a specified Connect configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConnectApi

public ConnectApi()

ConnectApi

public ConnectApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createConfiguration

public ConnectCustomConfiguration createConfiguration(String accountId,
                                             ConnectCustomConfiguration connectCustomConfiguration)
                                               throws ApiException

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.

Parameters:

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

connectCustomConfiguration - (optional)

Returns:

ConnectCustomConfiguration

Throws:

ApiException - if fails to make API call

deleteConfiguration

public void deleteConfiguration(String accountId,
                       String connectId)
                         throws ApiException

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

Parameters:

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

connectId - The ID of the custom Connect configuration being accessed. (required)

Throws:

ApiException - if fails to make API call

deleteEventFailureLog

public void deleteEventFailureLog(String accountId,
                         String failureId)
                           throws ApiException

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

Parameters:

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

failureId - The ID of the failed connect log entry. (required)

Throws:

ApiException - if fails to make API call

deleteEventLog

public void deleteEventLog(String accountId,
                  String logId)
                    throws ApiException

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

Parameters:

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

logId - The ID of the connect log entry (required)

Throws:

ApiException - if fails to make API call

deleteEventLogs

public void deleteEventLogs(String accountId)
                     throws ApiException

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.

Parameters:

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

Throws:

ApiException - if fails to make API call

getConfiguration

public ConnectConfigResults getConfiguration(String accountId,
                                    String connectId)
                                      throws ApiException

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.

Parameters:

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

connectId - The ID of the custom Connect configuration being accessed. (required)

Returns:

ConnectConfigResults

Throws:

ApiException - if fails to make API call

getEventLog

public ConnectLog getEventLog(String accountId,
                     String logId)
                       throws ApiException

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.

Parameters:

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

logId - The ID of the connect log entry (required)

Returns:

ConnectLog

Throws:

ApiException

getEventLog

public ConnectLog getEventLog(String accountId,
                     String logId,
                     ConnectApi.GetEventLogOptions options)
                       throws ApiException

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.

Parameters:

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

logId - The ID of the connect log entry (required)

options - for modifying the method behavior.

Returns:

ConnectLog

Throws:

ApiException - if fails to make API call

listConfigurations

public ConnectConfigResults listConfigurations(String accountId)
                                        throws ApiException

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.

Parameters:

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

Returns:

ConnectConfigResults

Throws:

ApiException - if fails to make API call

listEventFailureLogs

public ConnectLogs listEventFailureLogs(String accountId)
                                 throws ApiException

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.

Parameters:

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

Returns:

ConnectLogs

Throws:

ApiException

listEventFailureLogs

public ConnectLogs listEventFailureLogs(String accountId,
                               ConnectApi.ListEventFailureLogsOptions options)
                                 throws ApiException

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.

Parameters:

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

options - for modifying the method behavior.

Returns:

ConnectLogs

Throws:

ApiException - if fails to make API call

listEventLogs

public ConnectLogs listEventLogs(String accountId)
                          throws ApiException

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.

Parameters:

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

Returns:

ConnectLogs

Throws:

ApiException

listEventLogs

public ConnectLogs listEventLogs(String accountId,
                        ConnectApi.ListEventLogsOptions options)
                          throws ApiException

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.

Parameters:

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

options - for modifying the method behavior.

Returns:

ConnectLogs

Throws:

ApiException - if fails to make API call

listUsers

public IntegratedUserInfoList listUsers(String accountId,
                               String connectId)
                                 throws ApiException

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

Parameters:

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

connectId - The ID of the custom Connect configuration being accessed. (required)

Returns:

IntegratedUserInfoList

Throws:

ApiException

listUsers

public IntegratedUserInfoList listUsers(String accountId,
                               String connectId,
                               ConnectApi.ListUsersOptions options)
                                 throws ApiException

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

Parameters:

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

connectId - The ID of the custom Connect configuration being accessed. (required)

options - for modifying the method behavior.

Returns:

IntegratedUserInfoList

Throws:

ApiException - if fails to make API call

retryEventForEnvelope

public ConnectFailureResults retryEventForEnvelope(String accountId,
                                          String envelopeId)
                                            throws ApiException

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

Parameters:

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

envelopeId - The envelopeId Guid of the envelope being accessed. (required)

Returns:

ConnectFailureResults

Throws:

ApiException - if fails to make API call

retryEventForEnvelopes

public ConnectFailureResults retryEventForEnvelopes(String accountId,
                                           ConnectFailureFilter connectFailureFilter)
                                             throws ApiException

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.

Parameters:

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

connectFailureFilter - (optional)

Returns:

ConnectFailureResults

Throws:

ApiException - if fails to make API call

updateConfiguration

public ConnectCustomConfiguration updateConfiguration(String accountId,
                                             ConnectCustomConfiguration connectCustomConfiguration)
                                               throws ApiException

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.

Parameters:

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

connectCustomConfiguration - (optional)

Returns:

ConnectCustomConfiguration

Throws:

ApiException - if fails to make API call