DocuSign.Api.AccountCustomFields (DocuSign v3.1.1)

View Source

API calls for all endpoints tagged AccountCustomFields.

Summary

Functions

account_custom_fields_delete_account_custom_fields(connection, account_id, custom_field_id, opts \\ [])

Deletes an account custom field. This method deletes an existing account custom field.

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

Gets a list of custom fields. This method returns a list of the envelope and document custom fields associated with an account.

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

Creates an account custom field. This method creates a custom field and makes it available for all new envelopes associated with an account.

account_custom_fields_put_account_custom_fields(connection, account_id, custom_field_id, opts \\ [])

Updates an account custom field. This method updates an existing account custom field.

Functions

account_custom_fields_delete_account_custom_fields(connection, account_id, custom_field_id, opts \\ [])

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

Deletes an account custom field. This method deletes an existing account custom field.

Parameters

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

Returns

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

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

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

Gets a list of custom fields. This method returns a list of the envelope and document custom fields associated with an account.

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.AccountCustomFields.t} on success
  • {:error, Req.Response.t} on failure

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

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

Creates an account custom field. This method creates a custom field and makes it available for all new envelopes associated with an account.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • opts (keyword): Optional parameters
    • :apply_to_templates (String.t): (Optional) When true, the new custom field is applied to all of the templates on the account.
    • :body (CustomField):

Returns

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

account_custom_fields_put_account_custom_fields(connection, account_id, custom_field_id, opts \\ [])

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

Updates an account custom field. This method updates an existing account custom field.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • custom_field_id (String.t): The ID of the custom field.
  • opts (keyword): Optional parameters
    • :apply_to_templates (String.t):
    • :body (CustomField):

Returns

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