HelloSignClient (HelloSign Java SDK 4.0.12 API)

java.lang.Object
- com.hellosign.sdk.HelloSignClient

```
public class HelloSignClient
extends Object
```
You'll need the HelloSignClient to do just about everything, from creating signatures to updating account information. To use this class, instantiate a client with valid credentials like so: HelloSignClient client = new HelloSignClient(user, key); Then, use the client to perform your requests. The client uses java.net.HttpURLConnection to perform its HTTP requests.

Author:

"Chris Paul ([email protected])"

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCOUNT_CREATE_URI`
`static String`	`ACCOUNT_URI`
`static String`	`API_APP_LIST_URI`
`static String`	`API_APP_URI`
`static String`	`CLIENT_ID`
`static String`	`CLIENT_SECRET`
`static String`	`DEFAULT_BASE_API_URL`
`static String`	`DEFAULT_ENCODING`
`static String`	`DEFAULT_OAUTH_TOKEN_URL`
`static String`	`EMBEDDED_EDIT_URL_URI`
`static String`	`EMBEDDED_SIGN_URL_URI`
`static String`	`EMBEDDED_TEMPLATE_CC_ROLES`
`static String`	`EMBEDDED_TEMPLATE_MERGE_FIELDS`
`static String`	`EMBEDDED_TEMPLATE_SKIP_SIGNER_ROLES`
`static String`	`EMBEDDED_TEMPLATE_SKIP_SUBJECT_MESSAGE`
`static String`	`FILES_FILE_EXT`
`static String`	`FILES_FILE_NAME`
`static String`	`FINAL_COPY_FILE_EXT`
`static String`	`FINAL_COPY_FILE_NAME`
`static String`	`OAUTH_CODE`
`static String`	`OAUTH_GRANT_TYPE`
`static String`	`OAUTH_GRANT_TYPE_AUTHORIZE_CODE`
`static String`	`OAUTH_GRANT_TYPE_REFRESH_TOKEN`
`static String`	`OAUTH_REFRESH_TOKEN`
`static String`	`OAUTH_STATE`
`static String`	`PARAM_FILE_TYPE_URI`
`static String`	`PARAM_GET_URL`
`static String`	`SIGNATURE_REQUEST_CANCEL_URI`
`static String`	`SIGNATURE_REQUEST_EMBEDDED_TEMPLATE_URI`
`static String`	`SIGNATURE_REQUEST_EMBEDDED_URI`
`static String`	`SIGNATURE_REQUEST_FILES_URI`
`static String`	`SIGNATURE_REQUEST_FINAL_COPY_URI`
`static String`	`SIGNATURE_REQUEST_LIST_URI`
`static String`	`SIGNATURE_REQUEST_REMIND_URI`
`static String`	`SIGNATURE_REQUEST_SEND_URI`
`static String`	`SIGNATURE_REQUEST_UPDATE_URI`
`static String`	`SIGNATURE_REQUEST_URI`
`static String`	`TEAM_ADD_MEMBER_URI`
`static String`	`TEAM_CREATE_URI`
`static String`	`TEAM_DESTROY_URI`
`static String`	`TEAM_REMOVE_MEMBER_URI`
`static String`	`TEAM_URI`
`static String`	`TEMPLATE_ADD_USER_URI`
`static String`	`TEMPLATE_CREATE_EMBEDDED_DRAFT_URI`
`static String`	`TEMPLATE_DELETE_URI`
`static String`	`TEMPLATE_FILE_EXT`
`static String`	`TEMPLATE_FILE_NAME`
`static String`	`TEMPLATE_FILE_URI`
`static String`	`TEMPLATE_LIST_URI`
`static String`	`TEMPLATE_REMOVE_USER_URI`
`static String`	`TEMPLATE_SIGNATURE_REQUEST_URI`
`static String`	`TEMPLATE_UPDATE_FILES_URI`
`static String`	`TEMPLATE_URI`
`static String`	`UNCLAIMED_DRAFT_CREATE_EMBEDDED_URI`
`static String`	`UNCLAIMED_DRAFT_CREATE_EMBEDDED_WITH_TEMPLATE_URI`
`static String`	`UNCLAIMED_DRAFT_CREATE_URI`
`static String`	`VALIDATE_ACCOUNT_URI`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`HelloSignClient(Authentication auth)` Creates a new HelloSign client using then given Authentication object.
`protected`	`HelloSignClient(HttpClient client, Authentication auth)` Default constructor for injection of dependencies (testing).
	`HelloSignClient(String apiKey)` Creates a new HelloSign client using your API key.

Method Summary

Methods
Modifier and Type	Method and Description
`Template`	`addTemplateUser(String templateId, String idOrEmail)` Adds the provided user to the template indicated by the provided template ID.
`boolean`	`cancelSignatureRequest(String id)` Cancels an existing signature request.
`Account`	`createAccount(String email)` Creates a new HelloSign account.
`Account`	`createAccount(String email, String clientId, String clientSecret)` Creates a new HelloSign account and provides OAuth app credentials to automatically generate an OAuth token with the user Account response.
`ApiApp`	`createApiApp(ApiApp app)` Creates a new ApiApp using the properties set on the provided ApiApp.
`AbstractRequest`	`createEmbeddedRequest(EmbeddedRequest embeddedReq)` Creates a signature request that can be embedded within your website.
`TemplateDraft`	`createEmbeddedTemplateDraft(EmbeddedRequest req)` Creates a template draft that can be used for embedded template creation.
`Team`	`createTeam(String teamName)` Creates a new team for the current user with the given name.
`UnclaimedDraft`	`createUnclaimedDraft(UnclaimedDraft draft)` Creates an unclaimed draft using the provided request draft object.
`boolean`	`deleteApiApp(String clientId)` Attempts to delete the API app with the given client ID.
`boolean`	`deleteTemplate(String templateId)` Delete the template designated by the template id
`boolean`	`destroyTeam()` Destroys the current user's team.
`Account`	`getAccount()` Returns the current user's account information.
`ApiApp`	`getApiApp(String clientId)` Retrieves the API app configuration for the given Client ID.
`ApiAppList`	`getApiApps()` Retrieves a paged list of API apps for the authenticated account.
`protected Authentication`	`getAuth()` Retrieves the authentication details being used by this client.
`EmbeddedResponse`	`getEmbeddedSignUrl(String signatureId)` Retrieves the necessary information to build an embedded signature request.
`EmbeddedResponse`	`getEmbeddedTemplateEditUrl(String templateId)` Retrieves the necessary information to edit an embedded template.
`EmbeddedResponse`	`getEmbeddedTemplateEditUrl(String templateId, boolean skipSignerRoles, boolean skipSubjectMessage)` Retrieves the necessary information to edit an embedded template.
`EmbeddedResponse`	`getEmbeddedTemplateEditUrl(String templateId, boolean skipSignerRoles, boolean skipSubjectMessage, boolean testMode)` Retrieves the necessary information to edit an embedded template.
`EmbeddedResponse`	`getEmbeddedTemplateEditUrl(String templateId, boolean skipSignerRoles, boolean skipSubjectMessage, boolean testMode, Map<String,FieldType> mergeFields, List<String> ccRoles)` Big kahuna method for editing an embedded template.
`File`	`getFiles(String requestId)` Retrieves a PDF copy of the files associated with a signature request.
`File`	`getFiles(String requestId, String format)` Retrieves the file associated with a signature request.
`FileUrlResponse`	`getFilesUrl(String requestId)` Retrieves a URL for a file associated with a signature request.
`File`	`getFinalCopy(String requestId)` Deprecated. Use {`getFiles(String)`
`OauthData`	`getOauthData(String code, String clientId, String secret, String state, boolean autoSetRequestToken)` Performs an OAuth request and returns the necessary data for authorizing an API application, and will automatically set the access token and code for making authenticated requests with this client.
`SignatureRequest`	`getSignatureRequest(String id)` Retrieves a Signature Request with the given ID.
`SignatureRequestList`	`getSignatureRequests()` Retrieves the current user's signature requests.
`SignatureRequestList`	`getSignatureRequests(int page)` Retrieves a specific page of the current user's signature requests.
`SignatureRequestList`	`getSignatureRequests(int page, int pageSize)` Retrieves a specific page of the current user's signature requests.
`Team`	`getTeam()` Retrieves the Team for the current user account.
`Template`	`getTemplate(String templateId)` Retrieves a specific Template based on the provided Template ID.
`File`	`getTemplateFile(String templateId)` Retrieves the PDF file backing the Template specified by the provided Template ID.
`String`	`getTemplateFileUrl(String templateId)` Returns a signed URL that can be used to retrieve the file backing a template.
`TemplateList`	`getTemplates()` Retrieves the templates for the current user account.
`TemplateList`	`getTemplates(int page)` Retrieves a page of templates for the current user account.
`TemplateList`	`getTemplates(int page, int pageSize)` Retrieves a page of templates with a specific pageSize
`Team`	`inviteTeamMember(String idOrEmail)` Adds the user to the current user's team.
`boolean`	`isAccountValid(String email)` Returns true if an account exists with the provided email address.
`boolean`	`isOnline()` Deprecated. This function was previously for internal testing use only and is no longer operational. This will be removed in the next minor version of the SDK.
`OauthData`	`refreshOauthData(String refreshToken)` Refreshes the OauthData for this client with the provided refresh token.
`Team`	`removeTeamMember(String idOrEmail)` Removes the team member indicated by the user account ID or email address.
`Template`	`removeTemplateUser(String templateId, String idOrEmail)` Adds the provided user to the template indicated by the provided template ID.
`SignatureRequest`	`requestEmailReminder(String requestId, String email)` Instructs HelloSign to email the given address with a reminder to sign the SignatureRequest referenced by the given request ID.
`SignatureRequest`	`sendSignatureRequest(SignatureRequest req)` Sends the provided signature request to HelloSign.
`SignatureRequest`	`sendTemplateSignatureRequest(TemplateSignatureRequest req)` Creates a new Signature Request based on the template provided.
`void`	`setAccessToken(String accessToken, String tokenType)` Sets the access token for the OAuth user that this client will use to perform requests.
`void`	`setAuthentication(Authentication auth)` Allows overriding of the authentication mechanism.
`Account`	`setCallback(String callback)` Update your account callback URL.
`ApiApp`	`updateApiApp(ApiApp app)` Updates the API app with the given ApiApp object properties.
`SignatureRequest`	`updateSignatureRequest(String signatureRequestId, String signatureId, String newEmailAddress)` Update a signer's email address.
`Team`	`updateTeamName(String teamName)` Updates the current user's team name.
`String`	`updateTemplateFiles(String existingTemplateId, TemplateDraft newTemplate, String clientId)` Replaces the backing documents for the given template with the given files.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_ENCODING
```
public static final String DEFAULT_ENCODING
```
    See Also:
    Constant Field Values
  - DEFAULT_BASE_API_URL
```
public static final String DEFAULT_BASE_API_URL
```
    See Also:
    Constant Field Values
  - DEFAULT_OAUTH_TOKEN_URL
```
public static final String DEFAULT_OAUTH_TOKEN_URL
```
    See Also:
    Constant Field Values
  - ACCOUNT_URI
```
public static final String ACCOUNT_URI
```
    See Also:
    Constant Field Values
  - VALIDATE_ACCOUNT_URI
```
public static final String VALIDATE_ACCOUNT_URI
```
    See Also:
    Constant Field Values
  - ACCOUNT_CREATE_URI
```
public static final String ACCOUNT_CREATE_URI
```
    See Also:
    Constant Field Values
  - TEAM_URI
```
public static final String TEAM_URI
```
    See Also:
    Constant Field Values
  - TEAM_CREATE_URI
```
public static final String TEAM_CREATE_URI
```
    See Also:
    Constant Field Values
  - TEAM_DESTROY_URI
```
public static final String TEAM_DESTROY_URI
```
    See Also:
    Constant Field Values
  - TEAM_ADD_MEMBER_URI
```
public static final String TEAM_ADD_MEMBER_URI
```
    See Also:
    Constant Field Values
  - TEAM_REMOVE_MEMBER_URI
```
public static final String TEAM_REMOVE_MEMBER_URI
```
    See Also:
    Constant Field Values
  - SIGNATURE_REQUEST_URI
```
public static final String SIGNATURE_REQUEST_URI
```
    See Also:
    Constant Field Values
  - SIGNATURE_REQUEST_LIST_URI
```
public static final String SIGNATURE_REQUEST_LIST_URI
```
    See Also:
    Constant Field Values
  - SIGNATURE_REQUEST_SEND_URI
```
public static final String SIGNATURE_REQUEST_SEND_URI
```
    See Also:
    Constant Field Values
  - TEMPLATE_URI
```
public static final String TEMPLATE_URI
```
    See Also:
    Constant Field Values
  - TEMPLATE_FILE_URI
```
public static final String TEMPLATE_FILE_URI
```
    See Also:
    Constant Field Values
  - TEMPLATE_LIST_URI
```
public static final String TEMPLATE_LIST_URI
```
    See Also:
    Constant Field Values
  - TEMPLATE_ADD_USER_URI
```
public static final String TEMPLATE_ADD_USER_URI
```
    See Also:
    Constant Field Values
  - TEMPLATE_REMOVE_USER_URI
```
public static final String TEMPLATE_REMOVE_USER_URI
```
    See Also:
    Constant Field Values
  - TEMPLATE_DELETE_URI
```
public static final String TEMPLATE_DELETE_URI
```
    See Also:
    Constant Field Values
  - TEMPLATE_UPDATE_FILES_URI
```
public static final String TEMPLATE_UPDATE_FILES_URI
```
    See Also:
    Constant Field Values
  - TEMPLATE_CREATE_EMBEDDED_DRAFT_URI
```
public static final String TEMPLATE_CREATE_EMBEDDED_DRAFT_URI
```
    See Also:
    Constant Field Values
  - TEMPLATE_SIGNATURE_REQUEST_URI
```
public static final String TEMPLATE_SIGNATURE_REQUEST_URI
```
    See Also:
    Constant Field Values
  - SIGNATURE_REQUEST_CANCEL_URI
```
public static final String SIGNATURE_REQUEST_CANCEL_URI
```
    See Also:
    Constant Field Values
  - SIGNATURE_REQUEST_REMIND_URI
```
public static final String SIGNATURE_REQUEST_REMIND_URI
```
    See Also:
    Constant Field Values
  - SIGNATURE_REQUEST_FINAL_COPY_URI
```
public static final String SIGNATURE_REQUEST_FINAL_COPY_URI
```
    See Also:
    Constant Field Values
  - SIGNATURE_REQUEST_FILES_URI
```
public static final String SIGNATURE_REQUEST_FILES_URI
```
    See Also:
    Constant Field Values
  - SIGNATURE_REQUEST_UPDATE_URI
```
public static final String SIGNATURE_REQUEST_UPDATE_URI
```
    See Also:
    Constant Field Values
  - SIGNATURE_REQUEST_EMBEDDED_URI
```
public static final String SIGNATURE_REQUEST_EMBEDDED_URI
```
    See Also:
    Constant Field Values
  - SIGNATURE_REQUEST_EMBEDDED_TEMPLATE_URI
```
public static final String SIGNATURE_REQUEST_EMBEDDED_TEMPLATE_URI
```
    See Also:
    Constant Field Values
  - EMBEDDED_SIGN_URL_URI
```
public static final String EMBEDDED_SIGN_URL_URI
```
    See Also:
    Constant Field Values
  - EMBEDDED_EDIT_URL_URI
```
public static final String EMBEDDED_EDIT_URL_URI
```
    See Also:
    Constant Field Values
  - UNCLAIMED_DRAFT_CREATE_URI
```
public static final String UNCLAIMED_DRAFT_CREATE_URI
```
    See Also:
    Constant Field Values
  - UNCLAIMED_DRAFT_CREATE_EMBEDDED_URI
```
public static final String UNCLAIMED_DRAFT_CREATE_EMBEDDED_URI
```
    See Also:
    Constant Field Values
  - UNCLAIMED_DRAFT_CREATE_EMBEDDED_WITH_TEMPLATE_URI
```
public static final String UNCLAIMED_DRAFT_CREATE_EMBEDDED_WITH_TEMPLATE_URI
```
    See Also:
    Constant Field Values
  - API_APP_URI
```
public static final String API_APP_URI
```
    See Also:
    Constant Field Values
  - API_APP_LIST_URI
```
public static final String API_APP_LIST_URI
```
    See Also:
    Constant Field Values
  - PARAM_FILE_TYPE_URI
```
public static final String PARAM_FILE_TYPE_URI
```
    See Also:
    Constant Field Values
  - PARAM_GET_URL
```
public static final String PARAM_GET_URL
```
    See Also:
    Constant Field Values
  - FINAL_COPY_FILE_NAME
```
public static final String FINAL_COPY_FILE_NAME
```
    See Also:
    Constant Field Values
  - FINAL_COPY_FILE_EXT
```
public static final String FINAL_COPY_FILE_EXT
```
    See Also:
    Constant Field Values
  - FILES_FILE_NAME
```
public static final String FILES_FILE_NAME
```
    See Also:
    Constant Field Values
  - FILES_FILE_EXT
```
public static final String FILES_FILE_EXT
```
    See Also:
    Constant Field Values
  - TEMPLATE_FILE_NAME
```
public static final String TEMPLATE_FILE_NAME
```
    See Also:
    Constant Field Values
  - TEMPLATE_FILE_EXT
```
public static final String TEMPLATE_FILE_EXT
```
    See Also:
    Constant Field Values
  - OAUTH_CODE
```
public static final String OAUTH_CODE
```
    See Also:
    Constant Field Values
  - OAUTH_STATE
```
public static final String OAUTH_STATE
```
    See Also:
    Constant Field Values
  - OAUTH_GRANT_TYPE
```
public static final String OAUTH_GRANT_TYPE
```
    See Also:
    Constant Field Values
  - OAUTH_REFRESH_TOKEN
```
public static final String OAUTH_REFRESH_TOKEN
```
    See Also:
    Constant Field Values
  - OAUTH_GRANT_TYPE_AUTHORIZE_CODE
```
public static final String OAUTH_GRANT_TYPE_AUTHORIZE_CODE
```
    See Also:
    Constant Field Values
  - OAUTH_GRANT_TYPE_REFRESH_TOKEN
```
public static final String OAUTH_GRANT_TYPE_REFRESH_TOKEN
```
    See Also:
    Constant Field Values
  - CLIENT_SECRET
```
public static final String CLIENT_SECRET
```
    See Also:
    Constant Field Values
  - CLIENT_ID
```
public static final String CLIENT_ID
```
    See Also:
    Constant Field Values
  - EMBEDDED_TEMPLATE_SKIP_SIGNER_ROLES
```
public static final String EMBEDDED_TEMPLATE_SKIP_SIGNER_ROLES
```
    See Also:
    Constant Field Values
  - EMBEDDED_TEMPLATE_SKIP_SUBJECT_MESSAGE
```
public static final String EMBEDDED_TEMPLATE_SKIP_SUBJECT_MESSAGE
```
    See Also:
    Constant Field Values
  - EMBEDDED_TEMPLATE_MERGE_FIELDS
```
public static final String EMBEDDED_TEMPLATE_MERGE_FIELDS
```
    See Also:
    Constant Field Values
  - EMBEDDED_TEMPLATE_CC_ROLES
```
public static final String EMBEDDED_TEMPLATE_CC_ROLES
```
    See Also:
    Constant Field Values
- Constructor Detail
  - HelloSignClient
```
protected HelloSignClient(HttpClient client,
               Authentication auth)
