Package com.docusign.click.api

Class AccountsApi

java.lang.Object

com.docusign.click.api.AccountsApi

public class AccountsApi
extends Object

AccountsApi class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	AccountsApi.DeleteClickwrapOptions	DeleteClickwrapOptions Class.
class	AccountsApi.DeleteClickwrapsOptions	DeleteClickwrapsOptions Class.
class	AccountsApi.DeleteClickwrapVersionsOptions	DeleteClickwrapVersionsOptions Class.
class	AccountsApi.GetAgreementPdfOptions	GetAgreementPdfOptions Class.
class	AccountsApi.GetClickwrapAgreementsOptions	GetClickwrapAgreementsOptions Class.
class	AccountsApi.GetClickwrapsOptions	GetClickwrapsOptions Class.
class	AccountsApi.GetClickwrapVersionAgreementsOptions	GetClickwrapVersionAgreementsOptions Class.

Constructor Summary

Constructors

Constructor	Description
AccountsApi()	AccountsApi.
AccountsApi(ApiClient apiClient)	AccountsApi.

Method Summary

Modifier and Type	Method	Description
ClickwrapVersionSummaryResponse	createClickwrap(String accountId, ClickwrapRequest clickwrapRequest)	Creates a Clickwrap for the specified accountId.
ClickwrapVersionSummaryResponse	createClickwrapVersion(String accountId, String clickwrapId, ClickwrapRequest clickwrapRequest)	Creates the clickwrap version.
UserAgreementResponse	createHasAgreed(String accountId, String clickwrapId, UserAgreementRequest userAgreementRequest)	Checks if a user has agreed to a clickwrap and returns a response with the agreement url.
ClickwrapVersionsDeleteResponse	deleteClickwrap(String accountId, String clickwrapId)	Deletes the clickwrap and all its version specified by clickwrapId.
ClickwrapVersionsDeleteResponse	deleteClickwrap(String accountId, String clickwrapId, AccountsApi.DeleteClickwrapOptions options)	Deletes the clickwrap and all its version specified by clickwrapId.
ClickwrapsDeleteResponse	deleteClickwraps(String accountId)	Deletes all the clickwraps for an account or the ones passed in query parameter clickwrapIds.
ClickwrapsDeleteResponse	deleteClickwraps(String accountId, AccountsApi.DeleteClickwrapsOptions options)	Deletes all the clickwraps for an account or the ones passed in query parameter clickwrapIds.
ClickwrapVersionDeleteResponse	deleteClickwrapVersion(String accountId, String clickwrapId, String versionId)	Delete a Clickwrap version specified by versionId.
ClickwrapVersionsDeleteResponse	deleteClickwrapVersions(String accountId, String clickwrapId)	Deletes the versions specified by query parameter clickwrapVersionIds for a clickwrap, or all versions if no query parameter is specified.
ClickwrapVersionsDeleteResponse	deleteClickwrapVersions(String accountId, String clickwrapId, AccountsApi.DeleteClickwrapVersionsOptions options)	Deletes the versions specified by query parameter clickwrapVersionIds for a clickwrap, or all versions if no query parameter is specified.
UserAgreementResponse	getAgreement(String accountId, String clickwrapId, String agreementId)	Gets the agreement by a provided agreement ID.
byte[]	getAgreementPdf(String accountId, String clickwrapId, String agreementId)	Downloads the agreement PDF and optionally certificate of completion..
byte[]	getAgreementPdf(String accountId, String clickwrapId, String agreementId, AccountsApi.GetAgreementPdfOptions options)	Downloads the agreement PDF and optionally certificate of completion..
ApiClient	getApiClient()	getApiClient Method.
ClickwrapVersionResponse	getClickwrap(String accountId, String clickwrapId)	Gets the clickwrap for an account specified by clickwrapId.
ClickwrapAgreementsResponse	getClickwrapAgreements(String accountId, String clickwrapId)	Gets the agreement responses for a clickwrap.
ClickwrapAgreementsResponse	getClickwrapAgreements(String accountId, String clickwrapId, AccountsApi.GetClickwrapAgreementsOptions options)	Gets the agreement responses for a clickwrap.
ClickwrapVersionsResponse	getClickwraps(String accountId)	Gets the Clickwraps for an account.
ClickwrapVersionsResponse	getClickwraps(String accountId, AccountsApi.GetClickwrapsOptions options)	Gets the Clickwraps for an account.
ClickwrapVersionResponse	getClickwrapVersion(String accountId, String clickwrapId, String versionId)	Gets the Clickwrap version by clickwrapId and versionId for an account.
ClickwrapAgreementsResponse	getClickwrapVersionAgreements(String accountId, String clickwrapId, String versionId)	Gets the agreement responses for a clickwrap version.
ClickwrapAgreementsResponse	getClickwrapVersionAgreements(String accountId, String clickwrapId, String versionId, AccountsApi.GetClickwrapVersionAgreementsOptions options)	Gets the agreement responses for a clickwrap version.
ClickwrapVersionsPagedResponse	getClickwrapVersions(String accountId, String clickwrapId)	Gets all the versions of a clickwrap for an account.
ServiceInformation	getServiceInformation()	Provides base service and version access information..
void	setApiClient(ApiClient apiClient)	setApiClient Method.
ClickwrapVersionSummaryResponse	updateClickwrap(String accountId, String clickwrapId, ClickwrapTransferRequest clickwrapTransferRequest)	Updates the clickwrap specified by clickwrapId.
ClickwrapVersionSummaryResponse	updateClickwrapVersion(String accountId, String clickwrapId, String versionId, ClickwrapRequest clickwrapRequest)	Updates the clickwrap version specified by versionId.

