Package com.docusign.esign.api

Class ConnectApi

  • public class ConnectApi
extends Object
    ConnectApi class.

    • Constructor Detail

      • ConnectApi

        public ConnectApi()
        ConnectApi.

      • ConnectApi

        public ConnectApi​(ApiClient apiClient)
        ConnectApi.

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()
        getApiClient Method.
        Returns:
        ApiClient

      • setApiClient

        public void setApiClient​(ApiClient apiClient)
        setApiClient Method.

      • 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

      • createConfigurationWithHttpInfo

        public ApiResponse<ConnectCustomConfiguration> createConfigurationWithHttpInfo​(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

      • createConnectOAuthConfig

        public ConnectOAuthConfig createConnectOAuthConfig​(String accountId,
                                                   ConnectOAuthConfig connectOAuthConfig)
                                            throws ApiException
        Sets the Connect OAuth Config for the account..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        connectOAuthConfig - (optional)
        Returns:
        ConnectOAuthConfig
        Throws:
        ApiException - if fails to make API call

      • createConnectOAuthConfigWithHttpInfo

        public ApiResponse<ConnectOAuthConfig> createConnectOAuthConfigWithHttpInfo​(String accountId,
                                                                            ConnectOAuthConfig connectOAuthConfig)
                                                                     throws ApiException
        Sets the Connect OAuth Config for the account.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        connectOAuthConfig - (optional)
        Returns:
        ConnectOAuthConfig
        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

      • deleteConfigurationWithHttpInfo

        public ApiResponse<Object> deleteConfigurationWithHttpInfo​(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

      • deleteConnectOAuthConfig

        public void deleteConnectOAuthConfig​(String accountId)
                              throws ApiException
        Sets the Connect OAuth Config for the account..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        Throws:
        ApiException - if fails to make API call

      • deleteConnectOAuthConfigWithHttpInfo

        public ApiResponse<Object> deleteConnectOAuthConfigWithHttpInfo​(String accountId)
                                                         throws ApiException
        Sets the Connect OAuth Config for the account.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        Throws:
        ApiException - if fails to make API call

      • deleteEventFailureLog

        public ConnectDeleteFailureResult 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)
        Returns:
        ConnectDeleteFailureResult
        Throws:
        ApiException - if fails to make API call

      • deleteEventFailureLogWithHttpInfo

        public ApiResponse<ConnectDeleteFailureResult> deleteEventFailureLogWithHttpInfo​(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)
        Returns:
        ConnectDeleteFailureResult
        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

      • deleteEventLogWithHttpInfo

        public ApiResponse<Object> deleteEventLogWithHttpInfo​(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

      • deleteEventLogsWithHttpInfo

        public ApiResponse<Object> deleteEventLogsWithHttpInfo​(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

      • getConfigurationWithHttpInfo

        public ApiResponse<ConnectConfigResults> getConfigurationWithHttpInfo​(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

      • getConnectAllUsers

        public IntegratedConnectUserInfoList getConnectAllUsers​(String accountId,
                                                        String connectId)
                                                 throws ApiException
        Returns all 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:
        IntegratedConnectUserInfoList
        Throws:
        ApiException

      • getConnectAllUsers

        public IntegratedConnectUserInfoList getConnectAllUsers​(String accountId,
                                                        String connectId,
                                                        ConnectApi.GetConnectAllUsersOptions options)
                                                 throws ApiException
        Returns all 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:
        IntegratedConnectUserInfoList
        Throws:
        ApiException - if fails to make API call

      • getConnectAllUsersWithHttpInfo

        public ApiResponse<IntegratedConnectUserInfoList> getConnectAllUsersWithHttpInfo​(String accountId,
                                                                                 String connectId,
                                                                                 ConnectApi.GetConnectAllUsersOptions options)
                                                                          throws ApiException
        Returns all 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:
        IntegratedConnectUserInfoList
        Throws:
        ApiException - if fails to make API call

      • getConnectOAuthConfig

        public ConnectOAuthConfig getConnectOAuthConfig​(String accountId)
                                         throws ApiException
        Sets the Connect OAuth Config for the account..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        Returns:
        ConnectOAuthConfig
        Throws:
        ApiException - if fails to make API call

      • getConnectOAuthConfigWithHttpInfo

        public ApiResponse<ConnectOAuthConfig> getConnectOAuthConfigWithHttpInfo​(String accountId)
                                                                  throws ApiException
        Sets the Connect OAuth Config for the account.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        Returns:
        ConnectOAuthConfig
        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

      • getEventLogWithHttpInfo

        public ApiResponse<ConnectLog> getEventLogWithHttpInfo​(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

      • listConfigurationsWithHttpInfo

        public ApiResponse<ConnectConfigResults> listConfigurationsWithHttpInfo​(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

      • listEventFailureLogsWithHttpInfo

        public ApiResponse<ConnectLogs> listEventFailureLogsWithHttpInfo​(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

      • listEventLogsWithHttpInfo

        public ApiResponse<ConnectLogs> listEventLogsWithHttpInfo​(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

      • listUsersWithHttpInfo

        public ApiResponse<IntegratedUserInfoList> listUsersWithHttpInfo​(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

      • retryEventForEnvelopeWithHttpInfo

        public ApiResponse<ConnectFailureResults> retryEventForEnvelopeWithHttpInfo​(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

      • retryEventForEnvelopesWithHttpInfo

        public ApiResponse<ConnectFailureResults> retryEventForEnvelopesWithHttpInfo​(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

      • updateConfigurationWithHttpInfo

        public ApiResponse<ConnectCustomConfiguration> updateConfigurationWithHttpInfo​(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