```
    Default constructor for injection of dependencies (testing).
    
    Parameters:
    client - HttpClient
    auth - Authentication
    See Also:
    HelloSignClient(String)
  - HelloSignClient
```
public HelloSignClient(String apiKey)
                throws HelloSignException
```
    Creates a new HelloSign client using your API key.
    
    Parameters:
    apiKey - String API key
    
    Throws:
    
    HelloSignException - thrown if there's a problem setting the credentials
    See Also:
    Account Settings
  - HelloSignClient
```
public HelloSignClient(Authentication auth)
                throws HelloSignException
```
    Creates a new HelloSign client using then given Authentication object.
    
    Parameters:
    auth - Authentication used primarily for setting OAuth token/secret
    
    Throws:
    
    HelloSignException - thrown if there's a problem setting the credentials
- Method Detail
  - setAuthentication
```
public void setAuthentication(Authentication auth)
```
    Allows overriding of the authentication mechanism. Used mainly for setting an OAuth token/secret.
    
    Parameters:
    auth - Authentication used for setting the auth method for this client
  - getAuth
```
protected Authentication getAuth()
```
    Retrieves the authentication details being used by this client. Used for testing purposes.
    
    Returns:
    Authentication
  - getAccount
```
public Account getAccount()
                   throws HelloSignException