Methods inherited from class java.lang.Object

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

Constructor Detail

AccountsApi

public AccountsApi()

AccountsApi.

AccountsApi

public AccountsApi(ApiClient apiClient)

AccountsApi.

Method Detail

getApiClient

public ApiClient getApiClient()

getApiClient Method.

Returns:

ApiClient

setApiClient

public void setApiClient(ApiClient apiClient)

setApiClient Method.

createClickwrap

public ClickwrapVersionSummaryResponse createClickwrap(String accountId,
                                                       ClickwrapRequest clickwrapRequest)
                                                throws ApiException

Creates a Clickwrap for the specified accountId.

Parameters:

accountId - (required)

clickwrapRequest - (optional)

Returns:

ClickwrapVersionSummaryResponse

Throws:

ApiException - if fails to make API call

createClickwrapVersion

public ClickwrapVersionSummaryResponse createClickwrapVersion(String accountId,
                                                              String clickwrapId,
                                                              ClickwrapRequest clickwrapRequest)
                                                       throws ApiException

Creates the clickwrap version.

Parameters:

accountId - (required)

clickwrapId - (required)

clickwrapRequest - (optional)

Returns:

ClickwrapVersionSummaryResponse

Throws:

ApiException - if fails to make API call

createHasAgreed

public UserAgreementResponse createHasAgreed(String accountId,
                                             String clickwrapId,
                                             UserAgreementRequest userAgreementRequest)
                                      throws ApiException

Checks if a user has agreed to a clickwrap and returns a response with the agreement url. Returns HttpStatusCode.OK if user has no pending agreement..

Parameters:

accountId - (required)

clickwrapId - (required)

userAgreementRequest - (optional)

Returns:

UserAgreementResponse

Throws:

ApiException - if fails to make API call

deleteClickwrap

public ClickwrapVersionsDeleteResponse deleteClickwrap(String accountId,
                                                       String clickwrapId)
                                                throws ApiException

Deletes the clickwrap and all its version specified by clickwrapId. Active clickwrap will not get deleted.

Parameters:

accountId - (required)

clickwrapId - (required)

Returns:

ClickwrapVersionsDeleteResponse

Throws:

ApiException

deleteClickwrap

public ClickwrapVersionsDeleteResponse deleteClickwrap(String accountId,
                                                       String clickwrapId,
                                                       AccountsApi.DeleteClickwrapOptions options)
                                                throws ApiException

Deletes the clickwrap and all its version specified by clickwrapId. Active clickwrap will not get deleted.

Parameters:

accountId - (required)

clickwrapId - (required)

options - for modifying the method behavior.

Returns:

ClickwrapVersionsDeleteResponse

