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

API calls for all endpoints tagged TemplateCustomFields.

Link to this section Summary

Functions

Deletes envelope custom fields in a template. Deletes envelope custom fields in a template.

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

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

Updates envelope custom fields in a template. Updates the custom fields in a template. Each custom field used in a template must have a unique name.

Link to this section Functions

Link to this function

custom_fields_delete_template_custom_fields(connection, account_id, template_id, opts \\ [])

View Source

Specs

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

Deletes envelope custom fields in a template. Deletes envelope custom fields in a template.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • template_id (String.t): The ID of the template being accessed.
  • opts (KeywordList): [optional] Optional parameters
    • :template_custom_fields (TemplateCustomFields):

Returns

} on success {:error, info} on failure

Link to this function

custom_fields_get_template_custom_fields(connection, account_id, template_id, opts \\ [])

View Source

Specs

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

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

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • 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

custom_fields_post_template_custom_fields(connection, account_id, template_id, opts \\ [])

View Source

Specs

custom_fields_post_template_custom_fields(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, DocuSign.Model.TemplateCustomFields.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.
  • template_id (String.t): The ID of the template being accessed.
  • opts (KeywordList): [optional] Optional parameters
    • :template_custom_fields (TemplateCustomFields):

Returns

} on success {:error, info} on failure

Link to this function

custom_fields_put_template_custom_fields(connection, account_id, template_id, opts \\ [])

View Source

Specs

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

Updates envelope custom fields in a template. Updates the custom fields in a template. Each custom field used in a template must have a unique name.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • template_id (String.t): The ID of the template being accessed.
  • opts (KeywordList): [optional] Optional parameters
    • :template_custom_fields (TemplateCustomFields):

Returns

} on success {:error, info} on failure