Package com.hellosign.openapi.api

Class SignatureRequestApi

  • @Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class SignatureRequestApi
extends java.lang.Object

    • Constructor Detail

      • SignatureRequestApi

        public SignatureRequestApi()

      • SignatureRequestApi

        public SignatureRequestApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()
        Get the API client
        Returns:
        API client

      • setApiClient

        public void setApiClient​(ApiClient apiClient)
        Set the API client
        Parameters:
        apiClient - an instance of API client

      • signatureRequestBulkCreateEmbeddedWithTemplate

        public BulkSendJobSendResponse signatureRequestBulkCreateEmbeddedWithTemplate​(SignatureRequestBulkCreateEmbeddedWithTemplateRequest signatureRequestBulkCreateEmbeddedWithTemplateRequest)
                                                                       throws ApiException
        Embedded Bulk Send with Template Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on HelloSign. **NOTE**: Only available for Standard plan and higher.
        Parameters:
        signatureRequestBulkCreateEmbeddedWithTemplateRequest - (required)
        Returns:
        BulkSendJobSendResponse
        Throws:
        ApiException - if fails to make API call
        Http Response Details
        Status Code Description Response Headers
        200 successful operation * X-RateLimit-Limit -
        * X-RateLimit-Remaining -
        * X-Ratelimit-Reset -
        4XX failed_operation -

      • signatureRequestBulkCreateEmbeddedWithTemplateWithHttpInfo

        public ApiResponse<BulkSendJobSendResponse> signatureRequestBulkCreateEmbeddedWithTemplateWithHttpInfo​(SignatureRequestBulkCreateEmbeddedWithTemplateRequest signatureRequestBulkCreateEmbeddedWithTemplateRequest)
                                                                                                throws ApiException
        Embedded Bulk Send with Template Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on HelloSign. **NOTE**: Only available for Standard plan and higher.
        Parameters:
        signatureRequestBulkCreateEmbeddedWithTemplateRequest - (required)
        Returns:
        ApiResponse<BulkSendJobSendResponse>
        Throws:
        ApiException - if fails to make API call
        Http Response Details
        Status Code Description Response Headers
        200 successful operation * X-RateLimit-Limit -
        * X-RateLimit-Remaining -
        * X-Ratelimit-Reset -
        4XX failed_operation -

      • signatureRequestBulkSendWithTemplate

        public BulkSendJobSendResponse signatureRequestBulkSendWithTemplate​(SignatureRequestBulkSendWithTemplateRequest signatureRequestBulkSendWithTemplateRequest)
                                                             throws ApiException
        Bulk Send with Template Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE**: Only available for Standard plan and higher.
        Parameters:
        signatureRequestBulkSendWithTemplateRequest - (required)
        Returns:
        BulkSendJobSendResponse
        Throws:
        ApiException - if fails to make API call
        Http Response Details
        Status Code Description Response Headers
        200 successful operation * X-RateLimit-Limit -
        * X-RateLimit-Remaining -
        * X-Ratelimit-Reset -
        4XX failed_operation -

      • signatureRequestBulkSendWithTemplateWithHttpInfo

        public ApiResponse<BulkSendJobSendResponse> signatureRequestBulkSendWithTemplateWithHttpInfo​(SignatureRequestBulkSendWithTemplateRequest signatureRequestBulkSendWithTemplateRequest)
                                                                                      throws ApiException
        Bulk Send with Template Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE**: Only available for Standard plan and higher.
        Parameters:
        signatureRequestBulkSendWithTemplateRequest - (required)
        Returns:
        ApiResponse<BulkSendJobSendResponse>
        Throws:
        ApiException - if fails to make API call
        Http Response Details
        Status Code Description Response Headers
        200 successful operation * X-RateLimit-Limit -
        * X-RateLimit-Remaining -
        * X-Ratelimit-Reset -
        4XX failed_operation -

      • signatureRequestCancel

        public void signatureRequestCancel​(java.lang.String signatureRequestId)
                            throws ApiException
        Cancel Incomplete Signature Request Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE**: To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
        Parameters:
        signatureRequestId - The id of the incomplete SignatureRequest to cancel. (required)
        Throws:
        ApiException - if fails to make API call
        Http Response Details
        Status Code Description Response Headers
        200 successful operation * X-RateLimit-Limit -
        * X-RateLimit-Remaining -
        * X-Ratelimit-Reset -
        4XX failed_operation -

      • signatureRequestCancelWithHttpInfo

        public ApiResponse<java.lang.Void> signatureRequestCancelWithHttpInfo​(java.lang.String signatureRequestId)
                                                               throws ApiException
        Cancel Incomplete Signature Request Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE**: To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
        Parameters:
        signatureRequestId - The id of the incomplete SignatureRequest to cancel. (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - if fails to make API call
        Http Response Details
        Status Code Description Response Headers
        200 successful operation * X-RateLimit-Limit -
        * X-RateLimit-Remaining -
        * X-Ratelimit-Reset -
        4XX failed_operation -

      • signatureRequestCreateEmbedded

        public SignatureRequestGetResponse signatureRequestCreateEmbedded​(SignatureRequestCreateEmbeddedRequest signatureRequestCreateEmbeddedRequest)
                                                           throws ApiException
        Create Embedded Signature Request Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on HelloSign.
        Parameters:
        signatureRequestCreateEmbeddedRequest - (required)
        Returns:
        SignatureRequestGetResponse
        Throws:
        ApiException - if fails to make API call
        Http Response Details
        Status Code Description Response Headers
        200 successful operation * X-RateLimit-Limit -
        * X-RateLimit-Remaining -
        * X-Ratelimit-Reset -
        4XX failed_operation -

      • signatureRequestCreateEmbeddedWithHttpInfo

        public ApiResponse<SignatureRequestGetResponse> signatureRequestCreateEmbeddedWithHttpInfo​(SignatureRequestCreateEmbeddedRequest signatureRequestCreateEmbeddedRequest)
                                                                                    throws ApiException
        Create Embedded Signature Request Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on HelloSign.
        Parameters:
        signatureRequestCreateEmbeddedRequest - (required)
        Returns:
        ApiResponse<SignatureRequestGetResponse>
        Throws:
        ApiException - if fails to make API call
        Http Response Details
        Status Code Description Response Headers
        200 successful operation * X-RateLimit-Limit -
        * X-RateLimit-Remaining -
        * X-Ratelimit-Reset -
        4XX failed_operation -

      • signatureRequestCreateEmbeddedWithTemplate

        public SignatureRequestGetResponse signatureRequestCreateEmbeddedWithTemplate​(SignatureRequestCreateEmbeddedWithTemplateRequest signatureRequestCreateEmbeddedWithTemplateRequest)
                                                                       throws ApiException
        Create Embedded Signature Request with Template Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on HelloSign.
        Parameters:
        signatureRequestCreateEmbeddedWithTemplateRequest - (required)
        Returns:
        SignatureRequestGetResponse
        Throws:
        ApiException - if fails to make API call
        Http Response Details
        Status Code Description Response Headers
        200 successful operation * X-RateLimit-Limit -
        * X-RateLimit-Remaining -
        * X-Ratelimit-Reset -
        4XX failed_operation -

      • signatureRequestCreateEmbeddedWithTemplateWithHttpInfo

        public ApiResponse<SignatureRequestGetResponse> signatureRequestCreateEmbeddedWithTemplateWithHttpInfo​(SignatureRequestCreateEmbeddedWithTemplateRequest signatureRequestCreateEmbeddedWithTemplateRequest)
                                                                                                throws ApiException
        Create Embedded Signature Request with Template Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on HelloSign.
        Parameters:
        signatureRequestCreateEmbeddedWithTemplateRequest - (required)
        Returns:
        ApiResponse<SignatureRequestGetResponse>
        Throws:
        ApiException - if fails to make API call
        Http Response Details
        Status Code Description Response Headers
        200 successful operation * X-RateLimit-Limit -
        * X-RateLimit-Remaining -
        * X-Ratelimit-Reset -
        4XX failed_operation -

      • signatureRequestFiles

        public FileResponse signatureRequestFiles​(java.lang.String signatureRequestId,
                                          java.lang.String fileType,
                                          java.lang.Boolean getUrl,
                                          java.lang.Boolean getDataUri)
                                   throws ApiException
        Download Files Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file, or if `get_url` is set, a JSON object with a url to the file (PDFs only). If `get_data_uri` is set, a JSON object with a `data_uri` representing the base64 encoded file (PDFs only) is returned. If the files are currently being prepared, a status code of `409` will be returned instead.
        Parameters:
        signatureRequestId - The id of the SignatureRequest to retrieve. (required)
        fileType - Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to pdf)
        getUrl - If `true`, the response will contain a url link to the file instead. Links are only available for PDFs and have a TTL of 3 days. (optional, default to false)
        getDataUri - If `true`, the response will contain the file as base64 encoded string. Base64 encoding is only available for PDFs. (optional, default to false)
        Returns:
        FileResponse
        Throws:
        ApiException - if fails to make API call
        Http Response Details
        Status Code Description Response Headers
        200 successful operation * X-RateLimit-Limit -
        * X-RateLimit-Remaining -
        * X-Ratelimit-Reset -
        4XX failed_operation -

      • signatureRequestFilesWithHttpInfo

        public ApiResponse<FileResponse> signatureRequestFilesWithHttpInfo​(java.lang.String signatureRequestId,
                                                                   java.lang.String fileType,
                                                                   java.lang.Boolean getUrl,
                                                                   java.lang.Boolean getDataUri)
                                                            throws ApiException
        Download Files Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file, or if `get_url` is set, a JSON object with a url to the file (PDFs only). If `get_data_uri` is set, a JSON object with a `data_uri` representing the base64 encoded file (PDFs only) is returned. If the files are currently being prepared, a status code of `409` will be returned instead.
        Parameters:
        signatureRequestId - The id of the SignatureRequest to retrieve. (required)
        fileType - Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to pdf)
        getUrl - If `true`, the response will contain a url link to the file instead. Links are only available for PDFs and have a TTL of 3 days. (optional, default to false)
        getDataUri - If `true`, the response will contain the file as base64 encoded string. Base64 encoding is only available for PDFs. (optional, default to false)
        Returns:
        ApiResponse<FileResponse>
        Throws:
        ApiException - if fails to make API call
        Http Response Details
        Status Code Description Response Headers
        200 successful operation * X-RateLimit-Limit -
        * X-RateLimit-Remaining -
        * X-Ratelimit-Reset -
        4XX failed_operation -

      • signatureRequestGet

        public SignatureRequestGetResponse signatureRequestGet​(java.lang.String signatureRequestId)
                                                throws ApiException
        Get Signature Request Returns the status of the SignatureRequest specified by the `signature_request_id` parameter.
        Parameters:
        signatureRequestId - The id of the SignatureRequest to retrieve. (required)
        Returns:
        SignatureRequestGetResponse
        Throws:
        ApiException - if fails to make API call
        Http Response Details
        Status Code Description Response Headers
        200 successful operation * X-RateLimit-Limit -
        * X-RateLimit-Remaining -
        * X-Ratelimit-Reset -
        4XX failed_operation -

      • signatureRequestGetWithHttpInfo

        public ApiResponse<SignatureRequestGetResponse> signatureRequestGetWithHttpInfo​(java.lang.String signatureRequestId)
                                                                         throws ApiException
        Get Signature Request Returns the status of the SignatureRequest specified by the `signature_request_id` parameter.
        Parameters:
        signatureRequestId - The id of the SignatureRequest to retrieve. (required)
        Returns:
        ApiResponse<SignatureRequestGetResponse>
        Throws:
        ApiException - if fails to make API call
        Http Response Details
        Status Code Description Response Headers
        200 successful operation * X-RateLimit-Limit -
        * X-RateLimit-Remaining -
        * X-Ratelimit-Reset -
        4XX failed_operation -

      • signatureRequestList

        public SignatureRequestListResponse signatureRequestList​(java.lang.String accountId,
                                                         java.lang.Integer page,
                                                         java.lang.Integer pageSize,
                                                         java.lang.String query)
                                                  throws ApiException
        List Signature Requests Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests.
        Parameters:
        accountId - Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional)
        page - Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1)
        pageSize - Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20)
        query - String that includes search terms and/or fields to be used to filter the SignatureRequest objects. (optional)
        Returns:
        SignatureRequestListResponse
        Throws:
        ApiException - if fails to make API call
        Http Response Details
        Status Code Description Response Headers
        200 successful operation * X-RateLimit-Limit -
        * X-RateLimit-Remaining -
        * X-Ratelimit-Reset -
        4XX failed_operation -

      • signatureRequestListWithHttpInfo

        public ApiResponse<SignatureRequestListResponse> signatureRequestListWithHttpInfo​(java.lang.String accountId,
                                                                                  java.lang.Integer page,
                                                                                  java.lang.Integer pageSize,
                                                                                  java.lang.String query)
                                                                           throws ApiException
        List Signature Requests Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests.
        Parameters:
        accountId - Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional)
        page - Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1)
        pageSize - Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20)
        query - String that includes search terms and/or fields to be used to filter the SignatureRequest objects. (optional)
        Returns:
        ApiResponse<SignatureRequestListResponse>
        Throws:
        ApiException - if fails to make API call
        Http Response Details
        Status Code Description Response Headers
        200 successful operation * X-RateLimit-Limit -
        * X-RateLimit-Remaining -
        * X-Ratelimit-Reset -
        4XX failed_operation -

      • signatureRequestReleaseHold

        public SignatureRequestGetResponse signatureRequestReleaseHold​(java.lang.String signatureRequestId)
                                                        throws ApiException
        Release On-Hold Signature Request Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers.
        Parameters:
        signatureRequestId - The id of the SignatureRequest to release. (required)
        Returns:
        SignatureRequestGetResponse
        Throws:
        ApiException - if fails to make API call
        Http Response Details
        Status Code Description Response Headers
        200 successful operation * X-RateLimit-Limit -
        * X-RateLimit-Remaining -
        * X-Ratelimit-Reset -
        4XX failed_operation -

      • signatureRequestReleaseHoldWithHttpInfo

        public ApiResponse<SignatureRequestGetResponse> signatureRequestReleaseHoldWithHttpInfo​(java.lang.String signatureRequestId)
                                                                                 throws ApiException
        Release On-Hold Signature Request Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers.
        Parameters:
        signatureRequestId - The id of the SignatureRequest to release. (required)
        Returns:
        ApiResponse<SignatureRequestGetResponse>
        Throws:
        ApiException - if fails to make API call
        Http Response Details
        Status Code Description Response Headers
        200 successful operation * X-RateLimit-Limit -
        * X-RateLimit-Remaining -
        * X-Ratelimit-Reset -
        4XX failed_operation -

      • signatureRequestRemind

        public SignatureRequestGetResponse signatureRequestRemind​(java.lang.String signatureRequestId,
                                                          SignatureRequestRemindRequest signatureRequestRemindRequest)
                                                   throws ApiException
        Send Request Reminder Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE**: This action can **not** be used with embedded signature requests.
        Parameters:
        signatureRequestId - The id of the SignatureRequest to send a reminder for. (required)
        signatureRequestRemindRequest - (required)
        Returns:
        SignatureRequestGetResponse
        Throws:
        ApiException - if fails to make API call
        Http Response Details
        Status Code Description Response Headers
        200 successful operation * X-RateLimit-Limit -
        * X-RateLimit-Remaining -
        * X-Ratelimit-Reset -
        4XX failed_operation -

      • signatureRequestRemindWithHttpInfo

        public ApiResponse<SignatureRequestGetResponse> signatureRequestRemindWithHttpInfo​(java.lang.String signatureRequestId,
                                                                                   SignatureRequestRemindRequest signatureRequestRemindRequest)
                                                                            throws ApiException
        Send Request Reminder Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE**: This action can **not** be used with embedded signature requests.
        Parameters:
        signatureRequestId - The id of the SignatureRequest to send a reminder for. (required)
        signatureRequestRemindRequest - (required)
        Returns:
        ApiResponse<SignatureRequestGetResponse>
        Throws:
        ApiException - if fails to make API call
        Http Response Details
        Status Code Description Response Headers
        200 successful operation * X-RateLimit-Limit -
        * X-RateLimit-Remaining -
        * X-Ratelimit-Reset -
        4XX failed_operation -

      • signatureRequestRemove

        public void signatureRequestRemove​(java.lang.String signatureRequestId)
                            throws ApiException
        Remove Signature Request Access Removes your access to a completed signature request. This action is **not reversible**. The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response.
        Parameters:
        signatureRequestId - The id of the SignatureRequest to remove. (required)
        Throws:
        ApiException - if fails to make API call
        Http Response Details
        Status Code Description Response Headers
        200 successful operation * X-RateLimit-Limit -
        * X-RateLimit-Remaining -
        * X-Ratelimit-Reset -
        4XX failed_operation -

      • signatureRequestRemoveWithHttpInfo

        public ApiResponse<java.lang.Void> signatureRequestRemoveWithHttpInfo​(java.lang.String signatureRequestId)
                                                               throws ApiException
        Remove Signature Request Access Removes your access to a completed signature request. This action is **not reversible**. The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response.
        Parameters:
        signatureRequestId - The id of the SignatureRequest to remove. (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - if fails to make API call
        Http Response Details
        Status Code Description Response Headers
        200 successful operation * X-RateLimit-Limit -
        * X-RateLimit-Remaining -
        * X-Ratelimit-Reset -
        4XX failed_operation -

      • signatureRequestSend

        public SignatureRequestGetResponse signatureRequestSend​(SignatureRequestSendRequest signatureRequestSendRequest)
                                                 throws ApiException
        Send Signature Request Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.
        Parameters:
        signatureRequestSendRequest - (required)
        Returns:
        SignatureRequestGetResponse
        Throws:
        ApiException - if fails to make API call
        Http Response Details
        Status Code Description Response Headers
        200 successful operation * X-RateLimit-Limit -
        * X-RateLimit-Remaining -
        * X-Ratelimit-Reset -
        4XX failed_operation -

      • signatureRequestSendWithHttpInfo

        public ApiResponse<SignatureRequestGetResponse> signatureRequestSendWithHttpInfo​(SignatureRequestSendRequest signatureRequestSendRequest)
                                                                          throws ApiException
        Send Signature Request Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.
        Parameters:
        signatureRequestSendRequest - (required)
        Returns:
        ApiResponse<SignatureRequestGetResponse>
        Throws:
        ApiException - if fails to make API call
        Http Response Details
        Status Code Description Response Headers
        200 successful operation * X-RateLimit-Limit -
        * X-RateLimit-Remaining -
        * X-Ratelimit-Reset -
        4XX failed_operation -

      • signatureRequestSendWithTemplate

        public SignatureRequestGetResponse signatureRequestSendWithTemplate​(SignatureRequestSendWithTemplateRequest signatureRequestSendWithTemplateRequest)
                                                             throws ApiException
        Send with Template Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter.
        Parameters:
        signatureRequestSendWithTemplateRequest - (required)
        Returns:
        SignatureRequestGetResponse
        Throws:
        ApiException - if fails to make API call
        Http Response Details
        Status Code Description Response Headers
        200 successful operation * X-RateLimit-Limit -
        * X-RateLimit-Remaining -
        * X-Ratelimit-Reset -
        4XX failed_operation -

      • signatureRequestSendWithTemplateWithHttpInfo

        public ApiResponse<SignatureRequestGetResponse> signatureRequestSendWithTemplateWithHttpInfo​(SignatureRequestSendWithTemplateRequest signatureRequestSendWithTemplateRequest)
                                                                                      throws ApiException
        Send with Template Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter.
        Parameters:
        signatureRequestSendWithTemplateRequest - (required)
        Returns:
        ApiResponse<SignatureRequestGetResponse>
        Throws:
        ApiException - if fails to make API call
        Http Response Details
        Status Code Description Response Headers
        200 successful operation * X-RateLimit-Limit -
        * X-RateLimit-Remaining -
        * X-Ratelimit-Reset -
        4XX failed_operation -

      • signatureRequestUpdate

        public SignatureRequestGetResponse signatureRequestUpdate​(java.lang.String signatureRequestId,
                                                          SignatureRequestUpdateRequest signatureRequestUpdateRequest)
                                                   throws ApiException
        Update Signature Request Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. **NOTE**: This action cannot be performed on a signature request with an appended signature page.
        Parameters:
        signatureRequestId - The id of the SignatureRequest to update. (required)
        signatureRequestUpdateRequest - (required)
        Returns:
        SignatureRequestGetResponse
        Throws:
        ApiException - if fails to make API call
        Http Response Details
        Status Code Description Response Headers
        200 successful operation * X-RateLimit-Limit -
        * X-RateLimit-Remaining -
        * X-Ratelimit-Reset -
        4XX failed_operation -

      • signatureRequestUpdateWithHttpInfo

        public ApiResponse<SignatureRequestGetResponse> signatureRequestUpdateWithHttpInfo​(java.lang.String signatureRequestId,
                                                                                   SignatureRequestUpdateRequest signatureRequestUpdateRequest)
                                                                            throws ApiException
        Update Signature Request Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. **NOTE**: This action cannot be performed on a signature request with an appended signature page.
        Parameters:
        signatureRequestId - The id of the SignatureRequest to update. (required)
        signatureRequestUpdateRequest - (required)
        Returns:
        ApiResponse<SignatureRequestGetResponse>
        Throws:
        ApiException - if fails to make API call
        Http Response Details
        Status Code Description Response Headers
        200 successful operation * X-RateLimit-Limit -
        * X-RateLimit-Remaining -
        * X-Ratelimit-Reset -
        4XX failed_operation -