```
    Returns the current user's account information.
    
    Returns:
    Account
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - isAccountValid
```
public boolean isAccountValid(String email)
                       throws HelloSignException
```
    Returns true if an account exists with the provided email address. Note this is limited to the visibility of the currently authenticated user.
    
    Parameters:
    email - String email address
    
    Returns:
    true if the account exists, false otherwise
    
    Throws:
    
    HelloSignException - Thrown if there's a problem communicating with the HelloSign API.
  - setCallback
```
public Account setCallback(String callback)
                    throws HelloSignException
```
    Update your account callback URL. This URL is used to notify you of any signature request events that occur when your account is a party -- e.g., sender or signer/recipient.
    
    Parameters:
    callback - String URL
    
    Returns:
    Account
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - createAccount
```
public Account createAccount(String email)
                      throws HelloSignException
```
    Creates a new HelloSign account. The user will still need to validate their email address to complete the creation process to set a password. Note: This request does not require authentication, so just performs the basic POST.
    
    Parameters:
    email - String New user's email address
    
    Returns:
    Account New user's account information
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - createAccount
```
public Account createAccount(String email,
                    String clientId,
                    String clientSecret)
                      throws HelloSignException
```
    Creates a new HelloSign account and provides OAuth app credentials to automatically generate an OAuth token with the user Account response.
    
    Parameters:
    email - String New user's email address
    clientId - String Client ID
    clientSecret - String App secret
    
    Returns:
    Account New user's account information
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - getOauthData
```
public OauthData getOauthData(String code,
                     String clientId,
                     String secret,
                     String state,
                     boolean autoSetRequestToken)
                       throws HelloSignException
