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.

      • createBulkClickwrapAgreements

        public void createBulkClickwrapAgreements​(String accountId,
                                          String clickwrapId,
                                          BulkClickwrapRequest bulkClickwrapRequest)
                                   throws ApiException
        Starts an export of clickwrap agreements for a specified date range.. Starts an asynchronus process to export clickwrap agreements for a specified date range. An email will be sent to the creator after it has been processed. [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        bulkClickwrapRequest - Data used to start a bulk agreements export. (optional)
        Throws:
        ApiException - if fails to make API call

      • createBulkClickwrapAgreementsWithHttpInfo

        public ApiResponse<Object> createBulkClickwrapAgreementsWithHttpInfo​(String accountId,
                                                                     String clickwrapId,
                                                                     BulkClickwrapRequest bulkClickwrapRequest)
                                                              throws ApiException
        Starts an export of clickwrap agreements for a specified date range. Starts an asynchronus process to export clickwrap agreements for a specified date range. An email will be sent to the creator after it has been processed. [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        bulkClickwrapRequest - Data used to start a bulk agreements export. (optional)
        Throws:
        ApiException - if fails to make API call

      • createClickwrap

        public ClickwrapVersionSummaryResponse createClickwrap​(String accountId,
                                                       ClickwrapRequest clickwrapRequest)
                                                throws ApiException
        Creates a clickwrap for an account.. Creates a clickwrap for an account. [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapRequest - Request body for working with clickwrap. (optional)
        Returns:
        ClickwrapVersionSummaryResponse
        Throws:
        ApiException - if fails to make API call

      • createClickwrapWithHttpInfo

        public ApiResponse<ClickwrapVersionSummaryResponse> createClickwrapWithHttpInfo​(String accountId,
                                                                                ClickwrapRequest clickwrapRequest)
                                                                         throws ApiException
        Creates a clickwrap for an account. Creates a clickwrap for an account. [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapRequest - Request body for working with clickwrap. (optional)
        Returns:
        ClickwrapVersionSummaryResponse
        Throws:
        ApiException - if fails to make API call

      • createClickwrapVersion

        public ClickwrapVersionSummaryResponse createClickwrapVersion​(String accountId,
                                                              String clickwrapId,
                                                              ClickwrapRequest clickwrapRequest)
                                                       throws ApiException
        Creates a new clickwrap version.. Creates a new version of an existing clickwrap. In a new version, you can replace the uploaded documents, change the display settings, and change the name of the clickwrap. The version number is automatically incremented based on the last version of the clickwrap. [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        clickwrapRequest - Request body for working with clickwrap. (optional)
        Returns:
        ClickwrapVersionSummaryResponse
        Throws:
        ApiException - if fails to make API call

      • createClickwrapVersionWithHttpInfo

        public ApiResponse<ClickwrapVersionSummaryResponse> createClickwrapVersionWithHttpInfo​(String accountId,
                                                                                       String clickwrapId,
                                                                                       ClickwrapRequest clickwrapRequest)
                                                                                throws ApiException
        Creates a new clickwrap version. Creates a new version of an existing clickwrap. In a new version, you can replace the uploaded documents, change the display settings, and change the name of the clickwrap. The version number is automatically incremented based on the last version of the clickwrap. [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        clickwrapRequest - Request body for working with clickwrap. (optional)
        Returns:
        ClickwrapVersionSummaryResponse
        Throws:
        ApiException - if fails to make API call

      • createHasAgreed

        public UserAgreementResponse createHasAgreed​(String accountId,
                                             String clickwrapId,
                                             UserAgreementRequest userAgreementRequest)
                                      throws ApiException
        Creates a unique URL for the agreement that you can embed in your application.. Creates a unique URL for the agreement that you can embed in your application. [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage` and `click.send`. The request must include at least the `clientUserId`. This is a value that you generate to identify the unique recipient of the agreement. If you are using a [dynamic content][] document, you can supply the values in the documentData property of the request, like this: ```json { \"clientUserId\": \"cl-bc7f-48a9\", \"documentData\": { \"fullName\": \"T. J. Fanning\", \"email\": \"tj@example.com\", \"company\": \"Fanning Indusdtries\", \"title\": \"Cat wrangler\", \"date\": \"2022-10-13T05:17:14-07:00\" } } ``` A response will look like this. The `agreementUrl` is unique to the user identified by the `clientUserId`. Your user can open the URL to approve the agreement. The `documentData` property appears only if you provided it in the request. ```json { \"accountId\": \"624e3e00-xxxx-xxxx-xxxx-43918c520dab\", \"clickwrapId\": \"0e64e4a7-xxxx-xxxx-xxxx-ce5a93b162af\", \"clientUserId\": \"tcl-bc7f-48a9j\", \"agreementId\": \"1f346c7d-xxxx-xxxx-xxxx-a5c968666785\", \"documents\": [ . . .], \"consumerDisclosureEnabled\": true, \"agreementUrl\": \"https://demo.docusign.net/clickapi/v1/redeem?agreementToken=AcTZT8g ... cxEqrUsA1lQ8DPPy05dE0\", \"createdOn\": \"2022-10-20T16:27:25.1287685Z\", \"status\": \"created\", \"versionId\": \"5957716d-xxxx-xxxx-xxxx-e1594f00ff12\", \"versionNumber\": 1, \"settings\": { \"displayName\": \"Agree with me\", \"hasDeclineButton\": true, . . . \"statementAlignment\": \"bottom\" }, \"documentData\": { \"fullName\": \"T. J. Fanning\", \"email\": \"tj@example.com\", \"company\": \"Fanning Indusdtries\", \"title\": \"Cat wrangler\", \"date\": \"2022-10-13T05:17:14-07:00\" } } ``` This method returns the following result codes and response bodies depending on whether the user has agreed. | Agreed | Response code | Response body | | :----- | :------------ | :--------------------- | | No | 201 | Full response as above | | Yes | 200 | No response (empty) | ### Related topics - [Add dynamic content to your clickwrap][dynamic content] - [How to embed a clickwrap][embed-howto] [dynamic content]: /docs/click-api/click101/customize-clickwrap-fields/#add-dynamic-content-to-your-clickwrap [embedding]: /docs/click-api/click101/customize-clickwrap-fields/#embed-clickwraps-that-contain-dynamic-content [embed-howto]: /docs/click-api/how-to/embed-clickwraps/
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        userAgreementRequest - Data used to create the agreement. (optional)
        Returns:
        UserAgreementResponse
        Throws:
        ApiException - if fails to make API call

      • createHasAgreedWithHttpInfo

        public ApiResponse<UserAgreementResponse> createHasAgreedWithHttpInfo​(String accountId,
                                                                      String clickwrapId,
                                                                      UserAgreementRequest userAgreementRequest)
                                                               throws ApiException
        Creates a unique URL for the agreement that you can embed in your application. Creates a unique URL for the agreement that you can embed in your application. [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage` and `click.send`. The request must include at least the `clientUserId`. This is a value that you generate to identify the unique recipient of the agreement. If you are using a [dynamic content][] document, you can supply the values in the documentData property of the request, like this: ```json { \"clientUserId\": \"cl-bc7f-48a9\", \"documentData\": { \"fullName\": \"T. J. Fanning\", \"email\": \"tj@example.com\", \"company\": \"Fanning Indusdtries\", \"title\": \"Cat wrangler\", \"date\": \"2022-10-13T05:17:14-07:00\" } } ``` A response will look like this. The `agreementUrl` is unique to the user identified by the `clientUserId`. Your user can open the URL to approve the agreement. The `documentData` property appears only if you provided it in the request. ```json { \"accountId\": \"624e3e00-xxxx-xxxx-xxxx-43918c520dab\", \"clickwrapId\": \"0e64e4a7-xxxx-xxxx-xxxx-ce5a93b162af\", \"clientUserId\": \"tcl-bc7f-48a9j\", \"agreementId\": \"1f346c7d-xxxx-xxxx-xxxx-a5c968666785\", \"documents\": [ . . .], \"consumerDisclosureEnabled\": true, \"agreementUrl\": \"https://demo.docusign.net/clickapi/v1/redeem?agreementToken=AcTZT8g ... cxEqrUsA1lQ8DPPy05dE0\", \"createdOn\": \"2022-10-20T16:27:25.1287685Z\", \"status\": \"created\", \"versionId\": \"5957716d-xxxx-xxxx-xxxx-e1594f00ff12\", \"versionNumber\": 1, \"settings\": { \"displayName\": \"Agree with me\", \"hasDeclineButton\": true, . . . \"statementAlignment\": \"bottom\" }, \"documentData\": { \"fullName\": \"T. J. Fanning\", \"email\": \"tj@example.com\", \"company\": \"Fanning Indusdtries\", \"title\": \"Cat wrangler\", \"date\": \"2022-10-13T05:17:14-07:00\" } } ``` This method returns the following result codes and response bodies depending on whether the user has agreed. | Agreed | Response code | Response body | | :----- | :------------ | :--------------------- | | No | 201 | Full response as above | | Yes | 200 | No response (empty) | ### Related topics - [Add dynamic content to your clickwrap][dynamic content] - [How to embed a clickwrap][embed-howto] [dynamic content]: /docs/click-api/click101/customize-clickwrap-fields/#add-dynamic-content-to-your-clickwrap [embedding]: /docs/click-api/click101/customize-clickwrap-fields/#embed-clickwraps-that-contain-dynamic-content [embed-howto]: /docs/click-api/how-to/embed-clickwraps/
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        userAgreementRequest - Data used to create the agreement. (optional)
        Returns:
        UserAgreementResponse
        Throws:
        ApiException - if fails to make API call

      • deleteClickwrap

        public ClickwrapVersionsDeleteResponse deleteClickwrap​(String accountId,
                                                       String clickwrapId)
                                                throws ApiException
        Deletes a clickwrap and all of its versions.. Deletes the clickwrap specified by `clickwrapId` and all of its versions. Active clickwraps are not deleted [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        Returns:
        ClickwrapVersionsDeleteResponse
        Throws:
        ApiException

      • deleteClickwrap

        public ClickwrapVersionsDeleteResponse deleteClickwrap​(String accountId,
                                                       String clickwrapId,
                                                       AccountsApi.DeleteClickwrapOptions options)
                                                throws ApiException
        Deletes a clickwrap and all of its versions.. Deletes the clickwrap specified by `clickwrapId` and all of its versions. Active clickwraps are not deleted [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        options - for modifying the method behavior.
        Returns:
        ClickwrapVersionsDeleteResponse
        Throws:
        ApiException - if fails to make API call

      • deleteClickwrapWithHttpInfo

        public ApiResponse<ClickwrapVersionsDeleteResponse> deleteClickwrapWithHttpInfo​(String accountId,
                                                                                String clickwrapId,
                                                                                AccountsApi.DeleteClickwrapOptions options)
                                                                         throws ApiException
        Deletes a clickwrap and all of its versions. Deletes the clickwrap specified by `clickwrapId` and all of its versions. Active clickwraps are not deleted [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (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
        Deletes a clickwrap version by version ID.. Deletes the clickwrap version specified by `versionId` of the clickwrap specified by `clickwrapId`. **Note:** This endpoint requires the version ID (a GUID), not the version number (an integer). [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        versionId - The ID of the clickwrap version. (required)
        Returns:
        ClickwrapVersionDeleteResponse
        Throws:
        ApiException - if fails to make API call

      • deleteClickwrapVersionWithHttpInfo

        public ApiResponse<ClickwrapVersionDeleteResponse> deleteClickwrapVersionWithHttpInfo​(String accountId,
                                                                                      String clickwrapId,
                                                                                      String versionId)
                                                                               throws ApiException
        Deletes a clickwrap version by version ID. Deletes the clickwrap version specified by `versionId` of the clickwrap specified by `clickwrapId`. **Note:** This endpoint requires the version ID (a GUID), not the version number (an integer). [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        versionId - The ID of the clickwrap version. (required)
        Returns:
        ClickwrapVersionDeleteResponse
        Throws:
        ApiException - if fails to make API call

      • deleteClickwrapVersions

        public ClickwrapVersionsDeleteResponse deleteClickwrapVersions​(String accountId,
                                                               String clickwrapId)
                                                        throws ApiException
        Deletes the versions of a clickwrap.. Deletes all versions of a clickwrap, or only the ones specified in the `clickwrapVersionIds` query parameter. [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        Returns:
        ClickwrapVersionsDeleteResponse
        Throws:
        ApiException

      • deleteClickwrapVersions

        public ClickwrapVersionsDeleteResponse deleteClickwrapVersions​(String accountId,
                                                               String clickwrapId,
                                                               AccountsApi.DeleteClickwrapVersionsOptions options)
                                                        throws ApiException
        Deletes the versions of a clickwrap.. Deletes all versions of a clickwrap, or only the ones specified in the `clickwrapVersionIds` query parameter. [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (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 of a clickwrap. Deletes all versions of a clickwrap, or only the ones specified in the `clickwrapVersionIds` query parameter. [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (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 clickwraps for an account.. Deletes all clickwraps for an account or only the ones specified in the `clickwrapIds` query parameter. [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        Returns:
        ClickwrapsDeleteResponse
        Throws:
        ApiException

      • deleteClickwraps

        public ClickwrapsDeleteResponse deleteClickwraps​(String accountId,
                                                 AccountsApi.DeleteClickwrapsOptions options)
                                          throws ApiException
        Deletes clickwraps for an account.. Deletes all clickwraps for an account or only the ones specified in the `clickwrapIds` query parameter. [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        options - for modifying the method behavior.
        Returns:
        ClickwrapsDeleteResponse
        Throws:
        ApiException - if fails to make API call

      • deleteClickwrapsWithHttpInfo

        public ApiResponse<ClickwrapsDeleteResponse> deleteClickwrapsWithHttpInfo​(String accountId,
                                                                          AccountsApi.DeleteClickwrapsOptions options)
                                                                   throws ApiException
        Deletes clickwraps for an account. Deletes all clickwraps for an account or only the ones specified in the `clickwrapIds` query parameter. [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (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 a specific agreement for a specified clickwrap.. Gets the agreement specified by `agreementId`. [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage` or `click.send`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        agreementId - The agreement ID. (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 a specific agreement for a specified clickwrap. Gets the agreement specified by `agreementId`. [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage` or `click.send`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        agreementId - The agreement ID. (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.. Downloads a specific document from the agreement presented to the user. [Required authentication scopes](/docs/click-api/click101/auth/): `click.sign`
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        versionId - The ID of the clickwrap version. (required)
        orderOrDisclosure - The order of the document or consumer_disclosure. (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. Downloads a specific document from the agreement presented to the user. [Required authentication scopes](/docs/click-api/click101/auth/): `click.sign`
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        versionId - The ID of the clickwrap version. (required)
        orderOrDisclosure - The order of the document or consumer_disclosure. (required)
        Returns:
        Document
        Throws:
        ApiException - if fails to make API call

      • getAgreementPdf

        public byte[] getAgreementPdf​(String accountId,
                              String clickwrapId,
                              String agreementId)
                       throws ApiException
        Gets the completed user agreement PDF.. Gets the PDF of `agreementId` for the clickwrap specified by `clickwrapId`. The response to this method is the bytes of the PDF file. The response includes the HTTP header `application/pdf`. [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage` or `click.send`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        agreementId - The agreement ID. (required)
        Returns:
        byte[]
        Throws:
        ApiException

      • getAgreementPdf

        public byte[] getAgreementPdf​(String accountId,
                              String clickwrapId,
                              String agreementId,
                              AccountsApi.GetAgreementPdfOptions options)
                       throws ApiException
        Gets the completed user agreement PDF.. Gets the PDF of `agreementId` for the clickwrap specified by `clickwrapId`. The response to this method is the bytes of the PDF file. The response includes the HTTP header `application/pdf`. [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage` or `click.send`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        agreementId - The agreement ID. (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
        Gets the completed user agreement PDF. Gets the PDF of `agreementId` for the clickwrap specified by `clickwrapId`. The response to this method is the bytes of the PDF file. The response includes the HTTP header `application/pdf`. [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage` or `click.send`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        agreementId - The agreement ID. (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 a single clickwrap object.. Retrieves the definition of the specified clickwrap. [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        Returns:
        ClickwrapVersionResponse
        Throws:
        ApiException - if fails to make API call

      • getClickwrapWithHttpInfo

        public ApiResponse<ClickwrapVersionResponse> getClickwrapWithHttpInfo​(String accountId,
                                                                      String clickwrapId)
                                                               throws ApiException
        Gets a single clickwrap object. Retrieves the definition of the specified clickwrap. [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        Returns:
        ClickwrapVersionResponse
        Throws:
        ApiException - if fails to make API call

      • getClickwrapAgreements

        public ClickwrapAgreementsResponse getClickwrapAgreements​(String accountId,
                                                          String clickwrapId)
                                                   throws ApiException
        Get user agreements. Retrieves the user agreements for a specified clickwrap. Each `userAgreementResponse` object describes a single user's response to the clickwrap. You can also filter the agreements by date, status, page number, and client user ID. [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        Returns:
        ClickwrapAgreementsResponse
        Throws:
        ApiException

      • getClickwrapAgreements

        public ClickwrapAgreementsResponse getClickwrapAgreements​(String accountId,
                                                          String clickwrapId,
                                                          AccountsApi.GetClickwrapAgreementsOptions options)
                                                   throws ApiException
        Get user agreements. Retrieves the user agreements for a specified clickwrap. Each `userAgreementResponse` object describes a single user's response to the clickwrap. You can also filter the agreements by date, status, page number, and client user ID. [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        options - for modifying the method behavior.
        Returns:
        ClickwrapAgreementsResponse
        Throws:
        ApiException - if fails to make API call

      • getClickwrapAgreementsWithHttpInfo

        public ApiResponse<ClickwrapAgreementsResponse> getClickwrapAgreementsWithHttpInfo​(String accountId,
                                                                                   String clickwrapId,
                                                                                   AccountsApi.GetClickwrapAgreementsOptions options)
                                                                            throws ApiException
        Get user agreements Retrieves the user agreements for a specified clickwrap. Each `userAgreementResponse` object describes a single user's response to the clickwrap. You can also filter the agreements by date, status, page number, and client user ID. [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (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 a specific version of a clickwrap by version ID.. Gets the version specified by `versionId` from the clickwrap `clickwrapId`. **Note:** This endpoint requires the version ID (a GUID), not the version number (an integer). [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        versionId - The ID of the clickwrap version. (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 a specific version of a clickwrap by version ID. Gets the version specified by `versionId` from the clickwrap `clickwrapId`. **Note:** This endpoint requires the version ID (a GUID), not the version number (an integer). [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        versionId - The ID of the clickwrap version. (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 by version ID.. Gets the agreement responses for a specific version. **Note:** This endpoint requires the version ID (a GUID), not the version number (an integer). [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        versionId - The ID of the clickwrap version. (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 by version ID.. Gets the agreement responses for a specific version. **Note:** This endpoint requires the version ID (a GUID), not the version number (an integer). [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        versionId - The ID of the clickwrap version. (required)
        options - for modifying the method behavior.
        Returns:
        ClickwrapAgreementsResponse
        Throws:
        ApiException - if fails to make API call

      • getClickwrapVersionAgreementsWithHttpInfo

        public ApiResponse<ClickwrapAgreementsResponse> getClickwrapVersionAgreementsWithHttpInfo​(String accountId,
                                                                                          String clickwrapId,
                                                                                          String versionId,
                                                                                          AccountsApi.GetClickwrapVersionAgreementsOptions options)
                                                                                   throws ApiException
        Gets the agreement responses for a clickwrap version by version ID. Gets the agreement responses for a specific version. **Note:** This endpoint requires the version ID (a GUID), not the version number (an integer). [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        versionId - The ID of the clickwrap version. (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.. Gets all the versions of a clickwrap for an account. [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        Returns:
        ClickwrapVersionsPagedResponse
        Throws:
        ApiException - if fails to make API call

      • getClickwrapVersionsWithHttpInfo

        public ApiResponse<ClickwrapVersionsPagedResponse> getClickwrapVersionsWithHttpInfo​(String accountId,
                                                                                    String clickwrapId)
                                                                             throws ApiException
        Gets all the versions of a clickwrap. Gets all the versions of a clickwrap for an account. [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        Returns:
        ClickwrapVersionsPagedResponse
        Throws:
        ApiException - if fails to make API call

      • getClickwraps

        public ClickwrapVersionsResponse getClickwraps​(String accountId)
                                        throws ApiException
        Gets all the clickwraps for a user.. Gets all the clickwraps for a user. **Note:** This endpoint returns a list of `clickwrapVersionSummaryResponse` objects. Each version of each clickwrap is returned as a separate entry in the list. [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        Returns:
        ClickwrapVersionsResponse
        Throws:
        ApiException

      • getClickwraps

        public ClickwrapVersionsResponse getClickwraps​(String accountId,
                                               AccountsApi.GetClickwrapsOptions options)
                                        throws ApiException
        Gets all the clickwraps for a user.. Gets all the clickwraps for a user. **Note:** This endpoint returns a list of `clickwrapVersionSummaryResponse` objects. Each version of each clickwrap is returned as a separate entry in the list. [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        options - for modifying the method behavior.
        Returns:
        ClickwrapVersionsResponse
        Throws:
        ApiException - if fails to make API call

      • getClickwrapsWithHttpInfo

        public ApiResponse<ClickwrapVersionsResponse> getClickwrapsWithHttpInfo​(String accountId,
                                                                        AccountsApi.GetClickwrapsOptions options)
                                                                 throws ApiException
        Gets all the clickwraps for a user. Gets all the clickwraps for a user. **Note:** This endpoint returns a list of `clickwrapVersionSummaryResponse` objects. Each version of each clickwrap is returned as a separate entry in the list. [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        options - for modifying the method behavior.
        Returns:
        ClickwrapVersionsResponse
        Throws:
        ApiException - if fails to make API call

      • getServiceInformation

        public ServiceInformation getServiceInformation()
                                         throws ApiException
        Gets the current version and other information about the Click API.. The response includes information about the Click API, including the service version, build version, and linked sites. This method does not require authentication.
        Returns:
        ServiceInformation
        Throws:
        ApiException - if fails to make API call

      • getServiceInformationWithHttpInfo

        public ApiResponse<ServiceInformation> getServiceInformationWithHttpInfo()
                                                                  throws ApiException
        Gets the current version and other information about the Click API. The response includes information about the Click API, including the service version, build version, and linked sites. This method does not require authentication.
        Returns:
        ServiceInformation
        Throws:
        ApiException - if fails to make API call

      • updateClickwrap

        public ClickwrapVersionSummaryResponse updateClickwrap​(String accountId,
                                                       String clickwrapId,
                                                       ClickwrapTransferRequest clickwrapTransferRequest)
                                                throws ApiException
        Update a clickwrap by ID.. Update a subset of properties on the clickwrap. [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        clickwrapTransferRequest - Data used to transfer a clickwrap from one user to another. (optional)
        Returns:
        ClickwrapVersionSummaryResponse
        Throws:
        ApiException - if fails to make API call

      • updateClickwrapWithHttpInfo

        public ApiResponse<ClickwrapVersionSummaryResponse> updateClickwrapWithHttpInfo​(String accountId,
                                                                                String clickwrapId,
                                                                                ClickwrapTransferRequest clickwrapTransferRequest)
                                                                         throws ApiException
        Update a clickwrap by ID. Update a subset of properties on the clickwrap. [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        clickwrapTransferRequest - Data used to transfer a clickwrap from one user to another. (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 clickwrap version status and ownership.. Updates the clickwrap version status and ownership by transferring from previous user ID to new user ID. **Note:** This endpoint requires the version ID (a GUID), not the version number (an integer). [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        versionId - The ID of the clickwrap version. (required)
        clickwrapRequest - Request body for working with clickwrap. (optional)
        Returns:
        ClickwrapVersionSummaryResponse
        Throws:
        ApiException - if fails to make API call

      • updateClickwrapVersionWithHttpInfo

        public ApiResponse<ClickwrapVersionSummaryResponse> updateClickwrapVersionWithHttpInfo​(String accountId,
                                                                                       String clickwrapId,
                                                                                       String versionId,
                                                                                       ClickwrapRequest clickwrapRequest)
                                                                                throws ApiException
        Updates clickwrap version status and ownership. Updates the clickwrap version status and ownership by transferring from previous user ID to new user ID. **Note:** This endpoint requires the version ID (a GUID), not the version number (an integer). [Required authentication scopes](/docs/click-api/click101/auth/): `click.manage`.
        Parameters:
        accountId - The external account number (int) or account ID GUID. (required)
        clickwrapId - The ID of the clickwrap. (required)
        versionId - The ID of the clickwrap version. (required)
        clickwrapRequest - Request body for working with clickwrap. (optional)
        Returns:
        ClickwrapVersionSummaryResponse
        Throws:
        ApiException - if fails to make API call