Throws:

ApiException - if fails to make API call

deleteClickwrapVersion

public ClickwrapVersionDeleteResponse deleteClickwrapVersion(String accountId,
                                                             String clickwrapId,
                                                             String versionId)
                                                      throws ApiException

Delete a Clickwrap version specified by versionId.

Parameters:

accountId - (required)

clickwrapId - (required)

versionId - (required)

Returns:

ClickwrapVersionDeleteResponse

Throws:

ApiException - if fails to make API call

deleteClickwrapVersions

public ClickwrapVersionsDeleteResponse deleteClickwrapVersions(String accountId,
                                                               String clickwrapId)
                                                        throws ApiException

Deletes the versions specified by query parameter clickwrapVersionIds for a clickwrap, or all versions if no query parameter is specified. It will not delete if a version is active..

Parameters:

accountId - (required)

clickwrapId - (required)

Returns:

ClickwrapVersionsDeleteResponse

Throws:

ApiException

deleteClickwrapVersions

public ClickwrapVersionsDeleteResponse deleteClickwrapVersions(String accountId,
                                                               String clickwrapId,
                                                               AccountsApi.DeleteClickwrapVersionsOptions options)
                                                        throws ApiException

Deletes the versions specified by query parameter clickwrapVersionIds for a clickwrap, or all versions if no query parameter is specified. It will not delete if a version is active..

Parameters:

accountId - (required)

clickwrapId - (required)

options - for modifying the method behavior.

Returns:

ClickwrapVersionsDeleteResponse

Throws:

ApiException - if fails to make API call

deleteClickwraps

public ClickwrapsDeleteResponse deleteClickwraps(String accountId)
                                          throws ApiException

Deletes all the clickwraps for an account or the ones passed in query parameter clickwrapIds. It will not delete active clickwraps..

Parameters:

accountId - (required)

Returns:

ClickwrapsDeleteResponse

Throws:

ApiException

deleteClickwraps

public ClickwrapsDeleteResponse deleteClickwraps(String accountId,
                                                 AccountsApi.DeleteClickwrapsOptions options)
                                          throws ApiException

Deletes all the clickwraps for an account or the ones passed in query parameter clickwrapIds. It will not delete active clickwraps..

Parameters:

accountId - (required)

options - for modifying the method behavior.

Returns:

ClickwrapsDeleteResponse

Throws:

ApiException - if fails to make API call

getAgreement

public UserAgreementResponse getAgreement(String accountId,
                                          String clickwrapId,
                                          String agreementId)
                                   throws ApiException

Gets the agreement by a provided agreement ID.

Parameters:

accountId - (required)

clickwrapId - (required)

agreementId - (required)

Returns:

UserAgreementResponse

Throws:

ApiException - if fails to make API call

getAgreementPdf

public byte[] getAgreementPdf(String accountId,
                              String clickwrapId,
                              String agreementId)
                       throws ApiException

Downloads the agreement PDF and optionally certificate of completion..

Parameters:

accountId - (required)

clickwrapId - (required)

agreementId - (required)

Returns:

byte[]

Throws:

ApiException

getAgreementPdf

public byte[] getAgreementPdf(String accountId,
                              String clickwrapId,
                              String agreementId,
                              AccountsApi.GetAgreementPdfOptions options)
                       throws ApiException

Downloads the agreement PDF and optionally certificate of completion..

Parameters:

accountId - (required)

clickwrapId - (required)

agreementId - (required)

options - for modifying the method behavior.

Returns:

byte[]

Throws:

ApiException - if fails to make API call

getClickwrap

public ClickwrapVersionResponse getClickwrap(String accountId,
                                             String clickwrapId)
                                      throws ApiException

Gets the clickwrap for an account specified by clickwrapId.

Parameters:

accountId - (required)

clickwrapId - (required)

Returns:

ClickwrapVersionResponse

Throws:

ApiException - if fails to make API call

getClickwrapAgreements

public ClickwrapAgreementsResponse getClickwrapAgreements(String accountId,
                                                          String clickwrapId)
                                                   throws ApiException

Gets the agreement responses for a clickwrap.

Parameters:

accountId - (required)

clickwrapId - (required)