```
    Performs an OAuth request and returns the necessary data for authorizing an API application, and will automatically set the access token and code for making authenticated requests with this client.
    
    Parameters:
    code - String OAuth code
    clientId - String OAuth client ID
    secret - String OAuth secret
    state - String OAuth client state
    autoSetRequestToken - true if the token should be applied to this client for future requests
    
    Returns:
    OauthData object containing OAuth token details
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - refreshOauthData
```
public OauthData refreshOauthData(String refreshToken)
                           throws HelloSignException
```
    Refreshes the OauthData for this client with the provided refresh token.
    
    Parameters:
    refreshToken - String
    
    Returns:
    OauthData new OAuthData returned from HelloSign
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - getTeam
```
public Team getTeam()
             throws HelloSignException
```
    Retrieves the Team for the current user account.
    
    Returns:
    Team
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - createTeam
```
public Team createTeam(String teamName)
                throws HelloSignException
```
    Creates a new team for the current user with the given name.
    
    Parameters:
    teamName - String team name
    
    Returns:
    Team
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - destroyTeam
```
public boolean destroyTeam()
                    throws HelloSignException
```
    Destroys the current user's team.
    
    Returns:
    boolean if destroy was successful
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - updateTeamName
```
public Team updateTeamName(String teamName)
                    throws HelloSignException
