DocuSign.Api.TemplateDocumentFields (DocuSign v0.3.4) View Source

API calls for all endpoints tagged TemplateDocumentFields.

Link to this section Summary

Functions

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

Gets the custom document fields for a an existing template document. Retrieves the custom document fields for an existing template document.

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

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

Link to this section Functions

Link to this function

document_fields_delete_template_document_fields(connection, account_id, document_id, template_id, opts \\ [])

View Source

Specs

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

Deletes custom document fields from an existing template document. Deletes custom document fields from an existing template 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.
  • template_id (String.t): The ID of the template being accessed.
  • opts (KeywordList): [optional] Optional parameters
    • :template_document_fields (TemplateDocumentFields):

Returns

} on success {:error, info} on failure

Link to this function

document_fields_get_template_document_fields(connection, account_id, document_id, template_id, opts \\ [])

View Source

Specs

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

Gets the custom document fields for a an existing template document. Retrieves the custom document fields for an existing template 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.
  • template_id (String.t): The ID of the template being accessed.
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

document_fields_post_template_document_fields(connection, account_id, document_id, template_id, opts \\ [])

View Source

Specs

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

Creates custom document fields in an existing template document. Creates custom document fields in an existing template 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.
  • template_id (String.t): The ID of the template being accessed.
  • opts (KeywordList): [optional] Optional parameters
    • :template_document_fields (TemplateDocumentFields):

Returns

} on success {:error, info} on failure

Link to this function

document_fields_put_template_document_fields(connection, account_id, document_id, template_id, opts \\ [])

View Source

Specs

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

Updates existing custom document fields in an existing template document. Updates existing custom document fields in an existing template 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.
  • template_id (String.t): The ID of the template being accessed.
  • opts (KeywordList): [optional] Optional parameters
    • :template_document_fields (TemplateDocumentFields):

Returns

} on success {:error, info} on failure