com.silanis.esl.sdk.service

Class PackageService

java.lang.Object

com.silanis.esl.sdk.service.PackageService

public class PackageService
extends Object

The PackageService class provides methods to help create packages and download documents after the package is complete.

Constructor Summary

Constructors

Constructor and Description
PackageService(RestClient client, String baseUrl)

Method Summary

Modifier and Type	Method and Description
void	addDocumentWithExternalContent(String packageId, List<Document> providerDocuments) Upload documents with external content to the package.
Role	addRole(PackageId packageId, Role role) Adds a role to the package.
String	addSigner(PackageId packageId, Signer signer) Adds a signer to the specified package
void	archive(PackageId packageId) Archive the specified package.
void	changePackageStatusToDraft(PackageId packageId) Change the package's status to DRAFT.
void	configureDocumentVisibility(PackageId packageId, DocumentVisibility visibility) Configure a document visibility.
PackageId	createPackage(Package aPackage) Creates a package with roles.
PackageId	createPackageFromTemplate(PackageId packageId, Package aPackage) Create a new package based on an existing template.
PackageId	createPackageOneStep(Package aPackage, Collection<Document> documents) Creates a package and uploads the documents in one step
void	deleteDocument(PackageId packageId, String documentId) Deletes the document from the package.
void	deleteDocuments(PackageId packageId, DocumentId... documentIds) Deletes the documents from the package.
void	deletePackage(PackageId packageId) Deletes the specified package.
void	deleteRole(PackageId packageId, Role role) Deletes a role from the package.
CompletionReport	downloadCompletionReport(PackageStatus packageStatus, Date from, Date to) Deprecated. Use the ReportService.downloadCompletionReport(com.silanis.esl.sdk.PackageStatus, java.lang.String, java.util.Date, java.util.Date).
CompletionReport	downloadCompletionReport(PackageStatus packageStatus, String senderId, Date from, Date to) Deprecated. Use the ReportService.downloadCompletionReport(com.silanis.esl.sdk.PackageStatus, java.lang.String, java.util.Date, java.util.Date).
String	downloadCompletionReportAsCSV(PackageStatus packageStatus, Date from, Date to) Deprecated. Use the ReportService.downloadCompletionReportAsCSV(com.silanis.esl.sdk.PackageStatus, java.lang.String, java.util.Date, java.util.Date).
String	downloadCompletionReportAsCSV(PackageStatus packageStatus, String senderId, Date from, Date to) Deprecated. Use the ReportService.downloadCompletionReportAsCSV(com.silanis.esl.sdk.PackageStatus, java.lang.String, java.util.Date, java.util.Date).
byte[]	downloadDocument(PackageId packageId, Document document) Downloads a document from the package and returns a byte[].
byte[]	downloadDocument(PackageId packageId, String documentId)
byte[]	downloadEvidenceSummary(PackageId packageId) Downloads the evidence summary (in PDF) from the package and returns a byte[].
byte[]	downloadOriginalDocument(PackageId packageId, String documentId) Downloads the original document (without fields) from the package and returns a byte[].
UsageReport	downloadUsageReport(Date from, Date to) Deprecated. Use the ReportService.downloadUsageReport(java.util.Date, java.util.Date).
String	downloadUsageReportAsCSV(Date from, Date to) Deprecated. Use the ReportService.downloadUsageReportAsCSV(java.util.Date, java.util.Date).
byte[]	downloadZippedDocuments(PackageId packageId) Downloads the documents (in a zip archive) from the package and returns a byte[].
Package	getApiPackage(String packageId) Gets the package.
SupportConfiguration	getConfig(PackageId packageId) Get package support configuration.
Document	getDocumentMetadata(DocumentPackage documentPackage, String documentId) Get the document's metadata from the package.
List<Document>	getDocuments() Gets the documents from the history list
List<Document>	getDocuments(PackageId packageId, String signerId)
DocumentVisibility	getDocumentVisibility(PackageId packageId) Get a document visibility.
List<NotaryJournalEntry>	getJournalEntries(String userId) Get Journal Entries.
DownloadedFile	getJournalEntriesAsCSV(String userId) Get Journal Entries in csv format.
DocumentPackage	getPackage(PackageId packageId)
Page<DocumentPackage>	getPackages(String status, PageRequest request) Returns a Page of DocumentPackages, which represents a paginated query response.
Page<Map<String,String>>	getPackagesFields(PackageStatus status, PageRequest request, Set<String> fields) Returns a Page of Map, which represents a paginated query response which contains package fields and their values.
ReferencedConditions	getReferencedConditions(String packageId)
ReferencedConditions	getReferencedConditions(String packageId, String documentId)
ReferencedConditions	getReferencedConditions(String packageId, String documentId, String fieldId)
List<Role>	getRoles(PackageId packageId) Gets the roles for a package.
Signer	getSigner(PackageId packageId, String signerId) Get a signer from the specified package
List<Signer>	getSigners(PackageId packageId, String documentId)
SigningStatus	getSigningStatus(PackageId packageId, SignerId signerId, DocumentId documentId) Retrieves the current signing status of the DocumentPackage, Document or Signer specified.
String	getSigningUrl(PackageId packageId, String signerId) Get a signing url
Page<DocumentPackage>	getTemplates(PageRequest request)
Page<DocumentPackage>	getTemplates(PageRequest request, Visibility visibility)
String	getThankYouDialogContent(PackageId packageId) Get thank you dialog content.
Page<DocumentPackage>	getUpdatedPackagesWithinDateRange(PackageStatus status, PageRequest request, Date from, Date to) Returns a Page of DocumentPackages, that last updated in time range, which represents a paginated query response.
void	markComplete(PackageId packageId) Mark complete on the specified package.
void	notifySigner(PackageId packageId, GroupId groupId)
void	notifySigner(PackageId packageId, String signerEmail, String message) Notifies the specified signer by email, including a custom message.
void	orderDocuments(DocumentPackage documentPackage) Updates the documents signing order
void	orderSigners(DocumentPackage documentPackage) Updates the signer order in a package.
void	removeSigner(PackageId packageId, String signerId) Removes a signer from a package
void	restore(PackageId packageId) Restores the specified package.
void	sendPackage(PackageId packageId) Sends the package.
void	sendSmsToSigner(PackageId packageId, Signer signer) Send SMS to the signer.
String	startFastTrack(PackageId packageId, List<FastTrackSigner> signers) Create Fast Track Package.
void	trash(PackageId packageId) Trash the specified package.
void	unlockSigner(PackageId packageId, String signerId) Unlock a signer which has been locked out due to too many failed authentication attempts.
void	updateDocumentMetadata(DocumentPackage documentPackage, Document document) Updates the document's metadata from the package.
void	updatePackage(PackageId packageId, DocumentPackage sdkPackage) Updates the package's fields and roles.
Role	updateRole(PackageId packageId, Role role) Updates a role from the package.
void	updateSigner(PackageId packageId, Signer signer) Updates a signer's information from a package
Document	uploadApiDocument(String packageId, String fileName, byte[] fileBytes, Document document)
Document	uploadDocument(PackageId packageId, String fileName, byte[] fileBytes, Document document) Uploads the Document and file in byte[] to the package.
Document	uploadDocument(PackageId packageId, String fileName, byte[] fileBytes, Document document, DocumentPackage documentPackage) Deprecated. Please use uploadDocument(PackageId packageId, String fileName, byte[] fileBytes, com.silanis.esl.sdk.Document document) instead of this method.
List<Document>	uploadDocuments(String packageId, List<Document> documents)