```
    Updates the current user's team name.
    
    Parameters:
    teamName - String team name
    
    Returns:
    Team
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - inviteTeamMember
```
public Team inviteTeamMember(String idOrEmail)
                      throws HelloSignException
```
    Adds the user to the current user's team.
    
    Parameters:
    idOrEmail - String new team member's account ID or email address
    
    Returns:
    Team
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - removeTeamMember
```
public Team removeTeamMember(String idOrEmail)
                      throws HelloSignException
```
    Removes the team member indicated by the user account ID or email address.
    
    Parameters:
    idOrEmail - String removed team member's account ID or email address
    
    Returns:
    Team
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - getSignatureRequest
```
public SignatureRequest getSignatureRequest(String id)
                                     throws HelloSignException
```
    Retrieves a Signature Request with the given ID.
    
    Parameters:
    id - String signature ID
    
    Returns:
    SignatureRequest
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - getSignatureRequests
```
public SignatureRequestList getSignatureRequests()
                                          throws HelloSignException
```
    Retrieves the current user's signature requests. The resulting object represents a paged query result. The page information can be retrieved on from the ListInfo object on the SignatureRequestList.
    
    Returns:
    SignatureRequestList
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - getSignatureRequests
```
public SignatureRequestList getSignatureRequests(int page)
                                          throws HelloSignException
```
    Retrieves a specific page of the current user's signature requests.
    
    Parameters:
    page - int
    
    Returns:
    SignatureRequestList
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - getSignatureRequests
```
public SignatureRequestList getSignatureRequests(int page,
                                        int pageSize)
                                          throws HelloSignException
```
    Retrieves a specific page of the current user's signature requests.
    
    Parameters:
    page - int
    pageSize - int Must be between 1 and 100.
    
    Returns:
    SignatureRequestList
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - sendSignatureRequest
```
public SignatureRequest sendSignatureRequest(SignatureRequest req)
                                      throws HelloSignException
