DocuSign.Api.ENoteConfigurations (DocuSign v3.1.1)

View Source

API calls for all endpoints tagged ENoteConfigurations.

Summary

Functions

e_note_configuration_delete_e_note_configuration(connection, account_id, opts \\ [])

Deletes configuration information for the eNote eOriginal integration.

e_note_configuration_get_e_note_configuration(connection, account_id, opts \\ [])

Returns the configuration information for the eNote eOriginal integration.

e_note_configuration_put_e_note_configuration(connection, account_id, opts \\ [])

Updates configuration information for the eNote eOriginal integration.

Functions

e_note_configuration_delete_e_note_configuration(connection, account_id, opts \\ [])

@spec e_note_configuration_delete_e_note_configuration(
  DocuSign.Connection.t(),
  String.t(),
  keyword()
) ::
  {:ok, nil} | {:error, Req.Response.t()}

Deletes configuration information for the eNote eOriginal integration.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Req.Response.t} on failure

e_note_configuration_get_e_note_configuration(connection, account_id, opts \\ [])

@spec e_note_configuration_get_e_note_configuration(
  DocuSign.Connection.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.ENoteConfiguration.t()} | {:error, Req.Response.t()}

Returns the configuration information for the eNote eOriginal integration.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • opts (keyword): Optional parameters

Returns

  • {:ok, DocuSign.Model.ENoteConfiguration.t} on success
  • {:error, Req.Response.t} on failure

e_note_configuration_put_e_note_configuration(connection, account_id, opts \\ [])

@spec e_note_configuration_put_e_note_configuration(
  DocuSign.Connection.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.ENoteConfiguration.t()} | {:error, Req.Response.t()}

Updates configuration information for the eNote eOriginal integration.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • opts (keyword): Optional parameters
    • :body (ENoteConfiguration):

Returns

  • {:ok, DocuSign.Model.ENoteConfiguration.t} on success
  • {:error, Req.Response.t} on failure