Methods inherited from class java.lang.Object

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

Constructor Detail

PackageService

public PackageService(RestClient client,
                      String baseUrl)

Method Detail

createPackage

public PackageId createPackage(Package aPackage)
                        throws EslException

Creates a package with roles.

Parameters:

aPackage -

Returns:

PackageId

Throws:

EslException

createPackageOneStep

public PackageId createPackageOneStep(Package aPackage,
                                      Collection<Document> documents)
                               throws EslException

Creates a package and uploads the documents in one step

Parameters:

aPackage -

documents -

Returns:

Throws:

EslException

createPackageFromTemplate

public PackageId createPackageFromTemplate(PackageId packageId,
                                           Package aPackage)

Create a new package based on an existing template.

Parameters:

packageId -

aPackage -

Returns:

PackageId

updatePackage

public void updatePackage(PackageId packageId,
                          DocumentPackage sdkPackage)
                   throws EslException

Updates the package's fields and roles.

Parameters:

packageId -

sdkPackage -

Throws:

EslException

changePackageStatusToDraft

public void changePackageStatusToDraft(PackageId packageId)
                                throws EslException

Change the package's status to DRAFT.

Parameters:

packageId -

Throws:

EslException

configureDocumentVisibility

public void configureDocumentVisibility(PackageId packageId,
                                        DocumentVisibility visibility)
                                 throws EslException

Configure a document visibility.

Parameters:

packageId -

visibility - the document visibility

Throws:

EslException

getDocumentVisibility

public DocumentVisibility getDocumentVisibility(PackageId packageId)
                                         throws EslException