Returns:

ClickwrapAgreementsResponse

Throws:

ApiException

getClickwrapAgreements

public ClickwrapAgreementsResponse getClickwrapAgreements(String accountId,
                                                          String clickwrapId,
                                                          AccountsApi.GetClickwrapAgreementsOptions options)
                                                   throws ApiException

Gets the agreement responses for a clickwrap.

Parameters:

accountId - (required)

clickwrapId - (required)

options - for modifying the method behavior.

Returns:

ClickwrapAgreementsResponse

Throws:

ApiException - if fails to make API call

getClickwrapVersion

public ClickwrapVersionResponse getClickwrapVersion(String accountId,
                                                    String clickwrapId,
                                                    String versionId)
                                             throws ApiException

Gets the Clickwrap version by clickwrapId and versionId for an account.

Parameters:

accountId - (required)

clickwrapId - (required)

versionId - (required)

Returns:

ClickwrapVersionResponse

Throws:

ApiException - if fails to make API call

getClickwrapVersionAgreements

public ClickwrapAgreementsResponse getClickwrapVersionAgreements(String accountId,
                                                                 String clickwrapId,
                                                                 String versionId)
                                                          throws ApiException

Gets the agreement responses for a clickwrap version.

Parameters:

accountId - (required)

clickwrapId - (required)

versionId - (required)

Returns:

ClickwrapAgreementsResponse

Throws:

ApiException

getClickwrapVersionAgreements

public ClickwrapAgreementsResponse getClickwrapVersionAgreements(String accountId,
                                                                 String clickwrapId,
                                                                 String versionId,
                                                                 AccountsApi.GetClickwrapVersionAgreementsOptions options)
                                                          throws ApiException

Gets the agreement responses for a clickwrap version.

Parameters:

accountId - (required)

clickwrapId - (required)

versionId - (required)

options - for modifying the method behavior.

Returns:

ClickwrapAgreementsResponse

Throws:

ApiException - if fails to make API call

getClickwrapVersions

public ClickwrapVersionsPagedResponse getClickwrapVersions(String accountId,
                                                           String clickwrapId)
                                                    throws ApiException

Gets all the versions of a clickwrap for an account.

Parameters:

accountId - (required)

clickwrapId - (required)

Returns:

ClickwrapVersionsPagedResponse

Throws:

ApiException - if fails to make API call

getClickwraps

public ClickwrapVersionsResponse getClickwraps(String accountId)
                                        throws ApiException

Gets the Clickwraps for an account.

Parameters:

accountId - (required)

Returns:

ClickwrapVersionsResponse

Throws:

ApiException

getClickwraps

public ClickwrapVersionsResponse getClickwraps(String accountId,
                                               AccountsApi.GetClickwrapsOptions options)
                                        throws ApiException

Gets the Clickwraps for an account.

Parameters:

accountId - (required)

options - for modifying the method behavior.

Returns:

ClickwrapVersionsResponse

Throws:

ApiException - if fails to make API call

getServiceInformation

public ServiceInformation getServiceInformation()
                                         throws ApiException

Provides base service and version access information..

Returns:

ServiceInformation

Throws:

ApiException - if fails to make API call

updateClickwrap

public ClickwrapVersionSummaryResponse updateClickwrap(String accountId,
                                                       String clickwrapId,
                                                       ClickwrapTransferRequest clickwrapTransferRequest)
                                                throws ApiException

Updates the clickwrap specified by clickwrapId.

Parameters:

accountId - (required)

clickwrapId - (required)

clickwrapTransferRequest - (optional)

Returns:

ClickwrapVersionSummaryResponse

Throws:

ApiException - if fails to make API call

updateClickwrapVersion

public ClickwrapVersionSummaryResponse updateClickwrapVersion(String accountId,
                                                              String clickwrapId,
                                                              String versionId,
                                                              ClickwrapRequest clickwrapRequest)
                                                       throws ApiException

Updates the clickwrap version specified by versionId.

Parameters:

accountId - (required)

clickwrapId - (required)

versionId - (required)

clickwrapRequest - (optional)

Returns:

ClickwrapVersionSummaryResponse

Throws:

ApiException - if fails to make API call