```
    Sends the provided signature request to HelloSign.
    
    Parameters:
    req - SignatureRequest
    
    Returns:
    SignatureRequest
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - updateSignatureRequest
```
public SignatureRequest updateSignatureRequest(String signatureRequestId,
                                      String signatureId,
                                      String newEmailAddress)
                                        throws HelloSignException
```
    Update a signer's email address. This method requires the ID of the siganture request that has already been sent, as well as the signature_id that represents the signer that should be updated. The ema
    
    Parameters:
    signatureRequestId - String ID of the signature request that has already been sent and needs to be updated.
    signatureId - String ID of the signer that needs to be updated.
    newEmailAddress - String email address that the signer should be changed to
    
    Returns:
    SignatureRequest The updated request data
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - getTemplates
```
public TemplateList getTemplates()
                          throws HelloSignException
```
    Retrieves the templates for the current user account.
    
    Returns:
    TemplateList
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - getTemplates
```
public TemplateList getTemplates(int page)
                          throws HelloSignException
```
    Retrieves a page of templates for the current user account.
    
    Parameters:
    page - int
    
    Returns:
    TemplateList
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - getTemplates
```
public TemplateList getTemplates(int page,
                        int pageSize)
                          throws HelloSignException
```
    Retrieves a page of templates with a specific pageSize
    
    Parameters:
    page - int
    pageSize - int Must be between 1 and 100.
    
    Returns:
    TemplateList
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - getTemplateFile
```
public File getTemplateFile(String templateId)
                     throws HelloSignException
```
    Retrieves the PDF file backing the Template specified by the provided Template ID.
    
    Parameters:
    templateId - String Template ID
    
    Returns:
    File PDF file object
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - getTemplateFileUrl
```
public String getTemplateFileUrl(String templateId)
                          throws HelloSignException
```
    Returns a signed URL that can be used to retrieve the file backing a template.
    
    Parameters:
    templateId - String Template ID
    
    Returns:
    String URL or null if no file URL can be retrieved
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - getTemplate
```
public Template getTemplate(String templateId)
                     throws HelloSignException
```
    Retrieves a specific Template based on the provided Template ID.
    
    Parameters:
    templateId - String Template ID
    
    Returns:
    Template
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - addTemplateUser
```
public Template addTemplateUser(String templateId,
                       String idOrEmail)
                         throws HelloSignException
```
    Adds the provided user to the template indicated by the provided template ID. The new user can be designated using their account ID or email address.
    
    Parameters:
    templateId - String template ID
    idOrEmail - String account ID or email address
    
    Returns:
    Template
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - deleteTemplate
```
public boolean deleteTemplate(String templateId)
                       throws HelloSignException
```
    Delete the template designated by the template id
    
    Parameters:
    templateId - String template ID
    
    Returns:
    true if the delete was successful, false otherwise
    
    Throws:
    
    HelloSignException - thrown if there is a problem processing the HTTP request
  - updateTemplateFiles
```
public String updateTemplateFiles(String existingTemplateId,
                         TemplateDraft newTemplate,
                         String clientId)
                           throws HelloSignException
```
    Replaces the backing documents for the given template with the given files. Note that certain rules apply to this endpoint: https://app.hellosign.com/api/reference#update_template_files
    
    Parameters:
    existingTemplateId - String ID of the template from which the overlay data (signatures, text fields, etc.) will be retrieved.
    newTemplate - TemplateDraft that holds the data and documents which will be used as the basis for the new template. The following fields can be set in this request: files or file_urls, subject, message, and test_mode.
    clientId - String optional ID of the app which is generating this new template. Set to null if not used.
    
    Returns:
    String ID of the template to be created
    
    Throws:
    
    HelloSignException - thrown if there is a problem processing the HTTP request
  - removeTemplateUser
```
public Template removeTemplateUser(String templateId,
                          String idOrEmail)
                            throws HelloSignException
```
    Adds the provided user to the template indicated by the provided template ID. The new user can be designated using their account ID or email address.
    
    Parameters:
    templateId - String template ID
    idOrEmail - String account ID or email address
    
    Returns:
    Template
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - sendTemplateSignatureRequest
```
public SignatureRequest sendTemplateSignatureRequest(TemplateSignatureRequest req)
                                              throws HelloSignException
```
    Creates a new Signature Request based on the template provided.
    
    Parameters:
    req - TemplateSignatureRequest
    
    Returns:
    SignatureRequest
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - cancelSignatureRequest
```
public boolean cancelSignatureRequest(String id)
                               throws HelloSignException
```
    Cancels an existing signature request. If it has been completed, it will delete the signature request from your account.
    
    Parameters:
    id - SignatureRequest id
    
    Returns:
    boolean true if successful
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - requestEmailReminder
```
public SignatureRequest requestEmailReminder(String requestId,
                                    String email)
                                      throws HelloSignException
```
    Instructs HelloSign to email the given address with a reminder to sign the SignatureRequest referenced by the given request ID. Note: You cannot send a reminder within 1 hours of the last reminder that was sent, manually or automatically.
    
    Parameters:
    requestId - String SignatureRequest ID
    email - String email
    
    Returns:
    SignatureRequest The request to be reminded
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - getFinalCopy
```
public File getFinalCopy(String requestId)
                  throws HelloSignException