Get a document visibility.

Parameters:

packageId -

Throws:

EslException

getPackage

public DocumentPackage getPackage(PackageId packageId)

getDocuments

public List<Document> getDocuments(PackageId packageId,
                                   String signerId)

getSigners

public List<Signer> getSigners(PackageId packageId,
                               String documentId)

getApiPackage

public Package getApiPackage(String packageId)
                      throws EslException

Gets the package.

Parameters:

packageId -

Returns:

Package

Throws:

EslException

uploadDocument

@Deprecated
public Document uploadDocument(PackageId packageId,
                                           String fileName,
                                           byte[] fileBytes,
                                           Document document,
                                           DocumentPackage documentPackage)
                                    throws EslException

Deprecated. Please use uploadDocument(PackageId packageId, String fileName, byte[] fileBytes, com.silanis.esl.sdk.Document document) instead of this method.

Throws:

EslException

uploadDocument

public Document uploadDocument(PackageId packageId,
                               String fileName,
                               byte[] fileBytes,
                               Document document)
                        throws EslException

Uploads the Document and file in byte[] to the package.

Parameters:

packageId -

fileName - Name of the file

fileBytes - The file to upload in bytes

document - The document with approvals and fields

Throws:

EslException

uploadApiDocument

public Document uploadApiDocument(String packageId,
                                  String fileName,
                                  byte[] fileBytes,
                                  Document document)

uploadDocuments

public List<Document> uploadDocuments(String packageId,
                                      List<Document> documents)

deleteDocument

public void deleteDocument(PackageId packageId,
                           String documentId)
                    throws EslException

Deletes the document from the package.

Parameters:

packageId -

documentId -

Throws:

EslException

deleteDocuments

public void deleteDocuments(PackageId packageId,
                            DocumentId... documentIds)
                     throws EslException

Deletes the documents from the package.

Parameters:

packageId -

documentIds -

Throws:

EslException

getDocumentMetadata

public Document getDocumentMetadata(DocumentPackage documentPackage,
                                    String documentId)

Get the document's metadata from the package.

Parameters:

documentPackage - The DocumentPackage we want to get document from.

documentId - Id of document to get.

Returns:

the document's metadata

updateDocumentMetadata

public void updateDocumentMetadata(DocumentPackage documentPackage,
                                   Document document)

Updates the document's metadata from the package.

Parameters:

documentPackage -

document -

orderDocuments

public void orderDocuments(DocumentPackage documentPackage)

Updates the documents signing order

Parameters:

documentPackage -

addDocumentWithExternalContent

public void addDocumentWithExternalContent(String packageId,
                                           List<Document> providerDocuments)

Upload documents with external content to the package.

Parameters:

packageId -

getDocuments

public List<Document> getDocuments()

Gets the documents from the history list

Returns:

sendPackage

public void sendPackage(PackageId packageId)
                 throws EslException

Sends the package.

Parameters:

packageId -

Throws:

EslException

getRoles

public List<Role> getRoles(PackageId packageId)
                    throws EslException

Gets the roles for a package.

Parameters:

packageId -

Returns:

A list of the roles in the package

Throws:

EslException

addRole

public Role addRole(PackageId packageId,
                    Role role)
             throws EslException

Adds a role to the package.

Parameters:

packageId -

role -

Returns:

The role added

Throws:

EslException

updateRole

public Role updateRole(PackageId packageId,
                       Role role)
                throws EslException

Updates a role from the package.

Parameters:

packageId -

role -

Returns:

The updated role

Throws:

EslException

deleteRole

public void deleteRole(PackageId packageId,
                       Role role)
                throws EslException

Deletes a role from the package.

Parameters:

packageId -

role -

Throws:

EslException

downloadDocument

public byte[] downloadDocument(PackageId packageId,
                               Document document)
                        throws EslException

Downloads a document from the package and returns a byte[].

Parameters:

packageId - Id of the DocumentPackage we want to download

document - Id of the Document we want to download

Returns:

The document in bytes

Throws:

EslException

downloadDocument

public byte[] downloadDocument(PackageId packageId,
                               String documentId)
                        throws EslException

Throws:

EslException

downloadOriginalDocument

public byte[] downloadOriginalDocument(PackageId packageId,
                                       String documentId)
                                throws EslException

Downloads the original document (without fields) from the package and returns a byte[].

Parameters:

packageId - Id of the DocumentPackage we want to download

documentId - Id of the Document we want to download

Returns:

The original document in bytes

Throws:

EslException

downloadZippedDocuments

public byte[] downloadZippedDocuments(PackageId packageId)
                               throws EslException

