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;
/** AccountsApi class. */
public class AccountsApi {
private ApiClient apiClient;
/** AccountsApi. */
public AccountsApi() {
this(Configuration.getDefaultApiClient());
}
/** AccountsApi. */
public AccountsApi(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 new accounts. Creates new DocuSign service accounts. This is used to create multiple
// DocuSign accounts with one call. It uses the same information and formats as the normal a
// [Accounts:create](accounts_create) call with the information included within a
// `newAccountRequests` element. A maximum of 100 new accounts can be created at one
// time. Note that the structure of the XML request is slightly different than the JSON request,
// in that the new account information is included in a `newAccountDefinition` property
// inside the `newAccountRequests` element. Response The response returns the new
// account ID, password and the default user information for each newly created account. A 201
// code is returned if the call succeeded. While the call may have succeed, some of the
// individual account requests may have failed. In the case of failures to create the account, an
// `errorDetails` node is added in the response to each specific request that failed.
///
/** CreateOptions Class. */
public class CreateOptions {
private String previewBillingPlan = null;
/** setPreviewBillingPlan method. */
public void setPreviewBillingPlan(String previewBillingPlan) {
this.previewBillingPlan = previewBillingPlan;
}
/**
* getPreviewBillingPlan method.
*
* @return String
*/
public String getPreviewBillingPlan() {
return this.previewBillingPlan;
}
}
/**
* Creates new accounts.. Creates new DocuSign service accounts. This is used to create multiple
* DocuSign accounts with one call. It uses the same information and formats as the normal a
* [Accounts:create](accounts_create) call with the information included within a
* `newAccountRequests` element. A maximum of 100 new accounts can be created at one
* time. Note that the structure of the XML request is slightly different than the JSON request,
* in that the new account information is included in a `newAccountDefinition` property
* inside the `newAccountRequests` element. Response The response returns the new
* account ID, password and the default user information for each newly created account. A 201
* code is returned if the call succeeded. While the call may have succeed, some of the individual
* account requests may have failed. In the case of failures to create the account, an
* `errorDetails` node is added in the response to each specific request that failed.
*
* @param newAccountDefinition (optional)
* @return NewAccountSummary
*/
public NewAccountSummary create(NewAccountDefinition newAccountDefinition) throws ApiException {
return create(newAccountDefinition, null);
}
/**
* Creates new accounts.. Creates new DocuSign service accounts. This is used to create multiple
* DocuSign accounts with one call. It uses the same information and formats as the normal a
* [Accounts:create](accounts_create) call with the information included within a
* `newAccountRequests` element. A maximum of 100 new accounts can be created at one
* time. Note that the structure of the XML request is slightly different than the JSON request,
* in that the new account information is included in a `newAccountDefinition` property
* inside the `newAccountRequests` element. Response The response returns the new
* account ID, password and the default user information for each newly created account. A 201
* code is returned if the call succeeded. While the call may have succeed, some of the individual
* account requests may have failed. In the case of failures to create the account, an
* `errorDetails` node is added in the response to each specific request that failed.
*
* @param newAccountDefinition (optional)
* @param options for modifying the method behavior.
* @return NewAccountSummary
* @throws ApiException if fails to make API call
*/
public NewAccountSummary create(
NewAccountDefinition newAccountDefinition, AccountsApi.CreateOptions options)
throws ApiException {
Object localVarPostBody = newAccountDefinition;
// create path and map variables
String localVarPath = "/v2.1/accounts";
// 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("preview_billing_plan", options.previewBillingPlan));
}
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);
}
///
/// Adds/updates one or more account signatures. This request may include images in multi-part
// format.
///
/** CreateAccountSignaturesOptions Class. */
public class CreateAccountSignaturesOptions {
private String decodeOnly = null;
/** setDecodeOnly method. */
public void setDecodeOnly(String decodeOnly) {
this.decodeOnly = decodeOnly;
}
/**
* getDecodeOnly method.
*
* @return String
*/
public String getDecodeOnly() {
return this.decodeOnly;
}
}
/**
* Adds/updates one or more account signatures. This request may include images in multi-part
* format..
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param accountSignaturesInformation (optional)
* @return AccountSignaturesInformation
*/
public AccountSignaturesInformation createAccountSignatures(
String accountId, AccountSignaturesInformation accountSignaturesInformation)
throws ApiException {
return createAccountSignatures(accountId, accountSignaturesInformation, null);
}
/**
* Adds/updates one or more account signatures. This request may include images in multi-part
* format..
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param accountSignaturesInformation (optional)
* @param options for modifying the method behavior.
* @return AccountSignaturesInformation
* @throws ApiException if fails to make API call
*/
public AccountSignaturesInformation createAccountSignatures(
String accountId,
AccountSignaturesInformation accountSignaturesInformation,
AccountsApi.CreateAccountSignaturesOptions options)
throws ApiException {
Object localVarPostBody = accountSignaturesInformation;
// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new ApiException(
400, "Missing the required parameter 'accountId' when calling createAccountSignatures");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/signatures"
.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("decode_only", options.decodeOnly));
}
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);
}
/**
* Creates one or more brand profile files for the account.. Creates one or more brand profile
* files for the account. The Account Branding feature (accountSettings properties
* `canSelfBrandSend` and `canSelfBrandSig`) must be set to **true** for the
* account to use this call. An error is returned if `brandId` property for a brand
* profile is already set for the account. To upload a new version of an existing brand profile,
* you must delete the profile and then upload the newer version. When brand profile files are
* being uploaded, they must be combined into one zip file and the `Content-Type` must
* be `application/zip`.
*
* @param accountId The external account number (int) or account ID GUID. (required)
* @param brand (optional)
* @return BrandsResponse
* @throws ApiException if fails to make API call
*/
public BrandsResponse createBrand(String accountId, Brand brand) throws ApiException {
Object localVarPostBody = brand;
// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new ApiException(
400, "Missing the required parameter 'accountId' when calling createBrand");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/brands"
.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);
}
///
/// Creates an acount custom field.
///
/** CreateCustomFieldOptions Class. */
public class CreateCustomFieldOptions {
private String applyToTemplates = null;
/** setApplyToTemplates method. */
public void setApplyToTemplates(String applyToTemplates) {
this.applyToTemplates = applyToTemplates;
}
/**
* getApplyToTemplates method.
*
* @return String
*/
public String getApplyToTemplates() {
return this.applyToTemplates;
}
}
/**
* Creates an acount custom field..
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param customField (optional)
* @return CustomFields
*/
public CustomFields createCustomField(String accountId, CustomField customField)
throws ApiException {
return createCustomField(accountId, customField, null);
}
/**
* Creates an acount custom field..
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param customField (optional)
* @param options for modifying the method behavior.
* @return CustomFields
* @throws ApiException if fails to make API call
*/
public CustomFields createCustomField(
String accountId, CustomField customField, AccountsApi.CreateCustomFieldOptions options)
throws ApiException {
Object localVarPostBody = customField;
// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new ApiException(
400, "Missing the required parameter 'accountId' when calling createCustomField");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/custom_fields"
.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("apply_to_templates", options.applyToTemplates));
}
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);
}
///
/// Creates a new permission profile in the specified account.
///
/** CreatePermissionProfileOptions Class. */
public class CreatePermissionProfileOptions {
private String include = null;
/** setInclude method. */
public void setInclude(String include) {
this.include = include;
}
/**
* getInclude method.
*
* @return String
*/
public String getInclude() {
return this.include;
}
}
/**
* Creates a new permission profile in the specified account..
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param permissionProfile (optional)
* @return PermissionProfile
*/
public PermissionProfile createPermissionProfile(
String accountId, PermissionProfile permissionProfile) throws ApiException {
return createPermissionProfile(accountId, permissionProfile, null);
}
/**
* Creates a new permission profile in the specified account..
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param permissionProfile (optional)
* @param options for modifying the method behavior.
* @return PermissionProfile
* @throws ApiException if fails to make API call
*/
public PermissionProfile createPermissionProfile(
String accountId,
PermissionProfile permissionProfile,
AccountsApi.CreatePermissionProfileOptions options)
throws ApiException {
Object localVarPostBody = permissionProfile;
// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new ApiException(
400, "Missing the required parameter 'accountId' when calling createPermissionProfile");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/permission_profiles"
.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("include", options.include));
}
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 account.. This closes the specified account. You must be an account admin
* to close your account. Once closed, an account must be reopened by DocuSign.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @throws ApiException if fails to make API call
*/
public void delete(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 delete");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}"
.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);
}
/**
* Close the specified signature by Id..
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param signatureId The ID of the signature being accessed. (required)
* @throws ApiException if fails to make API call
*/
public void deleteAccountSignature(String accountId, String signatureId) 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 deleteAccountSignature");
}
// verify the required parameter 'signatureId' is set
if (signatureId == null) {
throw new ApiException(
400, "Missing the required parameter 'signatureId' when calling deleteAccountSignature");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/signatures/{signatureId}"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
.replaceAll(
"\\{" + "signatureId" + "\\}", apiClient.escapeString(signatureId.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 signature, initials, or stamps image..
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param signatureId The ID of the signature being accessed. (required)
* @param imageType One of **signature_image** or **initials_image**. (required)
* @return AccountSignature
* @throws ApiException if fails to make API call
*/
public AccountSignature deleteAccountSignatureImage(
String accountId, String signatureId, String imageType) 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 deleteAccountSignatureImage");
}
// verify the required parameter 'signatureId' is set
if (signatureId == null) {
throw new ApiException(
400,
"Missing the required parameter 'signatureId' when calling deleteAccountSignatureImage");
}
// verify the required parameter 'imageType' is set
if (imageType == null) {
throw new ApiException(
400,
"Missing the required parameter 'imageType' when calling deleteAccountSignatureImage");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
.replaceAll(
"\\{" + "signatureId" + "\\}", apiClient.escapeString(signatureId.toString()))
.replaceAll("\\{" + "imageType" + "\\}", apiClient.escapeString(imageType.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);
}
/**
* Removes a brand..
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param brandId The unique identifier of a brand. (required)
* @throws ApiException if fails to make API call
*/
public void deleteBrand(String accountId, String brandId) 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 deleteBrand");
}
// verify the required parameter 'brandId' is set
if (brandId == null) {
throw new ApiException(
400, "Missing the required parameter 'brandId' when calling deleteBrand");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/brands/{brandId}"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
.replaceAll("\\{" + "brandId" + "\\}", apiClient.escapeString(brandId.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);
}
/**
* Delete one branding logo..
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param brandId The unique identifier of a brand. (required)
* @param logoType One of **Primary**, **Secondary** or **Email**. (required)
* @throws ApiException if fails to make API call
*/
public void deleteBrandLogoByType(String accountId, String brandId, String logoType)
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 deleteBrandLogoByType");
}
// verify the required parameter 'brandId' is set
if (brandId == null) {
throw new ApiException(
400, "Missing the required parameter 'brandId' when calling deleteBrandLogoByType");
}
// verify the required parameter 'logoType' is set
if (logoType == null) {
throw new ApiException(
400, "Missing the required parameter 'logoType' when calling deleteBrandLogoByType");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
.replaceAll("\\{" + "brandId" + "\\}", apiClient.escapeString(brandId.toString()))
.replaceAll("\\{" + "logoType" + "\\}", apiClient.escapeString(logoType.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 one or more brand profiles.. Deletes one or more brand profiles from an account. The
* Account Branding feature (accountSettings properties `canSelfBrandSend` and
* `canSelfBrandSend`) must be set to **true** to use this call.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param brandsRequest (optional)
* @return BrandsResponse
* @throws ApiException if fails to make API call
*/
public BrandsResponse deleteBrands(String accountId, BrandsRequest brandsRequest)
throws ApiException {
Object localVarPostBody = brandsRequest;
// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new ApiException(
400, "Missing the required parameter 'accountId' when calling deleteBrands");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/brands"
.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);
}
/**
* Deletes the signature for one or more captive recipient records.. Deletes the signature for one
* or more captive recipient records; it is primarily used for testing. This provides a way to
* reset the signature associated with a client user ID so that a new signature can be created the
* next time the client user ID is used.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param recipientPart (required)
* @param captiveRecipientInformation (optional)
* @return CaptiveRecipientInformation
* @throws ApiException if fails to make API call
*/
public CaptiveRecipientInformation deleteCaptiveRecipient(
String accountId,
String recipientPart,
CaptiveRecipientInformation captiveRecipientInformation)
throws ApiException {
Object localVarPostBody = captiveRecipientInformation;
// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new ApiException(
400, "Missing the required parameter 'accountId' when calling deleteCaptiveRecipient");
}
// verify the required parameter 'recipientPart' is set
if (recipientPart == null) {
throw new ApiException(
400,
"Missing the required parameter 'recipientPart' when calling deleteCaptiveRecipient");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/captive_recipients/{recipientPart}"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
.replaceAll(
"\\{" + "recipientPart" + "\\}", apiClient.escapeString(recipientPart.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);
}
///
/// Delete an existing account custom field.
///
/** DeleteCustomFieldOptions Class. */
public class DeleteCustomFieldOptions {
private String applyToTemplates = null;
/** setApplyToTemplates method. */
public void setApplyToTemplates(String applyToTemplates) {
this.applyToTemplates = applyToTemplates;
}
/**
* getApplyToTemplates method.
*
* @return String
*/
public String getApplyToTemplates() {
return this.applyToTemplates;
}
}
/**
* Delete an existing account custom field..
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param customFieldId (required)
* @return void
*/
public void deleteCustomField(String accountId, String customFieldId) throws ApiException {
deleteCustomField(accountId, customFieldId, null);
}
/**
* Delete an existing account custom field..
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param customFieldId (required)
* @param options for modifying the method behavior.
* @throws ApiException if fails to make API call
*/
public void deleteCustomField(
String accountId, String customFieldId, AccountsApi.DeleteCustomFieldOptions 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 deleteCustomField");
}
// verify the required parameter 'customFieldId' is set
if (customFieldId == null) {
throw new ApiException(
400, "Missing the required parameter 'customFieldId' when calling deleteCustomField");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/custom_fields/{customFieldId}"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
.replaceAll(
"\\{" + "customFieldId" + "\\}", apiClient.escapeString(customFieldId.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("apply_to_templates", options.applyToTemplates));
}
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 configuration information for the eNote eOriginal integration..
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @throws ApiException if fails to make API call
*/
public void deleteENoteConfiguration(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 deleteENoteConfiguration");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/settings/enote_configuration"
.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);
}
///
/// Deletes a permissions profile within the specified account.
///
/** DeletePermissionProfileOptions Class. */
public class DeletePermissionProfileOptions {
private String moveUsersTo = null;
/** setMoveUsersTo method. */
public void setMoveUsersTo(String moveUsersTo) {
this.moveUsersTo = moveUsersTo;
}
/**
* getMoveUsersTo method.
*
* @return String
*/
public String getMoveUsersTo() {
return this.moveUsersTo;
}
}
/**
* Deletes a permissions profile within the specified account..
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param permissionProfileId (required)
* @return void
*/
public void deletePermissionProfile(String accountId, String permissionProfileId)
throws ApiException {
deletePermissionProfile(accountId, permissionProfileId, null);
}
/**
* Deletes a permissions profile within the specified account..
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param permissionProfileId (required)
* @param options for modifying the method behavior.
* @throws ApiException if fails to make API call
*/
public void deletePermissionProfile(
String accountId,
String permissionProfileId,
AccountsApi.DeletePermissionProfileOptions 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 deletePermissionProfile");
}
// verify the required parameter 'permissionProfileId' is set
if (permissionProfileId == null) {
throw new ApiException(
400,
"Missing the required parameter 'permissionProfileId' when calling deletePermissionProfile");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
.replaceAll(
"\\{" + "permissionProfileId" + "\\}",
apiClient.escapeString(permissionProfileId.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("move_users_to", options.moveUsersTo));
}
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);
}
/**
* Get the list of identity verification options for an account.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @return AccountIdentityVerificationResponse
* @throws ApiException if fails to make API call
*/
public AccountIdentityVerificationResponse getAccountIdentityVerification(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 getAccountIdentityVerification");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/identity_verification"
.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);
}
///
/// Retrieves the account information for the specified account. Retrieves the account information
// for the specified account. **Response** The `canUpgrade` property contains is a
// Boolean that indicates whether the account can be upgraded through the API.
///
/** GetAccountInformationOptions Class. */
public class GetAccountInformationOptions {
private String includeAccountSettings = null;
/** setIncludeAccountSettings method. */
public void setIncludeAccountSettings(String includeAccountSettings) {
this.includeAccountSettings = includeAccountSettings;
}
/**
* getIncludeAccountSettings method.
*
* @return String
*/
public String getIncludeAccountSettings() {
return this.includeAccountSettings;
}
}
/**
* Retrieves the account information for the specified account.. Retrieves the account information
* for the specified account. **Response** The `canUpgrade` property contains is a
* Boolean that indicates whether the account can be upgraded through the API.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @return AccountInformation
*/
public AccountInformation getAccountInformation(String accountId) throws ApiException {
return getAccountInformation(accountId, null);
}
/**
* Retrieves the account information for the specified account.. Retrieves the account information
* for the specified account. **Response** The `canUpgrade` property contains is a
* Boolean that indicates whether the account can be upgraded through the API.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param options for modifying the method behavior.
* @return AccountInformation
* @throws ApiException if fails to make API call
*/
public AccountInformation getAccountInformation(
String accountId, AccountsApi.GetAccountInformationOptions 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 getAccountInformation");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}"
.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("include_account_settings", options.includeAccountSettings));
}
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 information about a single signature by specifed signatureId..
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param signatureId The ID of the signature being accessed. (required)
* @return AccountSignature
* @throws ApiException if fails to make API call
*/
public AccountSignature getAccountSignature(String accountId, String signatureId)
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 getAccountSignature");
}
// verify the required parameter 'signatureId' is set
if (signatureId == null) {
throw new ApiException(
400, "Missing the required parameter 'signatureId' when calling getAccountSignature");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/signatures/{signatureId}"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
.replaceAll(
"\\{" + "signatureId" + "\\}", apiClient.escapeString(signatureId.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 a signature, initials, or stamps image.
///
/** GetAccountSignatureImageOptions Class. */
public class GetAccountSignatureImageOptions {
private String includeChrome = null;
/** setIncludeChrome method. */
public void setIncludeChrome(String includeChrome) {
this.includeChrome = includeChrome;
}
/**
* getIncludeChrome method.
*
* @return String
*/
public String getIncludeChrome() {
return this.includeChrome;
}
}
/**
* Returns a signature, initials, or stamps image..
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param signatureId The ID of the signature being accessed. (required)
* @param imageType One of **signature_image** or **initials_image**. (required)
* @return byte[]
*/
public byte[] getAccountSignatureImage(String accountId, String signatureId, String imageType)
throws ApiException {
return getAccountSignatureImage(accountId, signatureId, imageType, null);
}
/**
* Returns a signature, initials, or stamps image..
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param signatureId The ID of the signature being accessed. (required)
* @param imageType One of **signature_image** or **initials_image**. (required)
* @param options for modifying the method behavior.
* @return byte[]
* @throws ApiException if fails to make API call
*/
public byte[] getAccountSignatureImage(
String accountId,
String signatureId,
String imageType,
AccountsApi.GetAccountSignatureImageOptions 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 getAccountSignatureImage");
}
// verify the required parameter 'signatureId' is set
if (signatureId == null) {
throw new ApiException(
400,
"Missing the required parameter 'signatureId' when calling getAccountSignatureImage");
}
// verify the required parameter 'imageType' is set
if (imageType == null) {
throw new ApiException(
400, "Missing the required parameter 'imageType' when calling getAccountSignatureImage");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
.replaceAll(
"\\{" + "signatureId" + "\\}", apiClient.escapeString(signatureId.toString()))
.replaceAll("\\{" + "imageType" + "\\}", apiClient.escapeString(imageType.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("include_chrome", options.includeChrome));
}
final String[] localVarAccepts = {"image/gif"};
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 the managed signature definitions for the account
///
/** GetAccountSignaturesOptions Class. */
public class GetAccountSignaturesOptions {
private String stampFormat = null;
private String stampName = null;
private String stampType = null;
/** setStampFormat method. */
public void setStampFormat(String stampFormat) {
this.stampFormat = stampFormat;
}
/**
* getStampFormat method.
*
* @return String
*/
public String getStampFormat() {
return this.stampFormat;
}
/** setStampName method. */
public void setStampName(String stampName) {
this.stampName = stampName;
}
/**
* getStampName method.
*
* @return String
*/
public String getStampName() {
return this.stampName;
}
/** setStampType method. */
public void setStampType(String stampType) {
this.stampType = stampType;
}
/**
* getStampType method.
*
* @return String
*/
public String getStampType() {
return this.stampType;
}
}
/**
* Returns the managed signature definitions for the account.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @return AccountSignaturesInformation
*/
public AccountSignaturesInformation getAccountSignatures(String accountId) throws ApiException {
return getAccountSignatures(accountId, null);
}
/**
* Returns the managed signature definitions for the account.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param options for modifying the method behavior.
* @return AccountSignaturesInformation
* @throws ApiException if fails to make API call
*/
public AccountSignaturesInformation getAccountSignatures(
String accountId, AccountsApi.GetAccountSignaturesOptions 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 getAccountSignatures");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/signatures"
.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("stamp_format", options.stampFormat));
}
if (options != null) {
localVarQueryParams.addAll(apiClient.parameterToPair("stamp_name", options.stampName));
}
if (options != null) {
localVarQueryParams.addAll(apiClient.parameterToPair("stamp_type", options.stampType));
}
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 tab settings list for specified account.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @return TabAccountSettings
* @throws ApiException if fails to make API call
*/
public TabAccountSettings getAccountTabSettings(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 getAccountTabSettings");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/settings/tabs"
.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);
}
/**
* Get all payment gateway account for the provided accountId.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @return PaymentGatewayAccountsInfo
* @throws ApiException if fails to make API call
*/
public PaymentGatewayAccountsInfo getAllPaymentGatewayAccounts(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 getAllPaymentGatewayAccounts");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/payment_gateway_accounts"
.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 list of recurring and usage charges for the account. Retrieves the list of recurring and
// usage charges for the account. This can be used to determine the charge structure and usage of
// charge plan items. Privileges required: account administrator
///
/** GetBillingChargesOptions Class. */
public class GetBillingChargesOptions {
private String includeCharges = null;
/** setIncludeCharges method. */
public void setIncludeCharges(String includeCharges) {
this.includeCharges = includeCharges;
}
/**
* getIncludeCharges method.
*
* @return String
*/
public String getIncludeCharges() {
return this.includeCharges;
}
}
/**
* Gets list of recurring and usage charges for the account.. Retrieves the list of recurring and
* usage charges for the account. This can be used to determine the charge structure and usage of
* charge plan items. Privileges required: account administrator
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @return BillingChargeResponse
*/
public BillingChargeResponse getBillingCharges(String accountId) throws ApiException {
return getBillingCharges(accountId, null);
}
/**
* Gets list of recurring and usage charges for the account.. Retrieves the list of recurring and
* usage charges for the account. This can be used to determine the charge structure and usage of
* charge plan items. Privileges required: account administrator
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param options for modifying the method behavior.
* @return BillingChargeResponse
* @throws ApiException if fails to make API call
*/
public BillingChargeResponse getBillingCharges(
String accountId, AccountsApi.GetBillingChargesOptions 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 getBillingCharges");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/billing_charges"
.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("include_charges", options.includeCharges));
}
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 information for a specific brand.
///
/** GetBrandOptions Class. */
public class GetBrandOptions {
private String includeExternalReferences = null;
private String includeLogos = null;
/** setIncludeExternalReferences method. */
public void setIncludeExternalReferences(String includeExternalReferences) {
this.includeExternalReferences = includeExternalReferences;
}
/**
* getIncludeExternalReferences method.
*
* @return String
*/
public String getIncludeExternalReferences() {
return this.includeExternalReferences;
}
/** setIncludeLogos method. */
public void setIncludeLogos(String includeLogos) {
this.includeLogos = includeLogos;
}
/**
* getIncludeLogos method.
*
* @return String
*/
public String getIncludeLogos() {
return this.includeLogos;
}
}
/**
* Get information for a specific brand..
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param brandId The unique identifier of a brand. (required)
* @return Brand
*/
public Brand getBrand(String accountId, String brandId) throws ApiException {
return getBrand(accountId, brandId, null);
}
/**
* Get information for a specific brand..
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param brandId The unique identifier of a brand. (required)
* @param options for modifying the method behavior.
* @return Brand
* @throws ApiException if fails to make API call
*/
public Brand getBrand(String accountId, String brandId, AccountsApi.GetBrandOptions 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 getBrand");
}
// verify the required parameter 'brandId' is set
if (brandId == null) {
throw new ApiException(400, "Missing the required parameter 'brandId' when calling getBrand");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/brands/{brandId}"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
.replaceAll("\\{" + "brandId" + "\\}", apiClient.escapeString(brandId.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(
"include_external_references", options.includeExternalReferences));
}
if (options != null) {
localVarQueryParams.addAll(apiClient.parameterToPair("include_logos", options.includeLogos));
}
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);
}
/**
* Export a specific brand..
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param brandId The unique identifier of a brand. (required)
* @throws ApiException if fails to make API call
*/
public void getBrandExportFile(String accountId, String brandId) 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 getBrandExportFile");
}
// verify the required parameter 'brandId' is set
if (brandId == null) {
throw new ApiException(
400, "Missing the required parameter 'brandId' when calling getBrandExportFile");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/brands/{brandId}/file"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
.replaceAll("\\{" + "brandId" + "\\}", apiClient.escapeString(brandId.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,
"GET",
localVarQueryParams,
localVarCollectionQueryParams,
localVarPostBody,
localVarHeaderParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
null);
}
/**
* Obtains the specified image for a brand..
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param brandId The unique identifier of a brand. (required)
* @param logoType One of **Primary**, **Secondary** or **Email**. (required)
* @return byte[]
* @throws ApiException if fails to make API call
*/
public byte[] getBrandLogoByType(String accountId, String brandId, String logoType)
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 getBrandLogoByType");
}
// verify the required parameter 'brandId' is set
if (brandId == null) {
throw new ApiException(
400, "Missing the required parameter 'brandId' when calling getBrandLogoByType");
}
// verify the required parameter 'logoType' is set
if (logoType == null) {
throw new ApiException(
400, "Missing the required parameter 'logoType' when calling getBrandLogoByType");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
.replaceAll("\\{" + "brandId" + "\\}", apiClient.escapeString(brandId.toString()))
.replaceAll("\\{" + "logoType" + "\\}", apiClient.escapeString(logoType.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 = {"image/png"};
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 the specified account's list of branding resources (metadata)..
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param brandId The unique identifier of a brand. (required)
* @return BrandResourcesList
* @throws ApiException if fails to make API call
*/
public BrandResourcesList getBrandResources(String accountId, String brandId)
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 getBrandResources");
}
// verify the required parameter 'brandId' is set
if (brandId == null) {
throw new ApiException(
400, "Missing the required parameter 'brandId' when calling getBrandResources");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/brands/{brandId}/resources"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
.replaceAll("\\{" + "brandId" + "\\}", apiClient.escapeString(brandId.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