```
    Deprecated. Use {getFiles(String)
    
    Retrieves the final PDF copy of a signature request, if it exists.
    
    Parameters:
    requestId - String SignatureRequest ID
    
    Returns:
    File final copy file, or null if it does not yet exist
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - getFiles
```
public File getFiles(String requestId)
              throws HelloSignException
```
    Retrieves a PDF copy of the files associated with a signature request.
    
    Parameters:
    requestId - String signature ID
    
    Returns:
    File PDF file
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - getFiles
```
public File getFiles(String requestId,
            String format)
              throws HelloSignException
```
    Retrieves the file associated with a signature request.
    
    Parameters:
    requestId - String signature request ID
    format - String format, see SignatureRequest for available types
    
    Returns:
    File
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - getFilesUrl
```
public FileUrlResponse getFilesUrl(String requestId)
                            throws HelloSignException
```
    Retrieves a URL for a file associated with a signature request.
    
    Parameters:
    requestId - String signature request ID
    
    Returns:
    FileUrlResponse
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
    See Also:
    https://app.hellosign.com/api/reference#get_files
  - createEmbeddedRequest
```
public AbstractRequest createEmbeddedRequest(EmbeddedRequest embeddedReq)
                                      throws HelloSignException
```
    Creates a signature request that can be embedded within your website.
    
    Parameters:
    embeddedReq - EmbeddedRequest
    
    Returns:
    SignatureRequest
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - getEmbeddedSignUrl
```
public EmbeddedResponse getEmbeddedSignUrl(String signatureId)
                                    throws HelloSignException
```
    Retrieves the necessary information to build an embedded signature request.
    
    Parameters:
    signatureId - String ID of the signature request to embed
    
    Returns:
    EmbeddedResponse
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - getEmbeddedTemplateEditUrl
```
public EmbeddedResponse getEmbeddedTemplateEditUrl(String templateId)
                                            throws HelloSignException
```
    Retrieves the necessary information to edit an embedded template.
    
    Parameters:
    templateId - String ID of the signature request to embed
    
    Returns:
    EmbeddedResponse
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - getEmbeddedTemplateEditUrl
```
public EmbeddedResponse getEmbeddedTemplateEditUrl(String templateId,
                                          boolean skipSignerRoles,
                                          boolean skipSubjectMessage)
                                            throws HelloSignException
```
    Retrieves the necessary information to edit an embedded template.
    
    Parameters:
    templateId - String ID of the signature request to embed
    skipSignerRoles - true if the edited template should not allow the user to modify the template's signer roles. Defaults to false.
    skipSubjectMessage - true if the edited template should not allow the user to modify the template's subject and message. Defaults to false.
    
    Returns:
    EmbeddedResponse
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - getEmbeddedTemplateEditUrl
```
public EmbeddedResponse getEmbeddedTemplateEditUrl(String templateId,
                                          boolean skipSignerRoles,
                                          boolean skipSubjectMessage,
                                          boolean testMode)
                                            throws HelloSignException
```
    Retrieves the necessary information to edit an embedded template.
    
    Parameters:
    templateId - String ID of the signature request to embed
    skipSignerRoles - true if the edited template should not allow the user to modify the template's signer roles. Defaults to false.
    skipSubjectMessage - true if the edited template should not allow the user to modify the template's subject and message. Defaults to false.
    testMode - true if this request is a test request. Useful for editing locked templates.
    
    Returns:
    EmbeddedResponse
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - getEmbeddedTemplateEditUrl
```
public EmbeddedResponse getEmbeddedTemplateEditUrl(String templateId,
                                          boolean skipSignerRoles,
                                          boolean skipSubjectMessage,
                                          boolean testMode,
                                          Map<String,FieldType> mergeFields,
                                          List<String> ccRoles)
                                            throws HelloSignException
```
    Big kahuna method for editing an embedded template. This method allows the updating of merge fields and CC roles (both optional parameters).
    
    Parameters:
    templateId - String ID of the signature request to embed
    skipSignerRoles - true if the edited template should not allow the user to modify the template's signer roles. Defaults to false.
    skipSubjectMessage - true if the edited template should not allow the user to modify the template's subject and message. Defaults to false.
    testMode - true if this request is a test request. Useful for editing locked templates.
    mergeFields - These will overwrite the current merge fields for the embedded template. To remove all merge fields, pass in an empty Map.
    ccRoles - These will overwrite the current CC Roles for the embedded template. To remove all CC roles, pass in null or an empty List.
    
    Returns:
    EmbeddedResponse
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - createUnclaimedDraft
```
public UnclaimedDraft createUnclaimedDraft(UnclaimedDraft draft)
                                    throws HelloSignException
```
    Creates an unclaimed draft using the provided request draft object.
    
    Parameters:
    draft - UnclaimedDraft
    
    Returns:
    UnclaimedDraft The created draft
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - createEmbeddedTemplateDraft
```
public TemplateDraft createEmbeddedTemplateDraft(EmbeddedRequest req)
                                          throws HelloSignException