Downloads the documents (in a zip archive) from the package and returns a byte[].

Parameters:

packageId - Id of the DocumentPackage we want to download

Returns:

The zipped documents in bytes

Throws:

EslException

downloadEvidenceSummary

public byte[] downloadEvidenceSummary(PackageId packageId)
                               throws EslException

Downloads the evidence summary (in PDF) from the package and returns a byte[].

Parameters:

packageId -

Returns:

The evidence summary in bytes

Throws:

EslException

getSigningStatus

public SigningStatus getSigningStatus(PackageId packageId,
                                      SignerId signerId,
                                      DocumentId documentId)

Retrieves the current signing status of the DocumentPackage, Document or Signer specified.

Parameters:

packageId - Id of the DocumentPackage who's status we are to retrieve

signerId - If not null, the id of the signer who's status we are to retrieve

documentId - If not null, the id of the document who's status we are to retrieve

Returns:

One of the following values: INACTIVE - process is not active COMPLETE - process has been completed ARCHIVED - process has been archived SIGNING-PENDING - process is active, but not all signatures have been added SIGNING-COMPLETE - process is active, all signaures have been added

getPackages

public Page<DocumentPackage> getPackages(String status,
                                         PageRequest request)

Returns a Page of DocumentPackages, which represents a paginated query response. Important once you have many DocumentPackages.

Parameters:

status - Returned DocumentPackages must have their status set to this value to be included in the result set

ownerUserId -

ownerEmail -

request - Identifying which page of results to return

Returns:

List of DocumentPackages that populate the specified page

getPackagesFields

public Page<Map<String,String>> getPackagesFields(PackageStatus status,
                                                  PageRequest request,
                                                  Set<String> fields)

Returns a Page of Map, which represents a paginated query response which contains package fields and their values.

Parameters:

status - Packages must have their status set to this value to be included in the result set

request - Identifying which page of results to return

fields - Identifying which package fields to return

Returns:

List of Map that populate the specified page which contains fields and their values

getUpdatedPackagesWithinDateRange

public Page<DocumentPackage> getUpdatedPackagesWithinDateRange(PackageStatus status,
                                                               PageRequest request,
                                                               Date from,
                                                               Date to)

Returns a Page of DocumentPackages, that last updated in time range, which represents a paginated query response. Important once you have many DocumentPackages.

Parameters:

status - Returned DocumentPackages must have their status set to this value to be included in the result set

request - Identifying which page of results to return

from - Date range starting from this date included

to - Date range ending of this date included

Returns:

List of DocumentPackages that populate the specified page

deletePackage

public void deletePackage(PackageId packageId)

Deletes the specified package.

Parameters:

packageId - The id of the package to be deleted

restore

public void restore(PackageId packageId)

Restores the specified package.

Parameters:

packageId - The id of the package to be restored

trash

public void trash(PackageId packageId)

Trash the specified package.

Parameters:

packageId - The id of the package to be trashed

archive

public void archive(PackageId packageId)

Archive the specified package.

Parameters:

packageId - The id of the package to be archived

markComplete

public void markComplete(PackageId packageId)

Mark complete on the specified package.

Parameters:

packageId - The id of the package to be marked complete on

notifySigner

public void notifySigner(PackageId packageId,
                         String signerEmail,
                         String message)

Notifies the specified signer by email, including a custom message.

Parameters:

packageId - The id of the package containing the signer to be notified

signerEmail - The email of the signer to be notified

message - The custom message to be included in the email sent as notification to the signer

notifySigner

public void notifySigner(PackageId packageId,
                         GroupId groupId)

getTemplates

public Page<DocumentPackage> getTemplates(PageRequest request)

getTemplates

public Page<DocumentPackage> getTemplates(PageRequest request,
                                          Visibility visibility)

addSigner

public String addSigner(PackageId packageId,
                        Signer signer)

Adds a signer to the specified package

Parameters:

packageId - The id of the package in which the signer will be added

signer - The signer to be added

Returns:

The role id of the signer

getSigner

public Signer getSigner(PackageId packageId,
                        String signerId)

Get a signer from the specified package

Parameters:

packageId - The id of the package in which to get the signer

signerId - The id of signer to get

Returns:

The signer

removeSigner

public void removeSigner(PackageId packageId,
                         String signerId)

Removes a signer from a package

Parameters:

packageId - The id of the package containing the signer to be deleted

signerId - The role id of the signer to be deleted

orderSigners

public void orderSigners(DocumentPackage documentPackage)

Updates the signer order in a package.

Parameters:

documentPackage - The id of the package to update signer order

updateSigner

