Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
package com.docusign.esign.api;
import com.docusign.esign.client.ApiClient;
import com.docusign.esign.client.ApiException;
import com.docusign.esign.client.Configuration;
import com.docusign.esign.client.Pair;
import com.docusign.esign.model.*;
import javax.ws.rs.core.GenericType;
/** ConnectApi class. */
public class ConnectApi {
private ApiClient apiClient;
/** ConnectApi. */
public ConnectApi() {
this(Configuration.getDefaultApiClient());
}
/** ConnectApi. */
public ConnectApi(ApiClient apiClient) {
this.apiClient = apiClient;
}
/**
* getApiClient Method.
*
* @return ApiClient
*/
public ApiClient getApiClient() {
return apiClient;
}
/** setApiClient Method. */
public void setApiClient(ApiClient apiClient) {
this.apiClient = apiClient;
}
/**
* 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.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param connectCustomConfiguration (optional)
* @return ConnectCustomConfiguration
* @throws ApiException if fails to make API call
*/
public ConnectCustomConfiguration createConfiguration(
String accountId, ConnectCustomConfiguration connectCustomConfiguration) throws ApiException {
Object localVarPostBody = connectCustomConfiguration;
// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new ApiException(
400, "Missing the required parameter 'accountId' when calling createConfiguration");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/connect"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()));
// query params
java.util.List localVarQueryParams = new java.util.ArrayList();
java.util.List localVarCollectionQueryParams = new java.util.ArrayList();
java.util.Map localVarHeaderParams = new java.util.HashMap();
java.util.Map localVarFormParams = new java.util.HashMap();
final String[] localVarAccepts = {"application/json"};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] {"docusignAccessCode"};
GenericType localVarReturnType =
new GenericType() {};
return apiClient.invokeAPI(
localVarPath,
"POST",
localVarQueryParams,
localVarCollectionQueryParams,
localVarPostBody,
localVarHeaderParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType);
}
/**
* Deletes the specified connect configuration.. Deletes the specified DocuSign Connect
* configuration. ###### Note: Connect must be enabled for your account to use this function.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param connectId The ID of the custom Connect configuration being accessed. (required)
* @throws ApiException if fails to make API call
*/
public void deleteConfiguration(String accountId, String connectId) throws ApiException {
Object localVarPostBody = "{}";
// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new ApiException(
400, "Missing the required parameter 'accountId' when calling deleteConfiguration");
}
// verify the required parameter 'connectId' is set
if (connectId == null) {
throw new ApiException(
400, "Missing the required parameter 'connectId' when calling deleteConfiguration");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/connect/{connectId}"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
.replaceAll("\\{" + "connectId" + "\\}", apiClient.escapeString(connectId.toString()));
// query params
java.util.List localVarQueryParams = new java.util.ArrayList();
java.util.List localVarCollectionQueryParams = new java.util.ArrayList();
java.util.Map localVarHeaderParams = new java.util.HashMap();
java.util.Map localVarFormParams = new java.util.HashMap();
final String[] localVarAccepts = {"application/json"};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] {"docusignAccessCode"};
apiClient.invokeAPI(
localVarPath,
"DELETE",
localVarQueryParams,
localVarCollectionQueryParams,
localVarPostBody,
localVarHeaderParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
null);
}
/**
* Deletes a Connect failure log entry.. Deletes the Connect failure log information for the
* specified entry.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param failureId The ID of the failed connect log entry. (required)
* @return ConnectDeleteFailureResult
* @throws ApiException if fails to make API call
*/
public ConnectDeleteFailureResult deleteEventFailureLog(String accountId, String failureId)
throws ApiException {
Object localVarPostBody = "{}";
// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new ApiException(
400, "Missing the required parameter 'accountId' when calling deleteEventFailureLog");
}
// verify the required parameter 'failureId' is set
if (failureId == null) {
throw new ApiException(
400, "Missing the required parameter 'failureId' when calling deleteEventFailureLog");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/connect/failures/{failureId}"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
.replaceAll("\\{" + "failureId" + "\\}", apiClient.escapeString(failureId.toString()));
// query params
java.util.List localVarQueryParams = new java.util.ArrayList();
java.util.List localVarCollectionQueryParams = new java.util.ArrayList();
java.util.Map localVarHeaderParams = new java.util.HashMap();
java.util.Map localVarFormParams = new java.util.HashMap();
final String[] localVarAccepts = {"application/json"};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] {"docusignAccessCode"};
GenericType localVarReturnType =
new GenericType() {};
return apiClient.invokeAPI(
localVarPath,
"DELETE",
localVarQueryParams,
localVarCollectionQueryParams,
localVarPostBody,
localVarHeaderParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType);
}
/**
* Deletes a specified Connect log entry.. Deletes a specified entry from the Connect Log.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param logId The ID of the connect log entry (required)
* @throws ApiException if fails to make API call
*/
public void deleteEventLog(String accountId, String logId) throws ApiException {
Object localVarPostBody = "{}";
// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new ApiException(
400, "Missing the required parameter 'accountId' when calling deleteEventLog");
}
// verify the required parameter 'logId' is set
if (logId == null) {
throw new ApiException(
400, "Missing the required parameter 'logId' when calling deleteEventLog");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/connect/logs/{logId}"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
.replaceAll("\\{" + "logId" + "\\}", apiClient.escapeString(logId.toString()));
// query params
java.util.List localVarQueryParams = new java.util.ArrayList();
java.util.List localVarCollectionQueryParams = new java.util.ArrayList();
java.util.Map localVarHeaderParams = new java.util.HashMap();
java.util.Map localVarFormParams = new java.util.HashMap();
final String[] localVarAccepts = {"application/json"};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] {"docusignAccessCode"};
apiClient.invokeAPI(
localVarPath,
"DELETE",
localVarQueryParams,
localVarCollectionQueryParams,
localVarPostBody,
localVarHeaderParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
null);
}
/**
* 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.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @throws ApiException if fails to make API call
*/
public void deleteEventLogs(String accountId) throws ApiException {
Object localVarPostBody = "{}";
// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new ApiException(
400, "Missing the required parameter 'accountId' when calling deleteEventLogs");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/connect/logs"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()));
// query params
java.util.List localVarQueryParams = new java.util.ArrayList();
java.util.List localVarCollectionQueryParams = new java.util.ArrayList();
java.util.Map localVarHeaderParams = new java.util.HashMap();
java.util.Map localVarFormParams = new java.util.HashMap();
final String[] localVarAccepts = {"application/json"};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] {"docusignAccessCode"};
apiClient.invokeAPI(
localVarPath,
"DELETE",
localVarQueryParams,
localVarCollectionQueryParams,
localVarPostBody,
localVarHeaderParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
null);
}
/**
* Reserved. Reserved:
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param mobileNotifierConfigurationInformation (optional)
* @return MobileNotifierConfigurationInformation
* @throws ApiException if fails to make API call
*/
public MobileNotifierConfigurationInformation deleteMobileNotifiers(
String accountId,
MobileNotifierConfigurationInformation mobileNotifierConfigurationInformation)
throws ApiException {
Object localVarPostBody = mobileNotifierConfigurationInformation;
// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new ApiException(
400, "Missing the required parameter 'accountId' when calling deleteMobileNotifiers");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/connect/mobile_notifiers"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()));
// query params
java.util.List localVarQueryParams = new java.util.ArrayList();
java.util.List localVarCollectionQueryParams = new java.util.ArrayList();
java.util.Map localVarHeaderParams = new java.util.HashMap();
java.util.Map localVarFormParams = new java.util.HashMap();
final String[] localVarAccepts = {"application/json"};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] {"docusignAccessCode"};
GenericType localVarReturnType =
new GenericType() {};
return apiClient.invokeAPI(
localVarPath,
"DELETE",
localVarQueryParams,
localVarCollectionQueryParams,
localVarPostBody,
localVarHeaderParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType);
}
/**
* 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.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param connectId The ID of the custom Connect configuration being accessed. (required)
* @return ConnectConfigResults
* @throws ApiException if fails to make API call
*/
public ConnectConfigResults getConfiguration(String accountId, String connectId)
throws ApiException {
Object localVarPostBody = "{}";
// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new ApiException(
400, "Missing the required parameter 'accountId' when calling getConfiguration");
}
// verify the required parameter 'connectId' is set
if (connectId == null) {
throw new ApiException(
400, "Missing the required parameter 'connectId' when calling getConfiguration");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/connect/{connectId}"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
.replaceAll("\\{" + "connectId" + "\\}", apiClient.escapeString(connectId.toString()));
// query params
java.util.List localVarQueryParams = new java.util.ArrayList();
java.util.List localVarCollectionQueryParams = new java.util.ArrayList();
java.util.Map localVarHeaderParams = new java.util.HashMap();
java.util.Map localVarFormParams = new java.util.HashMap();
final String[] localVarAccepts = {"application/json"};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] {"docusignAccessCode"};
GenericType localVarReturnType =
new GenericType() {};
return apiClient.invokeAPI(
localVarPath,
"GET",
localVarQueryParams,
localVarCollectionQueryParams,
localVarPostBody,
localVarHeaderParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType);
}
///
/// Returns all users from the configured Connect service.
///
/** GetConnectAllUsersOptions Class. */
public class GetConnectAllUsersOptions {
private String count = null;
private String domainUsersOnly = null;
private String emailSubstring = null;
private String startPosition = null;
private String status = null;
private String userNameSubstring = null;
/** setCount method. */
public void setCount(String count) {
this.count = count;
}
/**
* getCount method.
*
* @return String
*/
public String getCount() {
return this.count;
}
/** setDomainUsersOnly method. */
public void setDomainUsersOnly(String domainUsersOnly) {
this.domainUsersOnly = domainUsersOnly;
}
/**
* getDomainUsersOnly method.
*
* @return String
*/
public String getDomainUsersOnly() {
return this.domainUsersOnly;
}
/** setEmailSubstring method. */
public void setEmailSubstring(String emailSubstring) {
this.emailSubstring = emailSubstring;
}
/**
* getEmailSubstring method.
*
* @return String
*/
public String getEmailSubstring() {
return this.emailSubstring;
}
/** setStartPosition method. */
public void setStartPosition(String startPosition) {
this.startPosition = startPosition;
}
/**
* getStartPosition method.
*
* @return String
*/
public String getStartPosition() {
return this.startPosition;
}
/** setStatus method. */
public void setStatus(String status) {
this.status = status;
}
/**
* getStatus method.
*
* @return String
*/
public String getStatus() {
return this.status;
}
/** setUserNameSubstring method. */
public void setUserNameSubstring(String userNameSubstring) {
this.userNameSubstring = userNameSubstring;
}
/**
* getUserNameSubstring method.
*
* @return String
*/
public String getUserNameSubstring() {
return this.userNameSubstring;
}
}
/**
* Returns all users from the configured Connect service..
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param connectId The ID of the custom Connect configuration being accessed. (required)
* @return IntegratedConnectUserInfoList
*/
public IntegratedConnectUserInfoList getConnectAllUsers(String accountId, String connectId)
throws ApiException {
return getConnectAllUsers(accountId, connectId, null);
}
/**
* Returns all users from the configured Connect service..
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param connectId The ID of the custom Connect configuration being accessed. (required)
* @param options for modifying the method behavior.
* @return IntegratedConnectUserInfoList
* @throws ApiException if fails to make API call
*/
public IntegratedConnectUserInfoList getConnectAllUsers(
String accountId, String connectId, ConnectApi.GetConnectAllUsersOptions options)
throws ApiException {
Object localVarPostBody = "{}";
// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new ApiException(
400, "Missing the required parameter 'accountId' when calling getConnectAllUsers");
}
// verify the required parameter 'connectId' is set
if (connectId == null) {
throw new ApiException(
400, "Missing the required parameter 'connectId' when calling getConnectAllUsers");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/connect/{connectId}/all/users"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
.replaceAll("\\{" + "connectId" + "\\}", apiClient.escapeString(connectId.toString()));
// query params
java.util.List localVarQueryParams = new java.util.ArrayList();
java.util.List localVarCollectionQueryParams = new java.util.ArrayList();
java.util.Map localVarHeaderParams = new java.util.HashMap();
java.util.Map localVarFormParams = new java.util.HashMap();
if (options != null) {
localVarQueryParams.addAll(apiClient.parameterToPair("count", options.count));
}
if (options != null) {
localVarQueryParams.addAll(
apiClient.parameterToPair("domain_users_only", options.domainUsersOnly));
}
if (options != null) {
localVarQueryParams.addAll(
apiClient.parameterToPair("email_substring", options.emailSubstring));
}
if (options != null) {
localVarQueryParams.addAll(
apiClient.parameterToPair("start_position", options.startPosition));
}
if (options != null) {
localVarQueryParams.addAll(apiClient.parameterToPair("status", options.status));
}
if (options != null) {
localVarQueryParams.addAll(
apiClient.parameterToPair("user_name_substring", options.userNameSubstring));
}
final String[] localVarAccepts = {"application/json"};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] {"docusignAccessCode"};
GenericType localVarReturnType =
new GenericType() {};
return apiClient.invokeAPI(
localVarPath,
"GET",
localVarQueryParams,
localVarCollectionQueryParams,
localVarPostBody,
localVarHeaderParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType);
}
///
/// 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.
///
/** GetEventLogOptions Class. */
public class GetEventLogOptions {
private String additionalInfo = null;
/** setAdditionalInfo method. */
public void setAdditionalInfo(String additionalInfo) {
this.additionalInfo = additionalInfo;
}
/**
* getAdditionalInfo method.
*
* @return String
*/
public String getAdditionalInfo() {
return this.additionalInfo;
}
}
/**
* 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.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param logId The ID of the connect log entry (required)
* @return ConnectLog
*/
public ConnectLog getEventLog(String accountId, String logId) throws ApiException {
return getEventLog(accountId, logId, 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.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param logId The ID of the connect log entry (required)
* @param options for modifying the method behavior.
* @return ConnectLog
* @throws ApiException if fails to make API call
*/
public ConnectLog getEventLog(
String accountId, String logId, ConnectApi.GetEventLogOptions options) throws ApiException {
Object localVarPostBody = "{}";
// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new ApiException(
400, "Missing the required parameter 'accountId' when calling getEventLog");
}
// verify the required parameter 'logId' is set
if (logId == null) {
throw new ApiException(
400, "Missing the required parameter 'logId' when calling getEventLog");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/connect/logs/{logId}"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
.replaceAll("\\{" + "logId" + "\\}", apiClient.escapeString(logId.toString()));
// query params
java.util.List localVarQueryParams = new java.util.ArrayList();
java.util.List localVarCollectionQueryParams = new java.util.ArrayList();
java.util.Map localVarHeaderParams = new java.util.HashMap();
java.util.Map localVarFormParams = new java.util.HashMap();
if (options != null) {
localVarQueryParams.addAll(
apiClient.parameterToPair("additional_info", options.additionalInfo));
}
final String[] localVarAccepts = {"application/json"};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] {"docusignAccessCode"};
GenericType localVarReturnType = new GenericType() {};
return apiClient.invokeAPI(
localVarPath,
"GET",
localVarQueryParams,
localVarCollectionQueryParams,
localVarPostBody,
localVarHeaderParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType);
}
/**
* 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.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @return ConnectConfigResults
* @throws ApiException if fails to make API call
*/
public ConnectConfigResults listConfigurations(String accountId) throws ApiException {
Object localVarPostBody = "{}";
// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new ApiException(
400, "Missing the required parameter 'accountId' when calling listConfigurations");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/connect"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()));
// query params
java.util.List localVarQueryParams = new java.util.ArrayList();
java.util.List localVarCollectionQueryParams = new java.util.ArrayList();
java.util.Map localVarHeaderParams = new java.util.HashMap();
java.util.Map localVarFormParams = new java.util.HashMap();
final String[] localVarAccepts = {"application/json"};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] {"docusignAccessCode"};
GenericType localVarReturnType =
new GenericType() {};
return apiClient.invokeAPI(
localVarPath,
"GET",
localVarQueryParams,
localVarCollectionQueryParams,
localVarPostBody,
localVarHeaderParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType);
}
///
/// 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.
///
/** ListEventFailureLogsOptions Class. */
public class ListEventFailureLogsOptions {
private String fromDate = null;
private String toDate = null;
/** setFromDate method. */
public void setFromDate(String fromDate) {
this.fromDate = fromDate;
}
/**
* getFromDate method.
*
* @return String
*/
public String getFromDate() {
return this.fromDate;
}
/** setToDate method. */
public void setToDate(String toDate) {
this.toDate = toDate;
}
/**
* getToDate method.
*
* @return String
*/
public String getToDate() {
return this.toDate;
}
}
/**
* 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.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @return ConnectLogs
*/
public ConnectLogs listEventFailureLogs(String accountId) throws ApiException {
return listEventFailureLogs(accountId, 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.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param options for modifying the method behavior.
* @return ConnectLogs
* @throws ApiException if fails to make API call
*/
public ConnectLogs listEventFailureLogs(
String accountId, ConnectApi.ListEventFailureLogsOptions options) throws ApiException {
Object localVarPostBody = "{}";
// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new ApiException(
400, "Missing the required parameter 'accountId' when calling listEventFailureLogs");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/connect/failures"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()));
// query params
java.util.List localVarQueryParams = new java.util.ArrayList();
java.util.List localVarCollectionQueryParams = new java.util.ArrayList();
java.util.Map localVarHeaderParams = new java.util.HashMap();
java.util.Map localVarFormParams = new java.util.HashMap();
if (options != null) {
localVarQueryParams.addAll(apiClient.parameterToPair("from_date", options.fromDate));
}
if (options != null) {
localVarQueryParams.addAll(apiClient.parameterToPair("to_date", options.toDate));
}
final String[] localVarAccepts = {"application/json"};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] {"docusignAccessCode"};
GenericType localVarReturnType = new GenericType() {};
return apiClient.invokeAPI(
localVarPath,
"GET",
localVarQueryParams,
localVarCollectionQueryParams,
localVarPostBody,
localVarHeaderParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType);
}
///
/// 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.
///
/** ListEventLogsOptions Class. */
public class ListEventLogsOptions {
private String fromDate = null;
private String toDate = null;
/** setFromDate method. */
public void setFromDate(String fromDate) {
this.fromDate = fromDate;
}
/**
* getFromDate method.
*
* @return String
*/
public String getFromDate() {
return this.fromDate;
}
/** setToDate method. */
public void setToDate(String toDate) {
this.toDate = toDate;
}
/**
* getToDate method.
*
* @return String
*/
public String getToDate() {
return this.toDate;
}
}
/**
* 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.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @return ConnectLogs
*/
public ConnectLogs listEventLogs(String accountId) throws ApiException {
return listEventLogs(accountId, 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.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param options for modifying the method behavior.
* @return ConnectLogs
* @throws ApiException if fails to make API call
*/
public ConnectLogs listEventLogs(String accountId, ConnectApi.ListEventLogsOptions options)
throws ApiException {
Object localVarPostBody = "{}";
// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new ApiException(
400, "Missing the required parameter 'accountId' when calling listEventLogs");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/connect/logs"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()));
// query params
java.util.List localVarQueryParams = new java.util.ArrayList();
java.util.List localVarCollectionQueryParams = new java.util.ArrayList();
java.util.Map localVarHeaderParams = new java.util.HashMap();
java.util.Map localVarFormParams = new java.util.HashMap();
if (options != null) {
localVarQueryParams.addAll(apiClient.parameterToPair("from_date", options.fromDate));
}
if (options != null) {
localVarQueryParams.addAll(apiClient.parameterToPair("to_date", options.toDate));
}
final String[] localVarAccepts = {"application/json"};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] {"docusignAccessCode"};
GenericType localVarReturnType = new GenericType() {};
return apiClient.invokeAPI(
localVarPath,
"GET",
localVarQueryParams,
localVarCollectionQueryParams,
localVarPostBody,
localVarHeaderParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType);
}
/**
* Reserved. Reserved:
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @return MobileNotifierConfigurationInformation
* @throws ApiException if fails to make API call
*/
public MobileNotifierConfigurationInformation listMobileNotifiers(String accountId)
throws ApiException {
Object localVarPostBody = "{}";
// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new ApiException(
400, "Missing the required parameter 'accountId' when calling listMobileNotifiers");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/connect/mobile_notifiers"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()));
// query params
java.util.List localVarQueryParams = new java.util.ArrayList();
java.util.List localVarCollectionQueryParams = new java.util.ArrayList();
java.util.Map localVarHeaderParams = new java.util.HashMap();
java.util.Map localVarFormParams = new java.util.HashMap();
final String[] localVarAccepts = {"application/json"};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] {"docusignAccessCode"};
GenericType localVarReturnType =
new GenericType() {};
return apiClient.invokeAPI(
localVarPath,
"GET",
localVarQueryParams,
localVarCollectionQueryParams,
localVarPostBody,
localVarHeaderParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType);
}
///
/// Returns users from the configured Connect service. Returns users from the configured Connect
// service.
///
/** ListUsersOptions Class. */
public class ListUsersOptions {
private String count = null;
private String emailSubstring = null;
private String listIncludedUsers = null;
private String startPosition = null;
private String status = null;
private String userNameSubstring = null;
/** setCount method. */
public void setCount(String count) {
this.count = count;
}
/**
* getCount method.
*
* @return String
*/
public String getCount() {
return this.count;
}
/** setEmailSubstring method. */
public void setEmailSubstring(String emailSubstring) {
this.emailSubstring = emailSubstring;
}
/**
* getEmailSubstring method.
*
* @return String
*/
public String getEmailSubstring() {
return this.emailSubstring;
}
/** setListIncludedUsers method. */
public void setListIncludedUsers(String listIncludedUsers) {
this.listIncludedUsers = listIncludedUsers;
}
/**
* getListIncludedUsers method.
*
* @return String
*/
public String getListIncludedUsers() {
return this.listIncludedUsers;
}
/** setStartPosition method. */
public void setStartPosition(String startPosition) {
this.startPosition = startPosition;
}
/**
* getStartPosition method.
*
* @return String
*/
public String getStartPosition() {
return this.startPosition;
}
/** setStatus method. */
public void setStatus(String status) {
this.status = status;
}
/**
* getStatus method.
*
* @return String
*/
public String getStatus() {
return this.status;
}
/** setUserNameSubstring method. */
public void setUserNameSubstring(String userNameSubstring) {
this.userNameSubstring = userNameSubstring;
}
/**
* getUserNameSubstring method.
*
* @return String
*/
public String getUserNameSubstring() {
return this.userNameSubstring;
}
}
/**
* Returns users from the configured Connect service.. Returns users from the configured Connect
* service.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param connectId The ID of the custom Connect configuration being accessed. (required)
* @return IntegratedUserInfoList
*/
public IntegratedUserInfoList listUsers(String accountId, String connectId) throws ApiException {
return listUsers(accountId, connectId, null);
}
/**
* Returns users from the configured Connect service.. Returns users from the configured Connect
* service.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param connectId The ID of the custom Connect configuration being accessed. (required)
* @param options for modifying the method behavior.
* @return IntegratedUserInfoList
* @throws ApiException if fails to make API call
*/
public IntegratedUserInfoList listUsers(
String accountId, String connectId, ConnectApi.ListUsersOptions options) throws ApiException {
Object localVarPostBody = "{}";
// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new ApiException(
400, "Missing the required parameter 'accountId' when calling listUsers");
}
// verify the required parameter 'connectId' is set
if (connectId == null) {
throw new ApiException(
400, "Missing the required parameter 'connectId' when calling listUsers");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/connect/{connectId}/users"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
.replaceAll("\\{" + "connectId" + "\\}", apiClient.escapeString(connectId.toString()));
// query params
java.util.List localVarQueryParams = new java.util.ArrayList();
java.util.List localVarCollectionQueryParams = new java.util.ArrayList();
java.util.Map localVarHeaderParams = new java.util.HashMap();
java.util.Map localVarFormParams = new java.util.HashMap();
if (options != null) {
localVarQueryParams.addAll(apiClient.parameterToPair("count", options.count));
}
if (options != null) {
localVarQueryParams.addAll(
apiClient.parameterToPair("email_substring", options.emailSubstring));
}
if (options != null) {
localVarQueryParams.addAll(
apiClient.parameterToPair("list_included_users", options.listIncludedUsers));
}
if (options != null) {
localVarQueryParams.addAll(
apiClient.parameterToPair("start_position", options.startPosition));
}
if (options != null) {
localVarQueryParams.addAll(apiClient.parameterToPair("status", options.status));
}
if (options != null) {
localVarQueryParams.addAll(
apiClient.parameterToPair("user_name_substring", options.userNameSubstring));
}
final String[] localVarAccepts = {"application/json"};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] {"docusignAccessCode"};
GenericType localVarReturnType =
new GenericType() {};
return apiClient.invokeAPI(
localVarPath,
"GET",
localVarQueryParams,
localVarCollectionQueryParams,
localVarPostBody,
localVarHeaderParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType);
}
/**
* Republishes Connect information for the specified envelope.. Republishes Connect information
* for the specified envelope.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param envelopeId The envelopeId Guid of the envelope being accessed. (required)
* @return ConnectFailureResults
* @throws ApiException if fails to make API call
*/
public ConnectFailureResults retryEventForEnvelope(String accountId, String envelopeId)
throws ApiException {
Object localVarPostBody = "{}";
// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new ApiException(
400, "Missing the required parameter 'accountId' when calling retryEventForEnvelope");
}
// verify the required parameter 'envelopeId' is set
if (envelopeId == null) {
throw new ApiException(
400, "Missing the required parameter 'envelopeId' when calling retryEventForEnvelope");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/connect/envelopes/{envelopeId}/retry_queue"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
.replaceAll(
"\\{" + "envelopeId" + "\\}", apiClient.escapeString(envelopeId.toString()));
// query params
java.util.List localVarQueryParams = new java.util.ArrayList();
java.util.List localVarCollectionQueryParams = new java.util.ArrayList();
java.util.Map localVarHeaderParams = new java.util.HashMap();
java.util.Map localVarFormParams = new java.util.HashMap();
final String[] localVarAccepts = {"application/json"};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] {"docusignAccessCode"};
GenericType localVarReturnType =
new GenericType() {};
return apiClient.invokeAPI(
localVarPath,
"PUT",
localVarQueryParams,
localVarCollectionQueryParams,
localVarPostBody,
localVarHeaderParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType);
}
/**
* 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.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param connectFailureFilter (optional)
* @return ConnectFailureResults
* @throws ApiException if fails to make API call
*/
public ConnectFailureResults retryEventForEnvelopes(
String accountId, ConnectFailureFilter connectFailureFilter) throws ApiException {
Object localVarPostBody = connectFailureFilter;
// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new ApiException(
400, "Missing the required parameter 'accountId' when calling retryEventForEnvelopes");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/connect/envelopes/retry_queue"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()));
// query params
java.util.List localVarQueryParams = new java.util.ArrayList();
java.util.List localVarCollectionQueryParams = new java.util.ArrayList();
java.util.Map localVarHeaderParams = new java.util.HashMap();
java.util.Map localVarFormParams = new java.util.HashMap();
final String[] localVarAccepts = {"application/json"};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] {"docusignAccessCode"};
GenericType localVarReturnType =
new GenericType() {};
return apiClient.invokeAPI(
localVarPath,
"PUT",
localVarQueryParams,
localVarCollectionQueryParams,
localVarPostBody,
localVarHeaderParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType);
}
/**
* 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.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param connectCustomConfiguration (optional)
* @return ConnectCustomConfiguration
* @throws ApiException if fails to make API call
*/
public ConnectCustomConfiguration updateConfiguration(
String accountId, ConnectCustomConfiguration connectCustomConfiguration) throws ApiException {
Object localVarPostBody = connectCustomConfiguration;
// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new ApiException(
400, "Missing the required parameter 'accountId' when calling updateConfiguration");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/connect"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()));
// query params
java.util.List localVarQueryParams = new java.util.ArrayList();
java.util.List localVarCollectionQueryParams = new java.util.ArrayList();
java.util.Map localVarHeaderParams = new java.util.HashMap();
java.util.Map localVarFormParams = new java.util.HashMap();
final String[] localVarAccepts = {"application/json"};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] {"docusignAccessCode"};
GenericType localVarReturnType =
new GenericType() {};
return apiClient.invokeAPI(
localVarPath,
"PUT",
localVarQueryParams,
localVarCollectionQueryParams,
localVarPostBody,
localVarHeaderParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType);
}
/**
* Reserved. Reserved:
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param mobileNotifierConfigurationInformation (optional)
* @return MobileNotifierConfigurationInformation
* @throws ApiException if fails to make API call
*/
public MobileNotifierConfigurationInformation updateMobileNotifiers(
String accountId,
MobileNotifierConfigurationInformation mobileNotifierConfigurationInformation)
throws ApiException {
Object localVarPostBody = mobileNotifierConfigurationInformation;
// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new ApiException(
400, "Missing the required parameter 'accountId' when calling updateMobileNotifiers");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/connect/mobile_notifiers"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()));
// query params
java.util.List localVarQueryParams = new java.util.ArrayList();
java.util.List localVarCollectionQueryParams = new java.util.ArrayList();
java.util.Map localVarHeaderParams = new java.util.HashMap();
java.util.Map localVarFormParams = new java.util.HashMap();
final String[] localVarAccepts = {"application/json"};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] {"docusignAccessCode"};
GenericType localVarReturnType =
new GenericType() {};
return apiClient.invokeAPI(
localVarPath,
"PUT",
localVarQueryParams,
localVarCollectionQueryParams,
localVarPostBody,
localVarHeaderParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType);
}
}
