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.
com.docusign.esign.api.DiagnosticsApi Maven / Gradle / Ivy
The official DocuSign eSignature JAVA client is based on version 2 of the DocuSign REST API and provides libraries for JAVA application integration. It is recommended that you use this version of the library for new development.
package com.docusign.esign.api;
import com.docusign.esign.client.ApiClient;
import com.docusign.esign.client.ApiException;
import com.docusign.esign.client.ApiResponse;
import com.docusign.esign.client.Configuration;
import com.docusign.esign.client.Pair;
import com.docusign.esign.model.*;
import jakarta.ws.rs.core.GenericType;
/** DiagnosticsApi class. */
public class DiagnosticsApi {
private ApiClient apiClient;
/** DiagnosticsApi. */
public DiagnosticsApi() {
this(Configuration.getDefaultApiClient());
}
/** DiagnosticsApi. */
public DiagnosticsApi(ApiClient apiClient) {
this.apiClient = apiClient;
}
/**
* getApiClient Method.
*
* @return ApiClient
*/
public ApiClient getApiClient() {
return apiClient;
}
/** setApiClient Method. */
public void setApiClient(ApiClient apiClient) {
this.apiClient = apiClient;
}
/**
* Deletes the request log files.. Deletes the request log files.
*
* @throws ApiException if fails to make API call
*/
public void deleteRequestLogs() throws ApiException {
deleteRequestLogsWithHttpInfo();
}
/**
* Deletes the request log files. Deletes the request log files.
*
* @throws ApiException if fails to make API call
*/
public ApiResponse deleteRequestLogsWithHttpInfo() throws ApiException {
Object localVarPostBody = "{}";
// create path and map variables
String localVarPath = "/v2.1/diagnostics/request_logs";
// 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);
return new ApiResponse(apiClient.getStatusCode(), apiClient.getResponseHeaders(), null);
}
/**
* Gets a request logging log file.. Retrieves information for a single log entry. **Request** The
* `requestLogfId` property can be retrieved by getting the list of log entries. The
* Content-Transfer-Encoding header can be set to base64 to retrieve the API request/response as
* base 64 string. Otherwise the bytes of the request/response are returned. **Response** If the
* Content-Transfer-Encoding header was set to base64, the log is returned as a base64 string.
*
* @param requestLogId (required)
* @return byte[]
* @throws ApiException if fails to make API call
*/
public byte[] getRequestLog(String requestLogId) throws ApiException {
ApiResponse localVarResponse = getRequestLogWithHttpInfo(requestLogId);
return localVarResponse.getData();
}
/**
* Gets a request logging log file. Retrieves information for a single log entry. **Request** The
* `requestLogfId` property can be retrieved by getting the list of log entries. The
* Content-Transfer-Encoding header can be set to base64 to retrieve the API request/response as
* base 64 string. Otherwise the bytes of the request/response are returned. **Response** If the
* Content-Transfer-Encoding header was set to base64, the log is returned as a base64 string.
*
* @param requestLogId (required)
* @return byte[]
* @throws ApiException if fails to make API call
*/
public ApiResponse getRequestLogWithHttpInfo(String requestLogId) throws ApiException {
Object localVarPostBody = "{}";
// verify the required parameter 'requestLogId' is set
if (requestLogId == null) {
throw new ApiException(
400, "Missing the required parameter 'requestLogId' when calling getRequestLog");
}
// create path and map variables
String localVarPath =
"/v2.1/diagnostics/request_logs/{requestLogId}"
.replaceAll(
"\\{" + "requestLogId" + "\\}", apiClient.escapeString(requestLogId.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 = {"text/plain"};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] {"docusignAccessCode"};
GenericType localVarReturnType = new GenericType() {};
byte[] localVarResponse =
apiClient.invokeAPI(
localVarPath,
"GET",
localVarQueryParams,
localVarCollectionQueryParams,
localVarPostBody,
localVarHeaderParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType);
return new ApiResponse(
apiClient.getStatusCode(), apiClient.getResponseHeaders(), localVarResponse);
}
/**
* Gets the API request logging settings.. Retrieves the current API request logging setting for
* the user and remaining log entries. **Response** The response includes the current API request
* logging setting for the user, along with the maximum log entries and remaining log entries.
*
* @return DiagnosticsSettingsInformation
* @throws ApiException if fails to make API call
*/
public DiagnosticsSettingsInformation getRequestLogSettings() throws ApiException {
ApiResponse localVarResponse =
getRequestLogSettingsWithHttpInfo();
return localVarResponse.getData();
}
/**
* Gets the API request logging settings. Retrieves the current API request logging setting for
* the user and remaining log entries. **Response** The response includes the current API request
* logging setting for the user, along with the maximum log entries and remaining log entries.
*
* @return DiagnosticsSettingsInformation
* @throws ApiException if fails to make API call
*/
public ApiResponse getRequestLogSettingsWithHttpInfo()
throws ApiException {
Object localVarPostBody = "{}";
// create path and map variables
String localVarPath = "/v2.1/diagnostics/settings";
// 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() {};
DiagnosticsSettingsInformation localVarResponse =
apiClient.invokeAPI(
localVarPath,
"GET",
localVarQueryParams,
localVarCollectionQueryParams,
localVarPostBody,
localVarHeaderParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType);
return new ApiResponse(
apiClient.getStatusCode(), apiClient.getResponseHeaders(), localVarResponse);
}
/**
* Lists resources for REST version specified. Retrieves the base resources available for the
* DocuSign REST APIs. You do not need an integrator key to view the REST API versions and
* resources. Example: https://demo.docusign.net/restapi/v2 lists all of the base resources
* available in version 2 of the REST API on the DocuSign Demo system. To view descriptions and
* samples of the service operations for all versions, remove the version number and add /help to
* the URL. Example: https://demo.docusign.net/restapi/help lists the REST API operations on the
* DocuSign Demo system with XML and JSON request and response samples.
*
* @return ResourceInformation
* @throws ApiException if fails to make API call
*/
public ResourceInformation getResources() throws ApiException {
ApiResponse localVarResponse = getResourcesWithHttpInfo();
return localVarResponse.getData();
}
/**
* Lists resources for REST version specified Retrieves the base resources available for the
* DocuSign REST APIs. You do not need an integrator key to view the REST API versions and
* resources. Example: https://demo.docusign.net/restapi/v2 lists all of the base resources
* available in version 2 of the REST API on the DocuSign Demo system. To view descriptions and
* samples of the service operations for all versions, remove the version number and add /help to
* the URL. Example: https://demo.docusign.net/restapi/help lists the REST API operations on the
* DocuSign Demo system with XML and JSON request and response samples.
*
* @return ResourceInformation
* @throws ApiException if fails to make API call
*/
public ApiResponse getResourcesWithHttpInfo() throws ApiException {
Object localVarPostBody = "{}";
// create path and map variables
String localVarPath = "/v2.1";
// 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() {};
ResourceInformation localVarResponse =
apiClient.invokeAPI(
localVarPath,
"GET",
localVarQueryParams,
localVarCollectionQueryParams,
localVarPostBody,
localVarHeaderParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType);
return new ApiResponse(
apiClient.getStatusCode(), apiClient.getResponseHeaders(), localVarResponse);
}
/**
* Retrieves the available REST API versions.. Retrieves the available REST API versions. DocuSign
* Production system: https://www.docusign.net/restapi/service_information DocuSign Demo system:
* https://demo.docusign.net/restapi/service_information You do not need an integrator key to view
* the REST API versions and resources.
*
* @return ServiceInformation
* @throws ApiException if fails to make API call
*/
public ServiceInformation getService() throws ApiException {
ApiResponse localVarResponse = getServiceWithHttpInfo();
return localVarResponse.getData();
}
/**
* Retrieves the available REST API versions. Retrieves the available REST API versions. DocuSign
* Production system: https://www.docusign.net/restapi/service_information DocuSign Demo system:
* https://demo.docusign.net/restapi/service_information You do not need an integrator key to view
* the REST API versions and resources.
*
* @return ServiceInformation
* @throws ApiException if fails to make API call
*/
public ApiResponse getServiceWithHttpInfo() throws ApiException {
Object localVarPostBody = "{}";
// create path and map variables
String localVarPath = "/service_information";
// 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() {};
ServiceInformation localVarResponse =
apiClient.invokeAPI(
localVarPath,
"GET",
localVarQueryParams,
localVarCollectionQueryParams,
localVarPostBody,
localVarHeaderParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType);
return new ApiResponse(
apiClient.getStatusCode(), apiClient.getResponseHeaders(), localVarResponse);
}
///
/// Gets the API request logging log files. Retrieves a list of log entries as a JSON or xml
// object or as a zip file containing the entries. If the Accept header is set to
// application/zip, the response is a zip file containing individual text files, each representing
// an API request. If the Accept header is set to `application/json` or
// `application/xml`, the response returns list of log entries in either JSON or XML. An
// example JSON response body is shown below.
///
/** ListRequestLogsOptions Class. */
public class ListRequestLogsOptions {
private String encoding = null;
/** setEncoding method. */
public void setEncoding(String encoding) {
this.encoding = encoding;
}
/**
* getEncoding method.
*
* @return String
*/
public String getEncoding() {
return this.encoding;
}
}
/**
* Gets the API request logging log files.. Retrieves a list of log entries as a JSON or xml
* object or as a zip file containing the entries. If the Accept header is set to application/zip,
* the response is a zip file containing individual text files, each representing an API request.
* If the Accept header is set to `application/json` or `application/xml`, the
* response returns list of log entries in either JSON or XML. An example JSON response body is
* shown below.
*
* @return ApiRequestLogsResult
*/
public ApiRequestLogsResult listRequestLogs() throws ApiException {
return listRequestLogs(null);
}
/**
* Gets the API request logging log files.. Retrieves a list of log entries as a JSON or xml
* object or as a zip file containing the entries. If the Accept header is set to application/zip,
* the response is a zip file containing individual text files, each representing an API request.
* If the Accept header is set to `application/json` or `application/xml`, the
* response returns list of log entries in either JSON or XML. An example JSON response body is
* shown below.
*
* @param options for modifying the method behavior.
* @return ApiRequestLogsResult
* @throws ApiException if fails to make API call
*/
public ApiRequestLogsResult listRequestLogs(DiagnosticsApi.ListRequestLogsOptions options)
throws ApiException {
ApiResponse localVarResponse = listRequestLogsWithHttpInfo(options);
return localVarResponse.getData();
}
/**
* Gets the API request logging log files. Retrieves a list of log entries as a JSON or xml object
* or as a zip file containing the entries. If the Accept header is set to application/zip, the
* response is a zip file containing individual text files, each representing an API request. If
* the Accept header is set to `application/json` or `application/xml`, the
* response returns list of log entries in either JSON or XML. An example JSON response body is
* shown below.
*
* @param options for modifying the method behavior.
* @return ApiRequestLogsResult
* @throws ApiException if fails to make API call
*/
public ApiResponse listRequestLogsWithHttpInfo(
DiagnosticsApi.ListRequestLogsOptions options) throws ApiException {
Object localVarPostBody = "{}";
// create path and map variables
String localVarPath = "/v2.1/diagnostics/request_logs";
// 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("encoding", options.encoding));
}
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() {};
ApiRequestLogsResult localVarResponse =
apiClient.invokeAPI(
localVarPath,
"GET",
localVarQueryParams,
localVarCollectionQueryParams,
localVarPostBody,
localVarHeaderParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType);
return new ApiResponse(
apiClient.getStatusCode(), apiClient.getResponseHeaders(), localVarResponse);
}
/**
* Enables or disables API request logging for troubleshooting.. Enables or disables API request
* logging for troubleshooting. When enabled (`apiRequestLogging` is set to true), REST
* API requests and responses for the user are added to a log. A log can have up to 50
* requests/responses and the current number of log entries can be determined by getting the
* settings. Logging is automatically disabled when the log limit of 50 is reached. You can call
* [ML:GetRequestLog] or [ML:GetRequestLogs] to download the log files (individually or as a zip
* file). Call [ML:DeleteRequestLogs] to clear the log by deleting current entries. Private
* information, such as passwords and integrator key information, which is normally located in the
* call header is omitted from the request/response log. ###### Note: API request logging only
* captures requests from the authenticated user. Any call that does not authenticate the user and
* resolve a userId isn't logged. Meaning that login_information, NewAccounts, or other
* distributor-credential calls are not logged.
*
* @param diagnosticsSettingsInformation (optional)
* @return DiagnosticsSettingsInformation
* @throws ApiException if fails to make API call
*/
public DiagnosticsSettingsInformation updateRequestLogSettings(
DiagnosticsSettingsInformation diagnosticsSettingsInformation) throws ApiException {
ApiResponse localVarResponse =
updateRequestLogSettingsWithHttpInfo(diagnosticsSettingsInformation);
return localVarResponse.getData();
}
/**
* Enables or disables API request logging for troubleshooting. Enables or disables API request
* logging for troubleshooting. When enabled (`apiRequestLogging` is set to true), REST
* API requests and responses for the user are added to a log. A log can have up to 50
* requests/responses and the current number of log entries can be determined by getting the
* settings. Logging is automatically disabled when the log limit of 50 is reached. You can call
* [ML:GetRequestLog] or [ML:GetRequestLogs] to download the log files (individually or as a zip
* file). Call [ML:DeleteRequestLogs] to clear the log by deleting current entries. Private
* information, such as passwords and integrator key information, which is normally located in the
* call header is omitted from the request/response log. ###### Note: API request logging only
* captures requests from the authenticated user. Any call that does not authenticate the user and
* resolve a userId isn't logged. Meaning that login_information, NewAccounts, or other
* distributor-credential calls are not logged.
*
* @param diagnosticsSettingsInformation (optional)
* @return DiagnosticsSettingsInformation
* @throws ApiException if fails to make API call
*/
public ApiResponse updateRequestLogSettingsWithHttpInfo(
DiagnosticsSettingsInformation diagnosticsSettingsInformation) throws ApiException {
Object localVarPostBody = diagnosticsSettingsInformation;
// create path and map variables
String localVarPath = "/v2.1/diagnostics/settings";
// 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() {};
DiagnosticsSettingsInformation localVarResponse =
apiClient.invokeAPI(
localVarPath,
"PUT",
localVarQueryParams,
localVarCollectionQueryParams,
localVarPostBody,
localVarHeaderParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType);
return new ApiResponse(
apiClient.getStatusCode(), apiClient.getResponseHeaders(), localVarResponse);
}
}