public void updateSigner(PackageId packageId,
                         Signer signer)

Updates a signer's information from a package

Parameters:

packageId - The id of the package containing the signer to be updated

signer - The signer with the updated information

unlockSigner

public void unlockSigner(PackageId packageId,
                         String signerId)

Unlock a signer which has been locked out due to too many failed authentication attempts.

Parameters:

signerId - If not null, the id of the signer who's status we are to retrieve

downloadCompletionReport

@Deprecated
public CompletionReport downloadCompletionReport(PackageStatus packageStatus,
                                                             String senderId,
                                                             Date from,
                                                             Date to)

Deprecated. Use the ReportService.downloadCompletionReport(com.silanis.esl.sdk.PackageStatus, java.lang.String, java.util.Date, java.util.Date).

downloadCompletionReportAsCSV

@Deprecated
public String downloadCompletionReportAsCSV(PackageStatus packageStatus,
                                                        String senderId,
                                                        Date from,
                                                        Date to)

Deprecated. Use the ReportService.downloadCompletionReportAsCSV(com.silanis.esl.sdk.PackageStatus, java.lang.String, java.util.Date, java.util.Date).

downloadCompletionReport

@Deprecated
public CompletionReport downloadCompletionReport(PackageStatus packageStatus,
                                                             Date from,
                                                             Date to)

Deprecated. Use the ReportService.downloadCompletionReport(com.silanis.esl.sdk.PackageStatus, java.lang.String, java.util.Date, java.util.Date).

downloadCompletionReportAsCSV

@Deprecated
public String downloadCompletionReportAsCSV(PackageStatus packageStatus,
                                                        Date from,
                                                        Date to)

Deprecated. Use the ReportService.downloadCompletionReportAsCSV(com.silanis.esl.sdk.PackageStatus, java.lang.String, java.util.Date, java.util.Date).

downloadUsageReport

@Deprecated
public UsageReport downloadUsageReport(Date from,
                                                   Date to)

Deprecated. Use the ReportService.downloadUsageReport(java.util.Date, java.util.Date).

downloadUsageReportAsCSV

@Deprecated
public String downloadUsageReportAsCSV(Date from,
                                                   Date to)

Deprecated. Use the ReportService.downloadUsageReportAsCSV(java.util.Date, java.util.Date).

getSigningUrl

public String getSigningUrl(PackageId packageId,
                            String signerId)

Get a signing url

Parameters:

packageId - The id of the package in which to get the signing url

signerId - The id of signer to get the signing url

Returns:

The signing url

startFastTrack

public String startFastTrack(PackageId packageId,
                             List<FastTrackSigner> signers)

Create Fast Track Package.

Parameters:

packageId - The id of the package to start FastTrack

signers - The signers to get the signing url

Returns:

The signing url

sendSmsToSigner

public void sendSmsToSigner(PackageId packageId,
                            Signer signer)

Send SMS to the signer.

Parameters:

packageId - The id of the package to start FastTrack

signer - The signers to get the signing url

getJournalEntries

public List<NotaryJournalEntry> getJournalEntries(String userId)

Get Journal Entries.

Parameters:

userId - The ID of the user whose e-journal entries are being retrieved.

Returns:

all of the user's notary e-journal entries.

getJournalEntriesAsCSV

public DownloadedFile getJournalEntriesAsCSV(String userId)

Get Journal Entries in csv format.

Parameters:

userId - The ID of the user whose e-journal entries are being retrieved.

Returns:

all of the user's notary e-journal entries in csv format.

getThankYouDialogContent

public String getThankYouDialogContent(PackageId packageId)

Get thank you dialog content.

Parameters:

packageId - The id of the package to get thank you dialog content.

Returns:

thank you dialog content

getConfig

public SupportConfiguration getConfig(PackageId packageId)

Get package support configuration.

Parameters:

packageId - The id of the package to get package support configuration.

Returns:

package support configuration

getReferencedConditions

public ReferencedConditions getReferencedConditions(String packageId)

Parameters:

packageId - Package ID

Returns:

Conditions referenced to the provided packageId.

getReferencedConditions

public ReferencedConditions getReferencedConditions(String packageId,
                                                    String documentId)

Parameters:

packageId - Package ID

documentId - document to be filtered by

Returns:

Conditions referenced to the provided packageId filtered by documentId.

getReferencedConditions

public ReferencedConditions getReferencedConditions(String packageId,
                                                    String documentId,
                                                    String fieldId)

Parameters:

packageId - Package ID

documentId - document to be filtered by

fieldId - field to be filtered by

Returns:

Conditions referenced to the provided packageId filtered by document and field ID.