com.box.sdkgen.schemas.signrequest

Class SignRequest

Object

NullableFieldTracker

SerializableObject

SignRequestBase

SignRequest

All Implemented Interfaces:

Serializable

public class SignRequest
extends SignRequestBase

A Box Sign request object.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SignRequest.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected OffsetDateTime	autoExpireAt Uses `days_valid` to calculate the date and time, in GMT, the sign request will expire if unsigned.
protected String	collaboratorLevel The collaborator level of the user to the sign request.
protected OffsetDateTime	createdAt Timestamp marking when the sign request was created.
protected OffsetDateTime	finishedAt Timestamp indicating when all signing actions completed.
protected String	id Box Sign request ID.
protected FolderMini	parentFolder
protected String	prepareUrl This URL is returned if `is_document_preparation_needed` is set to `true` in the request.
protected String	senderEmail The email address of the sender of the sign request.
protected Long	senderId The user ID of the sender of the sign request.
protected String	shortId Short identifier for the sign request.
protected String	signatureColor Force a specific color for the signature (blue, black, or red).
protected List<SignRequestSigner>	signers Array of signers for the signature request.
protected SignRequestSignFilesField	signFiles List of files that will be signed, which are copies of the original source files.
protected FileMini	signingLog
protected List<FileBase>	sourceFiles List of files to create a signing document from.
protected EnumWrapper<SignRequestStatusField>	status Describes the status of the signature request.
protected EnumWrapper<SignRequestTypeField>	type The value will always be `sign-request`.

Fields inherited from class SignRequestBase

areRemindersEnabled, areTextSignaturesEnabled, daysValid, declinedRedirectUrl, emailMessage, emailSubject, externalId, externalSystemName, isDocumentPreparationNeeded, name, prefillTags, redirectUrl, templateId

Fields inherited from class NullableFieldTracker

explicitlySetNullableFields

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
OffsetDateTime	getAutoExpireAt()
String	getCollaboratorLevel()
OffsetDateTime	getCreatedAt()
OffsetDateTime	getFinishedAt()
String	getId()
FolderMini	getParentFolder()
String	getPrepareUrl()
String	getSenderEmail()
Long	getSenderId()
String	getShortId()
String	getSignatureColor()
List<SignRequestSigner>	getSigners()
SignRequestSignFilesField	getSignFiles()
FileMini	getSigningLog()
List<FileBase>	getSourceFiles()
EnumWrapper<SignRequestStatusField>	getStatus()
EnumWrapper<SignRequestTypeField>	getType()
int	hashCode()
String	toString()

Methods inherited from class SignRequestBase

getAreRemindersEnabled, getAreTextSignaturesEnabled, getDaysValid, getDeclinedRedirectUrl, getEmailMessage, getEmailSubject, getExternalId, getExternalSystemName, getIsDocumentPreparationNeeded, getName, getPrefillTags, getRedirectUrl, getTemplateId

Methods inherited from class SerializableObject

getRawData, setRawData

Methods inherited from class NullableFieldTracker

getExplicitlySetNullableFields, isFieldExplicitlySet, markNullableFieldAsSet, markNullableFieldsAsSet

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

type

protected EnumWrapper<SignRequestTypeField> type

The value will always be `sign-request`.

sourceFiles

protected List<FileBase> sourceFiles

List of files to create a signing document from. This is currently limited to ten files. Only the ID and type fields are required for each file.

signers

protected List<SignRequestSigner> signers

Array of signers for the signature request.

signatureColor

protected String signatureColor

Force a specific color for the signature (blue, black, or red).

id

protected String id

Box Sign request ID.

prepareUrl

protected String prepareUrl

This URL is returned if `is_document_preparation_needed` is set to `true` in the request. The parameter is used to prepare the signature request using the UI. The signature request is not sent until the preparation phase is complete.

signingLog

protected FileMini signingLog

status

protected EnumWrapper<SignRequestStatusField> status

Describes the status of the signature request.

signFiles

protected SignRequestSignFilesField signFiles

List of files that will be signed, which are copies of the original source files. A new version of these files are created as signers sign and can be downloaded at any point in the signing process.

autoExpireAt

protected OffsetDateTime autoExpireAt

Uses `days_valid` to calculate the date and time, in GMT, the sign request will expire if unsigned.

parentFolder

protected FolderMini parentFolder

collaboratorLevel

protected String collaboratorLevel

The collaborator level of the user to the sign request. Values can include "owner", "editor", and "viewer".

shortId

protected String shortId

Short identifier for the sign request.

createdAt

protected OffsetDateTime createdAt

Timestamp marking when the sign request was created.

finishedAt

protected OffsetDateTime finishedAt

Timestamp indicating when all signing actions completed.

senderEmail

protected String senderEmail

The email address of the sender of the sign request.

senderId

protected Long senderId

The user ID of the sender of the sign request.

Constructor Detail

SignRequest

public SignRequest()

SignRequest

protected SignRequest(SignRequest.Builder builder)

Method Detail

getType

public EnumWrapper<SignRequestTypeField> getType()

getSourceFiles

public List<FileBase> getSourceFiles()

getSigners

public List<SignRequestSigner> getSigners()

getSignatureColor

public String getSignatureColor()

getId

public String getId()

getPrepareUrl

public String getPrepareUrl()

getSigningLog

public FileMini getSigningLog()

getStatus

public EnumWrapper<SignRequestStatusField> getStatus()

getSignFiles

public SignRequestSignFilesField getSignFiles()

getAutoExpireAt

public OffsetDateTime getAutoExpireAt()

getParentFolder

public FolderMini getParentFolder()

getCollaboratorLevel

public String getCollaboratorLevel()

getShortId

public String getShortId()

getCreatedAt

public OffsetDateTime getCreatedAt()

getFinishedAt

public OffsetDateTime getFinishedAt()

getSenderEmail

public String getSenderEmail()

getSenderId

public Long getSenderId()

equals

public boolean equals(Object o)

Overrides:

equals in class SignRequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class SignRequestBase

toString

public String toString()

Overrides:

toString in class SignRequestBase