com.box.sdkgen.managers.signrequests

Class SignRequestsManager

Object

SignRequestsManager

public class SignRequestsManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SignRequestsManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

Modifier	Constructor and Description
	SignRequestsManager()
protected	SignRequestsManager(SignRequestsManager.Builder builder)

Method Summary

Modifier and Type	Method and Description
SignRequest	cancelSignRequest(String signRequestId) Cancels a sign request.
SignRequest	cancelSignRequest(String signRequestId, CancelSignRequestHeaders headers) Cancels a sign request.
SignRequest	cancelSignRequest(String signRequestId, SignRequestCancelRequest requestBody) Cancels a sign request.
SignRequest	cancelSignRequest(String signRequestId, SignRequestCancelRequest requestBody, CancelSignRequestHeaders headers) Cancels a sign request.
SignRequest	createSignRequest(SignRequestCreateRequest requestBody) Creates a signature request.
SignRequest	createSignRequest(SignRequestCreateRequest requestBody, CreateSignRequestHeaders headers) Creates a signature request.
Authentication	getAuth()
NetworkSession	getNetworkSession()
SignRequest	getSignRequestById(String signRequestId) Gets a sign request by ID.
SignRequest	getSignRequestById(String signRequestId, GetSignRequestByIdHeaders headers) Gets a sign request by ID.
SignRequests	getSignRequests() Gets signature requests created by a user.
SignRequests	getSignRequests(GetSignRequestsHeaders headers) Gets signature requests created by a user.
SignRequests	getSignRequests(GetSignRequestsQueryParams queryParams) Gets signature requests created by a user.
SignRequests	getSignRequests(GetSignRequestsQueryParams queryParams, GetSignRequestsHeaders headers) Gets signature requests created by a user.
void	resendSignRequest(String signRequestId) Resends a signature request email to all outstanding signers.
void	resendSignRequest(String signRequestId, ResendSignRequestHeaders headers) Resends a signature request email to all outstanding signers.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

auth

public Authentication auth

networkSession

public NetworkSession networkSession

Constructor Detail

SignRequestsManager

public SignRequestsManager()

SignRequestsManager

protected SignRequestsManager(SignRequestsManager.Builder builder)

Method Detail

cancelSignRequest

public SignRequest cancelSignRequest(String signRequestId)

Cancels a sign request.

Parameters:

signRequestId - The ID of the signature request. Example: "33243242"

cancelSignRequest

public SignRequest cancelSignRequest(String signRequestId,
                                     SignRequestCancelRequest requestBody)

Cancels a sign request.

Parameters:

signRequestId - The ID of the signature request. Example: "33243242"

requestBody - Request body of cancelSignRequest method

cancelSignRequest

public SignRequest cancelSignRequest(String signRequestId,
                                     CancelSignRequestHeaders headers)

Cancels a sign request.

Parameters:

signRequestId - The ID of the signature request. Example: "33243242"

headers - Headers of cancelSignRequest method

cancelSignRequest

public SignRequest cancelSignRequest(String signRequestId,
                                     SignRequestCancelRequest requestBody,
                                     CancelSignRequestHeaders headers)

Cancels a sign request.

Parameters:

signRequestId - The ID of the signature request. Example: "33243242"

requestBody - Request body of cancelSignRequest method

headers - Headers of cancelSignRequest method

resendSignRequest

public void resendSignRequest(String signRequestId)

Resends a signature request email to all outstanding signers.

Parameters:

signRequestId - The ID of the signature request. Example: "33243242"

resendSignRequest

public void resendSignRequest(String signRequestId,
                              ResendSignRequestHeaders headers)

Resends a signature request email to all outstanding signers.

Parameters:

signRequestId - The ID of the signature request. Example: "33243242"

headers - Headers of resendSignRequest method

getSignRequestById

public SignRequest getSignRequestById(String signRequestId)

Gets a sign request by ID.

Parameters:

signRequestId - The ID of the signature request. Example: "33243242"

getSignRequestById

public SignRequest getSignRequestById(String signRequestId,
                                      GetSignRequestByIdHeaders headers)

Gets a sign request by ID.

Parameters:

signRequestId - The ID of the signature request. Example: "33243242"

headers - Headers of getSignRequestById method

getSignRequests

public SignRequests getSignRequests()

Gets signature requests created by a user. If the `sign_files` and/or `parent_folder` are deleted, the signature request will not return in the list.

getSignRequests

public SignRequests getSignRequests(GetSignRequestsQueryParams queryParams)

Gets signature requests created by a user. If the `sign_files` and/or `parent_folder` are deleted, the signature request will not return in the list.

Parameters:

queryParams - Query parameters of getSignRequests method

getSignRequests

public SignRequests getSignRequests(GetSignRequestsHeaders headers)

Gets signature requests created by a user. If the `sign_files` and/or `parent_folder` are deleted, the signature request will not return in the list.

Parameters:

headers - Headers of getSignRequests method

getSignRequests

public SignRequests getSignRequests(GetSignRequestsQueryParams queryParams,
                                    GetSignRequestsHeaders headers)

Gets signature requests created by a user. If the `sign_files` and/or `parent_folder` are deleted, the signature request will not return in the list.

Parameters:

queryParams - Query parameters of getSignRequests method

headers - Headers of getSignRequests method

createSignRequest

public SignRequest createSignRequest(SignRequestCreateRequest requestBody)

Creates a signature request. This involves preparing a document for signing and sending the signature request to signers.

Parameters:

requestBody - Request body of createSignRequest method

createSignRequest

public SignRequest createSignRequest(SignRequestCreateRequest requestBody,
                                     CreateSignRequestHeaders headers)

Creates a signature request. This involves preparing a document for signing and sending the signature request to signers.

Parameters:

requestBody - Request body of createSignRequest method

headers - Headers of createSignRequest method

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()