```
    Creates a template draft that can be used for embedded template creation.
    
    Parameters:
    req - EmbeddedRequest
    
    Returns:
    Template the unclaimed template draft
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - getApiApp
```
public ApiApp getApiApp(String clientId)
                 throws HelloSignException
```
    Retrieves the API app configuration for the given Client ID.
    
    Parameters:
    clientId - String
    
    Returns:
    ApiApp
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - getApiApps
```
public ApiAppList getApiApps()
                      throws HelloSignException
```
    Retrieves a paged list of API apps for the authenticated account.
    
    Returns:
    ApiAppList
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - createApiApp
```
public ApiApp createApiApp(ApiApp app)
                    throws HelloSignException
```
    Creates a new ApiApp using the properties set on the provided ApiApp.
    
    Parameters:
    app - ApiApp
    
    Returns:
    ApiApp newly created ApiApp
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - deleteApiApp
```
public boolean deleteApiApp(String clientId)
                     throws HelloSignException
```
    Attempts to delete the API app with the given client ID.
    
    Parameters:
    clientId - String The Client ID of the app that should be deleted.
    
    Returns:
    boolean true if the API app was successfully deleted
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - updateApiApp
```
public ApiApp updateApiApp(ApiApp app)
                    throws HelloSignException
```
    Updates the API app with the given ApiApp object properties.
    
    Parameters:
    app - ApiApp
    
    Returns:
    ApiApp updated ApiApp
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or the JSON response.
  - isOnline
```
public boolean isOnline()
                 throws HelloSignException
```
    Deprecated. This function was previously for internal testing use only and is no longer operational. This will be removed in the next minor version of the SDK.
    
    Performs an OPTIONS call to the HelloSign API to see if it's online.
    
    Returns:
    true if HelloSign is available and the client is online, false otherwise.
    
    Throws:
    
    HelloSignException - thrown if there's a problem processing the HTTP request or response.
  - setAccessToken
```
public void setAccessToken(String accessToken,
                  String tokenType)
                    throws HelloSignException
```
    Sets the access token for the OAuth user that this client will use to perform requests.
    
    Parameters:
    accessToken - String access token
    tokenType - String token type
    
    Throws:
    
    HelloSignException - thrown if there's a problem setting the access token.

Class HelloSignClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ENCODING

DEFAULT_BASE_API_URL

DEFAULT_OAUTH_TOKEN_URL

ACCOUNT_URI

VALIDATE_ACCOUNT_URI

ACCOUNT_CREATE_URI

TEAM_URI

TEAM_CREATE_URI

TEAM_DESTROY_URI

TEAM_ADD_MEMBER_URI

TEAM_REMOVE_MEMBER_URI

SIGNATURE_REQUEST_URI

SIGNATURE_REQUEST_LIST_URI

SIGNATURE_REQUEST_SEND_URI

TEMPLATE_URI

TEMPLATE_FILE_URI

TEMPLATE_LIST_URI

TEMPLATE_ADD_USER_URI

TEMPLATE_REMOVE_USER_URI

TEMPLATE_DELETE_URI

TEMPLATE_UPDATE_FILES_URI

TEMPLATE_CREATE_EMBEDDED_DRAFT_URI

TEMPLATE_SIGNATURE_REQUEST_URI

SIGNATURE_REQUEST_CANCEL_URI

SIGNATURE_REQUEST_REMIND_URI

SIGNATURE_REQUEST_FINAL_COPY_URI

SIGNATURE_REQUEST_FILES_URI

SIGNATURE_REQUEST_UPDATE_URI

SIGNATURE_REQUEST_EMBEDDED_URI

SIGNATURE_REQUEST_EMBEDDED_TEMPLATE_URI

EMBEDDED_SIGN_URL_URI

EMBEDDED_EDIT_URL_URI

UNCLAIMED_DRAFT_CREATE_URI

UNCLAIMED_DRAFT_CREATE_EMBEDDED_URI

UNCLAIMED_DRAFT_CREATE_EMBEDDED_WITH_TEMPLATE_URI

API_APP_URI

API_APP_LIST_URI

PARAM_FILE_TYPE_URI

PARAM_GET_URL

FINAL_COPY_FILE_NAME

FINAL_COPY_FILE_EXT

FILES_FILE_NAME

FILES_FILE_EXT

TEMPLATE_FILE_NAME

TEMPLATE_FILE_EXT

OAUTH_CODE

OAUTH_STATE

OAUTH_GRANT_TYPE

OAUTH_REFRESH_TOKEN

OAUTH_GRANT_TYPE_AUTHORIZE_CODE

OAUTH_GRANT_TYPE_REFRESH_TOKEN

CLIENT_SECRET

CLIENT_ID

EMBEDDED_TEMPLATE_SKIP_SIGNER_ROLES

EMBEDDED_TEMPLATE_SKIP_SUBJECT_MESSAGE

EMBEDDED_TEMPLATE_MERGE_FIELDS

EMBEDDED_TEMPLATE_CC_ROLES

Constructor Detail

HelloSignClient

HelloSignClient

HelloSignClient

Method Detail

setAuthentication

getAuth

getAccount

isAccountValid

setCallback

createAccount

createAccount

getOauthData

refreshOauthData

getTeam

createTeam

destroyTeam