Package com.docusign.click.api

Class AccountsApi

  • public class AccountsApi
extends Object
    AccountsApi class.

    • 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.

      • 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

      • createHasAgreedWithHttpInfo

        public ApiResponse<UserAgreementResponse> createHasAgreedWithHttpInfo​(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

      • 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

      • deleteClickwrapVersionWithHttpInfo

        public ApiResponse<ClickwrapVersionDeleteResponse> deleteClickwrapVersionWithHttpInfo​(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

      • deleteClickwrapVersionsWithHttpInfo

        public ApiResponse<ClickwrapVersionsDeleteResponse> deleteClickwrapVersionsWithHttpInfo​(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

      • getAgreementWithHttpInfo

        public ApiResponse<UserAgreementResponse> getAgreementWithHttpInfo​(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

      • getAgreementDocument

        public Document getAgreementDocument​(String accountId,
                                     String clickwrapId,
                                     String versionId,
                                     String orderOrDisclosure)
                              throws ApiException
        Downloads a document at an order within the agreement..
        Parameters:
        accountId - (required)
        clickwrapId - (required)
        versionId - (required)
        orderOrDisclosure - (required)
        Returns:
        Document
        Throws:
        ApiException - if fails to make API call

      • getAgreementDocumentWithHttpInfo

        public ApiResponse<Document> getAgreementDocumentWithHttpInfo​(String accountId,
                                                              String clickwrapId,
                                                              String versionId,
                                                              String orderOrDisclosure)
                                                       throws ApiException
        Downloads a document at an order within the agreement.
        Parameters:
        accountId - (required)
        clickwrapId - (required)
        versionId - (required)
        orderOrDisclosure - (required)
        Returns:
        Document
        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

      • getAgreementPdfWithHttpInfo

        public ApiResponse<byte[]> getAgreementPdfWithHttpInfo​(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

      • getClickwrapWithHttpInfo

        public ApiResponse<ClickwrapVersionResponse> getClickwrapWithHttpInfo​(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

      • 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

      • getClickwrapVersionWithHttpInfo

        public ApiResponse<ClickwrapVersionResponse> getClickwrapVersionWithHttpInfo​(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

      • 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

      • getServiceInformation

        public ServiceInformation getServiceInformation()
                                         throws ApiException
        Provides base service and version access information..
        Returns:
        ServiceInformation
        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