DocuSign.Api.Notary (DocuSign v3.1.1)
View SourceAPI calls for all endpoints tagged Notary.
Summary
Functions
Gets settings for a notary user. Gets settings for a notary user. The current user must be a notary.
Registers the current user as a notary. Registers the current user as a notary.
Updates notary information for the current user. Updates notary information for the current user.
Functions
@spec notary_get_notary( DocuSign.Connection.t(), keyword() ) :: {:ok, DocuSign.Model.NotaryResult.t()} | {:error, Req.Response.t()}
Gets settings for a notary user. Gets settings for a notary user. The current user must be a notary.
Parameters
connection(DocuSign.Connection): Connection to serveropts(keyword): Optional parameters:include_jurisdictions(String.t): When true, the response will include ajurisdictionproperty that contains an array of all supported jurisdictions for the current user.
Returns
{:ok, DocuSign.Model.NotaryResult.t}on success{:error, Req.Response.t}on failure
@spec notary_post_notary( DocuSign.Connection.t(), keyword() ) :: {:ok, DocuSign.Model.Notary.t()} | {:error, Req.Response.t()}
Registers the current user as a notary. Registers the current user as a notary.
Parameters
connection(DocuSign.Connection): Connection to serveropts(keyword): Optional parameters:body(Notary):
Returns
{:ok, DocuSign.Model.Notary.t}on success{:error, Req.Response.t}on failure
@spec notary_put_notary( DocuSign.Connection.t(), keyword() ) :: {:ok, DocuSign.Model.Notary.t()} | {:error, Req.Response.t()}
Updates notary information for the current user. Updates notary information for the current user.
Parameters
connection(DocuSign.Connection): Connection to serveropts(keyword): Optional parameters:body(Notary):
Returns
{:ok, DocuSign.Model.Notary.t}on success{:error, Req.Response.t}on failure