Package com.boldsign.api

Class DocumentApi

  • public class DocumentApi
extends Object

    • Constructor Detail

      • DocumentApi

        public DocumentApi()

      • DocumentApi

        public DocumentApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • getHostIndex

        public int getHostIndex()

      • setHostIndex

        public void setHostIndex​(int hostIndex)

      • getCustomBaseUrl

        public String getCustomBaseUrl()

      • setCustomBaseUrl

        public void setCustomBaseUrl​(String customBaseUrl)

      • addAuthenticationCall

        public okhttp3.Call addAuthenticationCall​(String documentId,
                                          AccessCodeDetail accessCodeDetail,
                                          ApiCallback _callback)
                                   throws ApiException
        Build call for addAuthentication
        Parameters:
        documentId - The DocumentId. (required)
        accessCodeDetail - Access code details. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • addAuthentication

        public void addAuthentication​(String documentId,
                              AccessCodeDetail accessCodeDetail)
                       throws ApiException
        The add authentication to recipient.
        Parameters:
        documentId - The DocumentId. (required)
        accessCodeDetail - Access code details. (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • addAuthenticationWithHttpInfo

        public ApiResponse<Void> addAuthenticationWithHttpInfo​(String documentId,
                                                       AccessCodeDetail accessCodeDetail)
                                                throws ApiException
        The add authentication to recipient.
        Parameters:
        documentId - The DocumentId. (required)
        accessCodeDetail - Access code details. (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • addAuthenticationAsync

        public okhttp3.Call addAuthenticationAsync​(String documentId,
                                           AccessCodeDetail accessCodeDetail,
                                           ApiCallback<Void> _callback)
                                    throws ApiException
        The add authentication to recipient. (asynchronously)
        Parameters:
        documentId - The DocumentId. (required)
        accessCodeDetail - Access code details. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • addTagCall

        public okhttp3.Call addTagCall​(DocumentTags documentTags,
                               ApiCallback _callback)
                        throws ApiException
        Build call for addTag
        Parameters:
        documentTags - Contains DocumentId and LabelNames for Adding Tags. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        400 Bad Request -
        401 Unauthorized -

      • addTag

        public void addTag​(DocumentTags documentTags)
            throws ApiException
        Add the Tags in Documents.
        Parameters:
        documentTags - Contains DocumentId and LabelNames for Adding Tags. (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        400 Bad Request -
        401 Unauthorized -

      • addTagWithHttpInfo

        public ApiResponse<Void> addTagWithHttpInfo​(DocumentTags documentTags)
                                     throws ApiException
        Add the Tags in Documents.
        Parameters:
        documentTags - Contains DocumentId and LabelNames for Adding Tags. (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        400 Bad Request -
        401 Unauthorized -

      • addTagAsync

        public okhttp3.Call addTagAsync​(DocumentTags documentTags,
                                ApiCallback<Void> _callback)
                         throws ApiException
        Add the Tags in Documents. (asynchronously)
        Parameters:
        documentTags - Contains DocumentId and LabelNames for Adding Tags. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        400 Bad Request -
        401 Unauthorized -

      • behalfDocumentsCall

        public okhttp3.Call behalfDocumentsCall​(Integer page,
                                        String pageType,
                                        List<String> emailAddress,
                                        List<String> signers,
                                        Integer pageSize,
                                        OffsetDateTime startDate,
                                        List<String> status,
                                        OffsetDateTime endDate,
                                        String searchKey,
                                        List<String> labels,
                                        Long nextCursor,
                                        List<String> brandIds,
                                        ApiCallback _callback)
                                 throws ApiException
        Build call for behalfDocuments
        Parameters:
        page - Page index specified in get document list request. (required)
        pageType - The filter used to differentiate between documents sent on the user's behalf and documents sent by the user on behalf of others. The API will return documents based on the specified value. (optional)
        emailAddress - The sender identity's email used to filter the documents returned in the API. The API will return documents that were sent on behalf of the specified email address. (optional)
        signers - A list of signer email addresses used to filter the documents returned in the API. The API will return documents where the signer's email address matches one of the email addresses provided in this list (optional)
        pageSize - Page size specified in get document list request. (optional, default to 10)
        startDate - Start date of the document (optional)
        status - Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft. (optional)
        endDate - End date of the document (optional)
        searchKey - Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc., (optional)
        labels - Labels of the document. (optional)
        nextCursor - Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records. (optional)
        brandIds - BrandId(s) of the document. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • behalfDocuments

        public BehalfDocumentRecords behalfDocuments​(Integer page,
                                             String pageType,
                                             List<String> emailAddress,
                                             List<String> signers,
                                             Integer pageSize,
                                             OffsetDateTime startDate,
                                             List<String> status,
                                             OffsetDateTime endDate,
                                             String searchKey,
                                             List<String> labels,
                                             Long nextCursor,
                                             List<String> brandIds)
                                      throws ApiException
        Gets the behalf documents.
        Parameters:
        page - Page index specified in get document list request. (required)
        pageType - The filter used to differentiate between documents sent on the user's behalf and documents sent by the user on behalf of others. The API will return documents based on the specified value. (optional)
        emailAddress - The sender identity's email used to filter the documents returned in the API. The API will return documents that were sent on behalf of the specified email address. (optional)
        signers - A list of signer email addresses used to filter the documents returned in the API. The API will return documents where the signer's email address matches one of the email addresses provided in this list (optional)
        pageSize - Page size specified in get document list request. (optional, default to 10)
        startDate - Start date of the document (optional)
        status - Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft. (optional)
        endDate - End date of the document (optional)
        searchKey - Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc., (optional)
        labels - Labels of the document. (optional)
        nextCursor - Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records. (optional)
        brandIds - BrandId(s) of the document. (optional)
        Returns:
        BehalfDocumentRecords
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • behalfDocumentsWithHttpInfo

        public ApiResponse<BehalfDocumentRecords> behalfDocumentsWithHttpInfo​(Integer page,
                                                                      String pageType,
                                                                      List<String> emailAddress,
                                                                      List<String> signers,
                                                                      Integer pageSize,
                                                                      OffsetDateTime startDate,
                                                                      List<String> status,
                                                                      OffsetDateTime endDate,
                                                                      String searchKey,
                                                                      List<String> labels,
                                                                      Long nextCursor,
                                                                      List<String> brandIds)
                                                               throws ApiException
        Gets the behalf documents.
        Parameters:
        page - Page index specified in get document list request. (required)
        pageType - The filter used to differentiate between documents sent on the user's behalf and documents sent by the user on behalf of others. The API will return documents based on the specified value. (optional)
        emailAddress - The sender identity's email used to filter the documents returned in the API. The API will return documents that were sent on behalf of the specified email address. (optional)
        signers - A list of signer email addresses used to filter the documents returned in the API. The API will return documents where the signer's email address matches one of the email addresses provided in this list (optional)
        pageSize - Page size specified in get document list request. (optional, default to 10)
        startDate - Start date of the document (optional)
        status - Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft. (optional)
        endDate - End date of the document (optional)
        searchKey - Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc., (optional)
        labels - Labels of the document. (optional)
        nextCursor - Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records. (optional)
        brandIds - BrandId(s) of the document. (optional)
        Returns:
        ApiResponse<BehalfDocumentRecords>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • behalfDocumentsAsync

        public okhttp3.Call behalfDocumentsAsync​(Integer page,
                                         String pageType,
                                         List<String> emailAddress,
                                         List<String> signers,
                                         Integer pageSize,
                                         OffsetDateTime startDate,
                                         List<String> status,
                                         OffsetDateTime endDate,
                                         String searchKey,
                                         List<String> labels,
                                         Long nextCursor,
                                         List<String> brandIds,
                                         ApiCallback<BehalfDocumentRecords> _callback)
                                  throws ApiException
        Gets the behalf documents. (asynchronously)
        Parameters:
        page - Page index specified in get document list request. (required)
        pageType - The filter used to differentiate between documents sent on the user's behalf and documents sent by the user on behalf of others. The API will return documents based on the specified value. (optional)
        emailAddress - The sender identity's email used to filter the documents returned in the API. The API will return documents that were sent on behalf of the specified email address. (optional)
        signers - A list of signer email addresses used to filter the documents returned in the API. The API will return documents where the signer's email address matches one of the email addresses provided in this list (optional)
        pageSize - Page size specified in get document list request. (optional, default to 10)
        startDate - Start date of the document (optional)
        status - Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft. (optional)
        endDate - End date of the document (optional)
        searchKey - Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc., (optional)
        labels - Labels of the document. (optional)
        nextCursor - Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records. (optional)
        brandIds - BrandId(s) of the document. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • changeAccessCodeCall

        public okhttp3.Call changeAccessCodeCall​(String documentId,
                                         AccessCodeDetails accessCodeDetails,
                                         String emailId,
                                         Integer zorder,
                                         ApiCallback _callback)
                                  throws ApiException
        Build call for changeAccessCode
        Parameters:
        documentId - (required)
        accessCodeDetails - The new access code. (required)
        emailId - (optional)
        zorder - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        204 No Content -
        401 Unauthorized -
        403 Forbidden -

      • changeAccessCode

        public void changeAccessCode​(String documentId,
                             AccessCodeDetails accessCodeDetails,
                             String emailId,
                             Integer zorder)
                      throws ApiException
        Changes the access code for the given document signer.
        Parameters:
        documentId - (required)
        accessCodeDetails - The new access code. (required)
        emailId - (optional)
        zorder - (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        204 No Content -
        401 Unauthorized -
        403 Forbidden -

      • changeAccessCodeWithHttpInfo

        public ApiResponse<Void> changeAccessCodeWithHttpInfo​(String documentId,
                                                      AccessCodeDetails accessCodeDetails,
                                                      String emailId,
                                                      Integer zorder)
                                               throws ApiException
        Changes the access code for the given document signer.
        Parameters:
        documentId - (required)
        accessCodeDetails - The new access code. (required)
        emailId - (optional)
        zorder - (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        204 No Content -
        401 Unauthorized -
        403 Forbidden -

      • changeAccessCodeAsync

        public okhttp3.Call changeAccessCodeAsync​(String documentId,
                                          AccessCodeDetails accessCodeDetails,
                                          String emailId,
                                          Integer zorder,
                                          ApiCallback<Void> _callback)
                                   throws ApiException
        Changes the access code for the given document signer. (asynchronously)
        Parameters:
        documentId - (required)
        accessCodeDetails - The new access code. (required)
        emailId - (optional)
        zorder - (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        204 No Content -
        401 Unauthorized -
        403 Forbidden -

      • changeRecipientCall

        public okhttp3.Call changeRecipientCall​(String documentId,
                                        ChangeRecipient changeRecipient,
                                        ApiCallback _callback)
                                 throws ApiException
        Build call for changeRecipient
        Parameters:
        documentId - The documentID details. (required)
        changeRecipient - The new recipient details. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        204 No Content -
        401 Unauthorized -
        403 Forbidden -

      • changeRecipient

        public void changeRecipient​(String documentId,
                            ChangeRecipient changeRecipient)
                     throws ApiException
        Change recipient details of a document.
        Parameters:
        documentId - The documentID details. (required)
        changeRecipient - The new recipient details. (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        204 No Content -
        401 Unauthorized -
        403 Forbidden -

      • changeRecipientWithHttpInfo

        public ApiResponse<Void> changeRecipientWithHttpInfo​(String documentId,
                                                     ChangeRecipient changeRecipient)
                                              throws ApiException
        Change recipient details of a document.
        Parameters:
        documentId - The documentID details. (required)
        changeRecipient - The new recipient details. (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        204 No Content -
        401 Unauthorized -
        403 Forbidden -

      • changeRecipientAsync

        public okhttp3.Call changeRecipientAsync​(String documentId,
                                         ChangeRecipient changeRecipient,
                                         ApiCallback<Void> _callback)
                                  throws ApiException
        Change recipient details of a document. (asynchronously)
        Parameters:
        documentId - The documentID details. (required)
        changeRecipient - The new recipient details. (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        204 No Content -
        401 Unauthorized -
        403 Forbidden -

      • createEmbeddedRequestUrlDocumentCall

        public okhttp3.Call createEmbeddedRequestUrlDocumentCall​(EmbeddedDocumentRequest embeddedDocumentRequest,
                                                         ApiCallback _callback)
                                                  throws ApiException
        Build call for createEmbeddedRequestUrlDocument
        Parameters:
        embeddedDocumentRequest - The embedded send document request body. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        201 Created -
        401 Unauthorized -
        403 Forbidden -
        400 Bad Request -
        422 Unprocessable Content -

      • createEmbeddedRequestUrlDocument

        public EmbeddedSendCreated createEmbeddedRequestUrlDocument​(EmbeddedDocumentRequest embeddedDocumentRequest)
                                                     throws ApiException
        Generates a send URL which embeds document sending process into your application.
        Parameters:
        embeddedDocumentRequest - The embedded send document request body. (optional)
        Returns:
        EmbeddedSendCreated
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        201 Created -
        401 Unauthorized -
        403 Forbidden -
        400 Bad Request -
        422 Unprocessable Content -

      • createEmbeddedRequestUrlDocumentWithHttpInfo

        public ApiResponse<EmbeddedSendCreated> createEmbeddedRequestUrlDocumentWithHttpInfo​(EmbeddedDocumentRequest embeddedDocumentRequest)
                                                                              throws ApiException
        Generates a send URL which embeds document sending process into your application.
        Parameters:
        embeddedDocumentRequest - The embedded send document request body. (optional)
        Returns:
        ApiResponse<EmbeddedSendCreated>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        201 Created -
        401 Unauthorized -
        403 Forbidden -
        400 Bad Request -
        422 Unprocessable Content -

      • createEmbeddedRequestUrlDocumentAsync

        public okhttp3.Call createEmbeddedRequestUrlDocumentAsync​(EmbeddedDocumentRequest embeddedDocumentRequest,
                                                          ApiCallback<EmbeddedSendCreated> _callback)
                                                   throws ApiException
        Generates a send URL which embeds document sending process into your application. (asynchronously)
        Parameters:
        embeddedDocumentRequest - The embedded send document request body. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        201 Created -
        401 Unauthorized -
        403 Forbidden -
        400 Bad Request -
        422 Unprocessable Content -

      • deleteDocumentCall

        public okhttp3.Call deleteDocumentCall​(String documentId,
                                       Boolean deletePermanently,
                                       ApiCallback _callback)
                                throws ApiException
        Build call for deleteDocument
        Parameters:
        documentId - Document Id. (required)
        deletePermanently - Delete Permanently. (optional, default to false)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        204 No Content -
        401 Unauthorized -
        403 Forbidden -

      • deleteDocument

        public void deleteDocument​(String documentId,
                           Boolean deletePermanently)
                    throws ApiException
        Delete the document.
        Parameters:
        documentId - Document Id. (required)
        deletePermanently - Delete Permanently. (optional, default to false)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        204 No Content -
        401 Unauthorized -
        403 Forbidden -

      • deleteDocumentWithHttpInfo

        public ApiResponse<Void> deleteDocumentWithHttpInfo​(String documentId,
                                                    Boolean deletePermanently)
                                             throws ApiException
        Delete the document.
        Parameters:
        documentId - Document Id. (required)
        deletePermanently - Delete Permanently. (optional, default to false)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        204 No Content -
        401 Unauthorized -
        403 Forbidden -

      • deleteDocumentAsync

        public okhttp3.Call deleteDocumentAsync​(String documentId,
                                        Boolean deletePermanently,
                                        ApiCallback<Void> _callback)
                                 throws ApiException
        Delete the document. (asynchronously)
        Parameters:
        documentId - Document Id. (required)
        deletePermanently - Delete Permanently. (optional, default to false)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        204 No Content -
        401 Unauthorized -
        403 Forbidden -

      • deleteTagCall

        public okhttp3.Call deleteTagCall​(DocumentTags documentTags,
                                  ApiCallback _callback)
                           throws ApiException
        Build call for deleteTag
        Parameters:
        documentTags - Contains DocumentId and LabelNames for Adding Tags. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        400 Bad Request -

      • deleteTag

        public void deleteTag​(DocumentTags documentTags)
               throws ApiException
        Delete the Tags in Documents.
        Parameters:
        documentTags - Contains DocumentId and LabelNames for Adding Tags. (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        400 Bad Request -

      • deleteTagWithHttpInfo

        public ApiResponse<Void> deleteTagWithHttpInfo​(DocumentTags documentTags)
                                        throws ApiException
        Delete the Tags in Documents.
        Parameters:
        documentTags - Contains DocumentId and LabelNames for Adding Tags. (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        400 Bad Request -

      • deleteTagAsync

        public okhttp3.Call deleteTagAsync​(DocumentTags documentTags,
                                   ApiCallback<Void> _callback)
                            throws ApiException
        Delete the Tags in Documents. (asynchronously)
        Parameters:
        documentTags - Contains DocumentId and LabelNames for Adding Tags. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        400 Bad Request -

      • downloadAttachmentCall

        public okhttp3.Call downloadAttachmentCall​(String documentId,
                                           String attachmentId,
                                           String onBehalfOf,
                                           ApiCallback _callback)
                                    throws ApiException
        Build call for downloadAttachment
        Parameters:
        documentId - Document Id. (required)
        attachmentId - Attachment Id(Get attachment ID from Properties API). (required)
        onBehalfOf - The on behalfof email address. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • downloadAttachment

        public File downloadAttachment​(String documentId,
                               String attachmentId,
                               String onBehalfOf)
                        throws ApiException
        Download the Attachment.
        Parameters:
        documentId - Document Id. (required)
        attachmentId - Attachment Id(Get attachment ID from Properties API). (required)
        onBehalfOf - The on behalfof email address. (optional)
        Returns:
        File
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • downloadAttachmentWithHttpInfo

        public ApiResponse<File> downloadAttachmentWithHttpInfo​(String documentId,
                                                        String attachmentId,
                                                        String onBehalfOf)
                                                 throws ApiException
        Download the Attachment.
        Parameters:
        documentId - Document Id. (required)
        attachmentId - Attachment Id(Get attachment ID from Properties API). (required)
        onBehalfOf - The on behalfof email address. (optional)
        Returns:
        ApiResponse<File>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • downloadAttachmentAsync

        public okhttp3.Call downloadAttachmentAsync​(String documentId,
                                            String attachmentId,
                                            String onBehalfOf,
                                            ApiCallback<File> _callback)
                                     throws ApiException
        Download the Attachment. (asynchronously)
        Parameters:
        documentId - Document Id. (required)
        attachmentId - Attachment Id(Get attachment ID from Properties API). (required)
        onBehalfOf - The on behalfof email address. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • downloadAuditLogCall

        public okhttp3.Call downloadAuditLogCall​(String documentId,
                                         String onBehalfOf,
                                         ApiCallback _callback)
                                  throws ApiException
        Build call for downloadAuditLog
        Parameters:
        documentId - Document Id. (required)
        onBehalfOf - The on behalfof email address. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • downloadAuditLog

        public File downloadAuditLog​(String documentId,
                             String onBehalfOf)
                      throws ApiException
        Download the audit trail document.
        Parameters:
        documentId - Document Id. (required)
        onBehalfOf - The on behalfof email address. (optional)
        Returns:
        File
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • downloadAuditLogWithHttpInfo

        public ApiResponse<File> downloadAuditLogWithHttpInfo​(String documentId,
                                                      String onBehalfOf)
                                               throws ApiException
        Download the audit trail document.
        Parameters:
        documentId - Document Id. (required)
        onBehalfOf - The on behalfof email address. (optional)
        Returns:
        ApiResponse<File>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • downloadAuditLogAsync

        public okhttp3.Call downloadAuditLogAsync​(String documentId,
                                          String onBehalfOf,
                                          ApiCallback<File> _callback)
                                   throws ApiException
        Download the audit trail document. (asynchronously)
        Parameters:
        documentId - Document Id. (required)
        onBehalfOf - The on behalfof email address. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • downloadDocumentCall

        public okhttp3.Call downloadDocumentCall​(String documentId,
                                         String onBehalfOf,
                                         ApiCallback _callback)
                                  throws ApiException
        Build call for downloadDocument
        Parameters:
        documentId - Document Id. (required)
        onBehalfOf - The on behalfof email address. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • downloadDocument

        public File downloadDocument​(String documentId,
                             String onBehalfOf)
                      throws ApiException
        Download the document.
        Parameters:
        documentId - Document Id. (required)
        onBehalfOf - The on behalfof email address. (optional)
        Returns:
        File
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • downloadDocumentWithHttpInfo

        public ApiResponse<File> downloadDocumentWithHttpInfo​(String documentId,
                                                      String onBehalfOf)
                                               throws ApiException
        Download the document.
        Parameters:
        documentId - Document Id. (required)
        onBehalfOf - The on behalfof email address. (optional)
        Returns:
        ApiResponse<File>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • downloadDocumentAsync

        public okhttp3.Call downloadDocumentAsync​(String documentId,
                                          String onBehalfOf,
                                          ApiCallback<File> _callback)
                                   throws ApiException
        Download the document. (asynchronously)
        Parameters:
        documentId - Document Id. (required)
        onBehalfOf - The on behalfof email address. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • draftSendCall

        public okhttp3.Call draftSendCall​(String documentId,
                                  ApiCallback _callback)
                           throws ApiException
        Build call for draftSend
        Parameters:
        documentId - The ID of the document to be sent. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        201 Created -
        401 Unauthorized -
        403 Forbidden -

      • draftSend

        public void draftSend​(String documentId)
               throws ApiException
        Sends a draft-status document out for signature.
        Parameters:
        documentId - The ID of the document to be sent. (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        201 Created -
        401 Unauthorized -
        403 Forbidden -

      • draftSendWithHttpInfo

        public ApiResponse<Void> draftSendWithHttpInfo​(String documentId)
                                        throws ApiException
        Sends a draft-status document out for signature.
        Parameters:
        documentId - The ID of the document to be sent. (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        201 Created -
        401 Unauthorized -
        403 Forbidden -

      • draftSendAsync

        public okhttp3.Call draftSendAsync​(String documentId,
                                   ApiCallback<Void> _callback)
                            throws ApiException
        Sends a draft-status document out for signature. (asynchronously)
        Parameters:
        documentId - The ID of the document to be sent. (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        201 Created -
        401 Unauthorized -
        403 Forbidden -

      • editDocumentCall

        public okhttp3.Call editDocumentCall​(String documentId,
                                     EditDocumentRequest editDocumentRequest,
                                     ApiCallback _callback)
                              throws ApiException
        Build call for editDocument
        Parameters:
        documentId - Document Id. (required)
        editDocumentRequest - Edit document JSON request. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -
        400 Bad Request -
        422 Unprocessable Content -

      • editDocument

        public DocumentEdited editDocument​(String documentId,
                                   EditDocumentRequest editDocumentRequest)
                            throws ApiException
        Edit and updates an existing document.
        Parameters:
        documentId - Document Id. (required)
        editDocumentRequest - Edit document JSON request. (optional)
        Returns:
        DocumentEdited
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -
        400 Bad Request -
        422 Unprocessable Content -

      • editDocumentWithHttpInfo

        public ApiResponse<DocumentEdited> editDocumentWithHttpInfo​(String documentId,
                                                            EditDocumentRequest editDocumentRequest)
                                                     throws ApiException
        Edit and updates an existing document.
        Parameters:
        documentId - Document Id. (required)
        editDocumentRequest - Edit document JSON request. (optional)
        Returns:
        ApiResponse<DocumentEdited>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -
        400 Bad Request -
        422 Unprocessable Content -

      • editDocumentAsync

        public okhttp3.Call editDocumentAsync​(String documentId,
                                      EditDocumentRequest editDocumentRequest,
                                      ApiCallback<DocumentEdited> _callback)
                               throws ApiException
        Edit and updates an existing document. (asynchronously)
        Parameters:
        documentId - Document Id. (required)
        editDocumentRequest - Edit document JSON request. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -
        400 Bad Request -
        422 Unprocessable Content -

      • extendExpiryCall

        public okhttp3.Call extendExpiryCall​(String documentId,
                                     ExtendExpiry extendExpiry,
                                     ApiCallback _callback)
                              throws ApiException
        Build call for extendExpiry
        Parameters:
        documentId - Document Id. (required)
        extendExpiry - The new expiry value should be specified in yyyy-MM-dd format for days type, ISO date time format for specific date time and integer for hours type. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • extendExpiry

        public void extendExpiry​(String documentId,
                         ExtendExpiry extendExpiry)
                  throws ApiException
        Extends the expiration date of the document.
        Parameters:
        documentId - Document Id. (required)
        extendExpiry - The new expiry value should be specified in yyyy-MM-dd format for days type, ISO date time format for specific date time and integer for hours type. (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • extendExpiryWithHttpInfo

        public ApiResponse<Void> extendExpiryWithHttpInfo​(String documentId,
                                                  ExtendExpiry extendExpiry)
                                           throws ApiException
        Extends the expiration date of the document.
        Parameters:
        documentId - Document Id. (required)
        extendExpiry - The new expiry value should be specified in yyyy-MM-dd format for days type, ISO date time format for specific date time and integer for hours type. (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • extendExpiryAsync

        public okhttp3.Call extendExpiryAsync​(String documentId,
                                      ExtendExpiry extendExpiry,
                                      ApiCallback<Void> _callback)
                               throws ApiException
        Extends the expiration date of the document. (asynchronously)
        Parameters:
        documentId - Document Id. (required)
        extendExpiry - The new expiry value should be specified in yyyy-MM-dd format for days type, ISO date time format for specific date time and integer for hours type. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • getPropertiesCall

        public okhttp3.Call getPropertiesCall​(String documentId,
                                      ApiCallback _callback)
                               throws ApiException
        Build call for getProperties
        Parameters:
        documentId - Document Id. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • getProperties

        public DocumentProperties getProperties​(String documentId)
                                 throws ApiException
        Get summary of the document.
        Parameters:
        documentId - Document Id. (required)
        Returns:
        DocumentProperties
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • getPropertiesWithHttpInfo

        public ApiResponse<DocumentProperties> getPropertiesWithHttpInfo​(String documentId)
                                                          throws ApiException
        Get summary of the document.
        Parameters:
        documentId - Document Id. (required)
        Returns:
        ApiResponse<DocumentProperties>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • getPropertiesAsync

        public okhttp3.Call getPropertiesAsync​(String documentId,
                                       ApiCallback<DocumentProperties> _callback)
                                throws ApiException
        Get summary of the document. (asynchronously)
        Parameters:
        documentId - Document Id. (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • getEmbeddedSignLinkCall

        public okhttp3.Call getEmbeddedSignLinkCall​(String documentId,
                                            String signerEmail,
                                            String countryCode,
                                            String phoneNumber,
                                            OffsetDateTime signLinkValidTill,
                                            URI redirectUrl,
                                            ApiCallback _callback)
                                     throws ApiException
        Build call for getEmbeddedSignLink
        Parameters:
        documentId - (required)
        signerEmail - (optional)
        countryCode - (optional)
        phoneNumber - (optional)
        signLinkValidTill - (optional)
        redirectUrl - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • getEmbeddedSignLink

        public EmbeddedSigningLink getEmbeddedSignLink​(String documentId,
                                               String signerEmail,
                                               String countryCode,
                                               String phoneNumber,
                                               OffsetDateTime signLinkValidTill,
                                               URI redirectUrl)
                                        throws ApiException
        Get sign link for Embedded Sign.
        Parameters:
        documentId - (required)
        signerEmail - (optional)
        countryCode - (optional)
        phoneNumber - (optional)
        signLinkValidTill - (optional)
        redirectUrl - (optional)
        Returns:
        EmbeddedSigningLink
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • getEmbeddedSignLinkWithHttpInfo

        public ApiResponse<EmbeddedSigningLink> getEmbeddedSignLinkWithHttpInfo​(String documentId,
                                                                        String signerEmail,
                                                                        String countryCode,
                                                                        String phoneNumber,
                                                                        OffsetDateTime signLinkValidTill,
                                                                        URI redirectUrl)
                                                                 throws ApiException
        Get sign link for Embedded Sign.
        Parameters:
        documentId - (required)
        signerEmail - (optional)
        countryCode - (optional)
        phoneNumber - (optional)
        signLinkValidTill - (optional)
        redirectUrl - (optional)
        Returns:
        ApiResponse<EmbeddedSigningLink>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • getEmbeddedSignLinkAsync

        public okhttp3.Call getEmbeddedSignLinkAsync​(String documentId,
                                             String signerEmail,
                                             String countryCode,
                                             String phoneNumber,
                                             OffsetDateTime signLinkValidTill,
                                             URI redirectUrl,
                                             ApiCallback<EmbeddedSigningLink> _callback)
                                      throws ApiException
        Get sign link for Embedded Sign. (asynchronously)
        Parameters:
        documentId - (required)
        signerEmail - (optional)
        countryCode - (optional)
        phoneNumber - (optional)
        signLinkValidTill - (optional)
        redirectUrl - (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • listDocumentsCall

        public okhttp3.Call listDocumentsCall​(Integer page,
                                      List<String> sentBy,
                                      List<String> recipients,
                                      String transmitType,
                                      String dateFilterType,
                                      Integer pageSize,
                                      OffsetDateTime startDate,
                                      List<String> status,
                                      OffsetDateTime endDate,
                                      String searchKey,
                                      List<String> labels,
                                      Long nextCursor,
                                      List<String> brandIds,
                                      ApiCallback _callback)
                               throws ApiException
        Build call for listDocuments
        Parameters:
        page - Page index specified in get document list request. (required)
        sentBy - (optional)
        recipients - (optional)
        transmitType - (optional)
        dateFilterType - Date Filter as SentBetween and ExpiresOn. (optional)
        pageSize - Page size specified in get document list request. (optional, default to 10)
        startDate - Start date of the document (optional)
        status - Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft. (optional)
        endDate - End date of the document (optional)
        searchKey - Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc., (optional)
        labels - Labels of the document. (optional)
        nextCursor - Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records. (optional)
        brandIds - BrandId(s) of the document. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -

      • listDocuments

        public DocumentRecords listDocuments​(Integer page,
                                     List<String> sentBy,
                                     List<String> recipients,
                                     String transmitType,
                                     String dateFilterType,
                                     Integer pageSize,
                                     OffsetDateTime startDate,
                                     List<String> status,
                                     OffsetDateTime endDate,
                                     String searchKey,
                                     List<String> labels,
                                     Long nextCursor,
                                     List<String> brandIds)
                              throws ApiException
        List user documents.
        Parameters:
        page - Page index specified in get document list request. (required)
        sentBy - (optional)
        recipients - (optional)
        transmitType - (optional)
        dateFilterType - Date Filter as SentBetween and ExpiresOn. (optional)
        pageSize - Page size specified in get document list request. (optional, default to 10)
        startDate - Start date of the document (optional)
        status - Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft. (optional)
        endDate - End date of the document (optional)
        searchKey - Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc., (optional)
        labels - Labels of the document. (optional)
        nextCursor - Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records. (optional)
        brandIds - BrandId(s) of the document. (optional)
        Returns:
        DocumentRecords
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -

      • listDocumentsWithHttpInfo

        public ApiResponse<DocumentRecords> listDocumentsWithHttpInfo​(Integer page,
                                                              List<String> sentBy,
                                                              List<String> recipients,
                                                              String transmitType,
                                                              String dateFilterType,
                                                              Integer pageSize,
                                                              OffsetDateTime startDate,
                                                              List<String> status,
                                                              OffsetDateTime endDate,
                                                              String searchKey,
                                                              List<String> labels,
                                                              Long nextCursor,
                                                              List<String> brandIds)
                                                       throws ApiException
        List user documents.
        Parameters:
        page - Page index specified in get document list request. (required)
        sentBy - (optional)
        recipients - (optional)
        transmitType - (optional)
        dateFilterType - Date Filter as SentBetween and ExpiresOn. (optional)
        pageSize - Page size specified in get document list request. (optional, default to 10)
        startDate - Start date of the document (optional)
        status - Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft. (optional)
        endDate - End date of the document (optional)
        searchKey - Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc., (optional)
        labels - Labels of the document. (optional)
        nextCursor - Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records. (optional)
        brandIds - BrandId(s) of the document. (optional)
        Returns:
        ApiResponse<DocumentRecords>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -

      • listDocumentsAsync

        public okhttp3.Call listDocumentsAsync​(Integer page,
                                       List<String> sentBy,
                                       List<String> recipients,
                                       String transmitType,
                                       String dateFilterType,
                                       Integer pageSize,
                                       OffsetDateTime startDate,
                                       List<String> status,
                                       OffsetDateTime endDate,
                                       String searchKey,
                                       List<String> labels,
                                       Long nextCursor,
                                       List<String> brandIds,
                                       ApiCallback<DocumentRecords> _callback)
                                throws ApiException
        List user documents. (asynchronously)
        Parameters:
        page - Page index specified in get document list request. (required)
        sentBy - (optional)
        recipients - (optional)
        transmitType - (optional)
        dateFilterType - Date Filter as SentBetween and ExpiresOn. (optional)
        pageSize - Page size specified in get document list request. (optional, default to 10)
        startDate - Start date of the document (optional)
        status - Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft. (optional)
        endDate - End date of the document (optional)
        searchKey - Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc., (optional)
        labels - Labels of the document. (optional)
        nextCursor - Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records. (optional)
        brandIds - BrandId(s) of the document. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -

      • prefillFieldsCall

        public okhttp3.Call prefillFieldsCall​(String documentId,
                                      PrefillFieldRequest prefillFieldRequest,
                                      ApiCallback _callback)
                               throws ApiException
        Build call for prefillFields
        Parameters:
        documentId - The DocumentId. (required)
        prefillFieldRequest - The prefill field request. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • prefillFields

        public void prefillFields​(String documentId,
                          PrefillFieldRequest prefillFieldRequest)
                   throws ApiException
        Updates the value (prefill) of the fields in the document.
        Parameters:
        documentId - The DocumentId. (required)
        prefillFieldRequest - The prefill field request. (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • prefillFieldsWithHttpInfo

        public ApiResponse<Void> prefillFieldsWithHttpInfo​(String documentId,
                                                   PrefillFieldRequest prefillFieldRequest)
                                            throws ApiException
        Updates the value (prefill) of the fields in the document.
        Parameters:
        documentId - The DocumentId. (required)
        prefillFieldRequest - The prefill field request. (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • prefillFieldsAsync

        public okhttp3.Call prefillFieldsAsync​(String documentId,
                                       PrefillFieldRequest prefillFieldRequest,
                                       ApiCallback<Void> _callback)
                                throws ApiException
        Updates the value (prefill) of the fields in the document. (asynchronously)
        Parameters:
        documentId - The DocumentId. (required)
        prefillFieldRequest - The prefill field request. (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • remindDocumentCall

        public okhttp3.Call remindDocumentCall​(String documentId,
                                       List<String> receiverEmails,
                                       ReminderMessage reminderMessage,
                                       ApiCallback _callback)
                                throws ApiException
        Build call for remindDocument
        Parameters:
        documentId - Document Id. (required)
        receiverEmails - Signer emails. (optional)
        reminderMessage - Reminder Message for signers. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        204 No Content -
        401 Unauthorized -
        403 Forbidden -

      • remindDocument

        public void remindDocument​(String documentId,
                           List<String> receiverEmails,
                           ReminderMessage reminderMessage)
                    throws ApiException
        Send reminder to pending signers.
        Parameters:
        documentId - Document Id. (required)
        receiverEmails - Signer emails. (optional)
        reminderMessage - Reminder Message for signers. (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        204 No Content -
        401 Unauthorized -
        403 Forbidden -

      • remindDocumentWithHttpInfo

        public ApiResponse<Void> remindDocumentWithHttpInfo​(String documentId,
                                                    List<String> receiverEmails,
                                                    ReminderMessage reminderMessage)
                                             throws ApiException
        Send reminder to pending signers.
        Parameters:
        documentId - Document Id. (required)
        receiverEmails - Signer emails. (optional)
        reminderMessage - Reminder Message for signers. (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        204 No Content -
        401 Unauthorized -
        403 Forbidden -

      • remindDocumentAsync

        public okhttp3.Call remindDocumentAsync​(String documentId,
                                        List<String> receiverEmails,
                                        ReminderMessage reminderMessage,
                                        ApiCallback<Void> _callback)
                                 throws ApiException
        Send reminder to pending signers. (asynchronously)
        Parameters:
        documentId - Document Id. (required)
        receiverEmails - Signer emails. (optional)
        reminderMessage - Reminder Message for signers. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        204 No Content -
        401 Unauthorized -
        403 Forbidden -

      • removeAuthenticationCall

        public okhttp3.Call removeAuthenticationCall​(String documentId,
                                             RemoveAuthentication removeAuthentication,
                                             ApiCallback _callback)
                                      throws ApiException
        Build call for removeAuthentication
        Parameters:
        documentId - Document ID of the signature request (required)
        removeAuthentication - To remove access code. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        204 No Content -
        401 Unauthorized -
        403 Forbidden -

      • removeAuthentication

        public void removeAuthentication​(String documentId,
                                 RemoveAuthentication removeAuthentication)
                          throws ApiException
        Remove the access code for the given document signer.
        Parameters:
        documentId - Document ID of the signature request (required)
        removeAuthentication - To remove access code. (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        204 No Content -
        401 Unauthorized -
        403 Forbidden -

      • removeAuthenticationWithHttpInfo

        public ApiResponse<Void> removeAuthenticationWithHttpInfo​(String documentId,
                                                          RemoveAuthentication removeAuthentication)
                                                   throws ApiException
        Remove the access code for the given document signer.
        Parameters:
        documentId - Document ID of the signature request (required)
        removeAuthentication - To remove access code. (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        204 No Content -
        401 Unauthorized -
        403 Forbidden -

      • removeAuthenticationAsync

        public okhttp3.Call removeAuthenticationAsync​(String documentId,
                                              RemoveAuthentication removeAuthentication,
                                              ApiCallback<Void> _callback)
                                       throws ApiException
        Remove the access code for the given document signer. (asynchronously)
        Parameters:
        documentId - Document ID of the signature request (required)
        removeAuthentication - To remove access code. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        204 No Content -
        401 Unauthorized -
        403 Forbidden -

      • revokeDocumentCall

        public okhttp3.Call revokeDocumentCall​(String documentId,
                                       RevokeDocument revokeDocument,
                                       ApiCallback _callback)
                                throws ApiException
        Build call for revokeDocument
        Parameters:
        documentId - Document Id. (required)
        revokeDocument - RevokeDetails. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        204 No Content -
        401 Unauthorized -
        403 Forbidden -

      • revokeDocument

        public void revokeDocument​(String documentId,
                           RevokeDocument revokeDocument)
                    throws ApiException
        Revoke the document.
        Parameters:
        documentId - Document Id. (required)
        revokeDocument - RevokeDetails. (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        204 No Content -
        401 Unauthorized -
        403 Forbidden -

      • revokeDocumentWithHttpInfo

        public ApiResponse<Void> revokeDocumentWithHttpInfo​(String documentId,
                                                    RevokeDocument revokeDocument)
                                             throws ApiException
        Revoke the document.
        Parameters:
        documentId - Document Id. (required)
        revokeDocument - RevokeDetails. (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        204 No Content -
        401 Unauthorized -
        403 Forbidden -

      • revokeDocumentAsync

        public okhttp3.Call revokeDocumentAsync​(String documentId,
                                        RevokeDocument revokeDocument,
                                        ApiCallback<Void> _callback)
                                 throws ApiException
        Revoke the document. (asynchronously)
        Parameters:
        documentId - Document Id. (required)
        revokeDocument - RevokeDetails. (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        204 No Content -
        401 Unauthorized -
        403 Forbidden -

      • sendDocumentCall

        public okhttp3.Call sendDocumentCall​(SendForSign sendForSign,
                                     ApiCallback _callback)
                              throws ApiException
        Build call for sendDocument
        Parameters:
        sendForSign - The send for sign request body. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        201 Created -
        401 Unauthorized -
        403 Forbidden -
        400 Bad Request -
        422 Unprocessable Content -

      • sendDocument

        public DocumentCreated sendDocument​(SendForSign sendForSign)
                             throws ApiException
        Sends the document for sign.
        Parameters:
        sendForSign - The send for sign request body. (optional)
        Returns:
        DocumentCreated
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        201 Created -
        401 Unauthorized -
        403 Forbidden -
        400 Bad Request -
        422 Unprocessable Content -

      • sendDocumentWithHttpInfo

        public ApiResponse<DocumentCreated> sendDocumentWithHttpInfo​(SendForSign sendForSign)
                                                      throws ApiException
        Sends the document for sign.
        Parameters:
        sendForSign - The send for sign request body. (optional)
        Returns:
        ApiResponse<DocumentCreated>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        201 Created -
        401 Unauthorized -
        403 Forbidden -
        400 Bad Request -
        422 Unprocessable Content -

      • sendDocumentAsync

        public okhttp3.Call sendDocumentAsync​(SendForSign sendForSign,
                                      ApiCallback<DocumentCreated> _callback)
                               throws ApiException
        Sends the document for sign. (asynchronously)
        Parameters:
        sendForSign - The send for sign request body. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        201 Created -
        401 Unauthorized -
        403 Forbidden -
        400 Bad Request -
        422 Unprocessable Content -

      • teamDocumentsCall

        public okhttp3.Call teamDocumentsCall​(Integer page,
                                      List<String> userId,
                                      List<String> teamId,
                                      String transmitType,
                                      String dateFilterType,
                                      Integer pageSize,
                                      OffsetDateTime startDate,
                                      List<String> status,
                                      OffsetDateTime endDate,
                                      String searchKey,
                                      List<String> labels,
                                      Long nextCursor,
                                      List<String> brandIds,
                                      ApiCallback _callback)
                               throws ApiException
        Build call for teamDocuments
        Parameters:
        page - Page index specified in get document list request. (required)
        userId - UserId of the Team document. (optional)
        teamId - TeamId of the Team document. (optional)
        transmitType - Transmit type as Sent, Received and Both. (optional)
        dateFilterType - Date Filter as SentBetween and Expiring. (optional)
        pageSize - Page size specified in get document list request. (optional, default to 10)
        startDate - Start date of the document (optional)
        status - Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft. (optional)
        endDate - End date of the document (optional)
        searchKey - Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc., (optional)
        labels - Labels of the document. (optional)
        nextCursor - Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records. (optional)
        brandIds - BrandId(s) of the document. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • teamDocuments

        public TeamDocumentRecords teamDocuments​(Integer page,
                                         List<String> userId,
                                         List<String> teamId,
                                         String transmitType,
                                         String dateFilterType,
                                         Integer pageSize,
                                         OffsetDateTime startDate,
                                         List<String> status,
                                         OffsetDateTime endDate,
                                         String searchKey,
                                         List<String> labels,
                                         Long nextCursor,
                                         List<String> brandIds)
                                  throws ApiException
        Get user Team documents.
        Parameters:
        page - Page index specified in get document list request. (required)
        userId - UserId of the Team document. (optional)
        teamId - TeamId of the Team document. (optional)
        transmitType - Transmit type as Sent, Received and Both. (optional)
        dateFilterType - Date Filter as SentBetween and Expiring. (optional)
        pageSize - Page size specified in get document list request. (optional, default to 10)
        startDate - Start date of the document (optional)
        status - Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft. (optional)
        endDate - End date of the document (optional)
        searchKey - Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc., (optional)
        labels - Labels of the document. (optional)
        nextCursor - Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records. (optional)
        brandIds - BrandId(s) of the document. (optional)
        Returns:
        TeamDocumentRecords
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • teamDocumentsWithHttpInfo

        public ApiResponse<TeamDocumentRecords> teamDocumentsWithHttpInfo​(Integer page,
                                                                  List<String> userId,
                                                                  List<String> teamId,
                                                                  String transmitType,
                                                                  String dateFilterType,
                                                                  Integer pageSize,
                                                                  OffsetDateTime startDate,
                                                                  List<String> status,
                                                                  OffsetDateTime endDate,
                                                                  String searchKey,
                                                                  List<String> labels,
                                                                  Long nextCursor,
                                                                  List<String> brandIds)
                                                           throws ApiException
        Get user Team documents.
        Parameters:
        page - Page index specified in get document list request. (required)
        userId - UserId of the Team document. (optional)
        teamId - TeamId of the Team document. (optional)
        transmitType - Transmit type as Sent, Received and Both. (optional)
        dateFilterType - Date Filter as SentBetween and Expiring. (optional)
        pageSize - Page size specified in get document list request. (optional, default to 10)
        startDate - Start date of the document (optional)
        status - Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft. (optional)
        endDate - End date of the document (optional)
        searchKey - Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc., (optional)
        labels - Labels of the document. (optional)
        nextCursor - Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records. (optional)
        brandIds - BrandId(s) of the document. (optional)
        Returns:
        ApiResponse<TeamDocumentRecords>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • teamDocumentsAsync

        public okhttp3.Call teamDocumentsAsync​(Integer page,
                                       List<String> userId,
                                       List<String> teamId,
                                       String transmitType,
                                       String dateFilterType,
                                       Integer pageSize,
                                       OffsetDateTime startDate,
                                       List<String> status,
                                       OffsetDateTime endDate,
                                       String searchKey,
                                       List<String> labels,
                                       Long nextCursor,
                                       List<String> brandIds,
                                       ApiCallback<TeamDocumentRecords> _callback)
                                throws ApiException
        Get user Team documents. (asynchronously)
        Parameters:
        page - Page index specified in get document list request. (required)
        userId - UserId of the Team document. (optional)
        teamId - TeamId of the Team document. (optional)
        transmitType - Transmit type as Sent, Received and Both. (optional)
        dateFilterType - Date Filter as SentBetween and Expiring. (optional)
        pageSize - Page size specified in get document list request. (optional, default to 10)
        startDate - Start date of the document (optional)
        status - Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft. (optional)
        endDate - End date of the document (optional)
        searchKey - Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc., (optional)
        labels - Labels of the document. (optional)
        nextCursor - Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records. (optional)
        brandIds - BrandId(s) of the document. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -