View Source DocuSign.Api.Notary (DocuSign v1.2.0)

API calls for all endpoints tagged Notary.

Summary

Functions

notary_get_notary(connection, opts \\ [])

Gets settings for a notary user. Gets settings for a notary user. The current user must be a notary.

notary_post_notary(connection, opts \\ [])

Registers the current user as a notary. Registers the current user as a notary.

notary_put_notary(connection, opts \\ [])

Updates notary information for the current user. Updates notary information for the current user.

Functions

Link to this function

notary_get_notary(connection, opts \\ [])

View Source 
@spec notary_get_notary(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.NotaryResult.t()}
  | {:error, Tesla.Env.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 server
  • opts (keyword): Optional parameters
    • :include_jurisdictions (String.t): When true, the response will include a jurisdiction property that contains an array of all supported jurisdictions for the current user.

Returns

  • {:ok, DocuSign.Model.NotaryResult.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

notary_post_notary(connection, opts \\ [])

View Source 
@spec notary_post_notary(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, DocuSign.Model.Notary.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Registers the current user as a notary. Registers the current user as a notary.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :body (Notary):

Returns

  • {:ok, DocuSign.Model.Notary.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

notary_put_notary(connection, opts \\ [])

View Source 
@spec notary_put_notary(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, DocuSign.Model.Notary.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Updates notary information for the current user. Updates notary information for the current user.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :body (Notary):

Returns

  • {:ok, DocuSign.Model.Notary.t} on success
  • {:error, Tesla.Env.t} on failure