DocuSign.Api.EnvelopeDocumentFields (DocuSign v0.3.3) View Source

API calls for all endpoints tagged EnvelopeDocumentFields.

Link to this section Summary

Functions

Deletes custom document fields from an existing envelope document. Deletes custom document fields from an existing envelope document.

Gets the custom document fields from an existing envelope document. Retrieves the custom document field information from an existing envelope document.

Creates custom document fields in an existing envelope document. Creates custom document fields in an existing envelope document.

Updates existing custom document fields in an existing envelope document. Updates existing custom document fields in an existing envelope document.

Link to this section Functions

Link to this function

document_fields_delete_document_fields(connection, account_id, document_id, envelope_id, opts \\ [])

View Source

Specs

document_fields_delete_document_fields(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, DocuSign.Model.EnvelopeDocumentFields.t()} | {:error, Tesla.Env.t()}

Deletes custom document fields from an existing envelope document. Deletes custom document fields from an existing envelope document.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • document_id (String.t): The ID of the document being accessed.
  • envelope_id (String.t): The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
  • opts (KeywordList): [optional] Optional parameters
    • :envelope_document_fields (EnvelopeDocumentFields):

Returns

} on success {:error, info} on failure

Link to this function

document_fields_get_document_fields(connection, account_id, document_id, envelope_id, opts \\ [])

View Source

Specs

document_fields_get_document_fields(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, DocuSign.Model.EnvelopeDocumentFields.t()} | {:error, Tesla.Env.t()}

Gets the custom document fields from an existing envelope document. Retrieves the custom document field information from an existing envelope document.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • document_id (String.t): The ID of the document being accessed.
  • envelope_id (String.t): The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

document_fields_post_document_fields(connection, account_id, document_id, envelope_id, opts \\ [])

View Source

Specs

document_fields_post_document_fields(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, DocuSign.Model.EnvelopeDocumentFields.t()} | {:error, Tesla.Env.t()}

Creates custom document fields in an existing envelope document. Creates custom document fields in an existing envelope document.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • document_id (String.t): The ID of the document being accessed.
  • envelope_id (String.t): The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
  • opts (KeywordList): [optional] Optional parameters
    • :envelope_document_fields (EnvelopeDocumentFields):

Returns

} on success {:error, info} on failure

Link to this function

document_fields_put_document_fields(connection, account_id, document_id, envelope_id, opts \\ [])

View Source

Specs

document_fields_put_document_fields(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, DocuSign.Model.EnvelopeDocumentFields.t()} | {:error, Tesla.Env.t()}

Updates existing custom document fields in an existing envelope document. Updates existing custom document fields in an existing envelope document.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • document_id (String.t): The ID of the document being accessed.
  • envelope_id (String.t): The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
  • opts (KeywordList): [optional] Optional parameters
    • :envelope_document_fields (EnvelopeDocumentFields):

Returns

} on success {:error, info} on failure