Package com.docusign.esign.api

Class NotaryApi

java.lang.Object

com.docusign.esign.api.NotaryApi

public class NotaryApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	NotaryApi.GetNotaryOptions
class	NotaryApi.ListNotaryJournalsOptions

Constructor Summary

Constructors

Constructor	Description
NotaryApi()
NotaryApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
Notary	createNotary(Notary notary)	Add a notary to the system
NotaryJurisdiction	createNotaryJurisdictions(NotaryJurisdiction notaryJurisdiction)	Add a notary jurisdiction to the system
void	deleteNotaryJurisdiction(String jurisdictionId)	Delete a notary jurisdiction a specified user.
ApiClient	getApiClient()
NotaryResult	getNotary()	Get notary settings for a user
NotaryResult	getNotary(NotaryApi.GetNotaryOptions options)	Get notary settings for a user
NotaryJurisdiction	getNotaryJurisdiction(String jurisdictionId)	Get notary a jurisdiction for a user
NotaryJurisdictionList	getNotaryJurisdictions()	Get notary jurisdictions for a user
void	getNotaryJurisdictionSeal(String jurisdictionId)	Get notary seal for a jurisdiction
NotaryJournalList	listNotaryJournals()	Get notary jurisdictions for a user
NotaryJournalList	listNotaryJournals(NotaryApi.ListNotaryJournalsOptions options)	Get notary jurisdictions for a user
void	setApiClient(ApiClient apiClient)
Notary	updateNotary(Notary notary)	Update a notary
NotaryJurisdiction	updateNotaryJurisdiction(String jurisdictionId, NotaryJurisdiction notaryJurisdiction)	Update a notary jurisdiction

Methods inherited from class java.lang.Object

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

Constructor Detail

NotaryApi

public NotaryApi()

NotaryApi

public NotaryApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createNotary

public Notary createNotary(Notary notary)
                    throws ApiException

Add a notary to the system

Parameters:

notary - (optional)

Returns:

Notary

Throws:

ApiException - if fails to make API call

createNotaryJurisdictions

public NotaryJurisdiction createNotaryJurisdictions(NotaryJurisdiction notaryJurisdiction)
                                             throws ApiException

Add a notary jurisdiction to the system

Parameters:

notaryJurisdiction - (optional)

Returns:

NotaryJurisdiction

Throws:

ApiException - if fails to make API call

deleteNotaryJurisdiction

public void deleteNotaryJurisdiction(String jurisdictionId)
                              throws ApiException

Delete a notary jurisdiction a specified user.

Parameters:

jurisdictionId - (required)

Throws:

ApiException - if fails to make API call

getNotary

public NotaryResult getNotary()
                       throws ApiException

Get notary settings for a user

Returns:

NotaryResult

Throws:

ApiException

getNotary

public NotaryResult getNotary(NotaryApi.GetNotaryOptions options)
                       throws ApiException

Get notary settings for a user

Parameters:

options - for modifying the method behavior.

Returns:

NotaryResult

Throws:

ApiException - if fails to make API call

getNotaryJurisdiction

public NotaryJurisdiction getNotaryJurisdiction(String jurisdictionId)
                                         throws ApiException

Get notary a jurisdiction for a user

Parameters:

jurisdictionId - (required)

Returns:

NotaryJurisdiction

Throws:

ApiException - if fails to make API call

getNotaryJurisdictionSeal

public void getNotaryJurisdictionSeal(String jurisdictionId)
                               throws ApiException

Get notary seal for a jurisdiction

Parameters:

jurisdictionId - (required)

Throws:

ApiException - if fails to make API call

getNotaryJurisdictions

public NotaryJurisdictionList getNotaryJurisdictions()
                                              throws ApiException

Get notary jurisdictions for a user

Returns:

NotaryJurisdictionList

Throws:

ApiException - if fails to make API call

listNotaryJournals

public NotaryJournalList listNotaryJournals()
                                     throws ApiException

Get notary jurisdictions for a user

Returns:

NotaryJournalList

Throws:

ApiException

listNotaryJournals

public NotaryJournalList listNotaryJournals(NotaryApi.ListNotaryJournalsOptions options)
                                     throws ApiException

Get notary jurisdictions for a user

Parameters:

options - for modifying the method behavior.

Returns:

NotaryJournalList

Throws:

ApiException - if fails to make API call

updateNotary

public Notary updateNotary(Notary notary)
                    throws ApiException

Update a notary

Parameters:

notary - (optional)

Returns:

Notary

Throws:

ApiException - if fails to make API call

updateNotaryJurisdiction

public NotaryJurisdiction updateNotaryJurisdiction(String jurisdictionId,
                                                   NotaryJurisdiction notaryJurisdiction)
                                            throws ApiException

Update a notary jurisdiction

Parameters:

jurisdictionId - (required)

notaryJurisdiction - (optional)

Returns:

NotaryJurisdiction

Throws:

ApiException - if fails to make API call