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

API calls for all endpoints tagged PowerForms.

Link to this section Summary

Link to this section Functions

Link to this function

power_forms_delete_power_form(connection, account_id, power_form_id, opts \\ [])

View Source

Specs

power_forms_delete_power_form(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Delete a PowerForm.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • power_form_id (String.t):
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

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

Deletes one or more PowerForms

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters
    • :power_forms_request (PowerFormsRequest):

Returns

} on success {:error, info} on failure

Link to this function

power_forms_get_power_form(connection, account_id, power_form_id, opts \\ [])

View Source

Specs

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

Returns a single PowerForm.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • power_form_id (String.t):
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

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

Returns the list of PowerForms available to the user.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters
    • :from_date (String.t): Start of the search date range. Only returns templates created on or after this date/time. If no value is specified, there is no limit on the earliest date created.
    • :order (String.t): An optional value that sets the direction order used to sort the item list. Valid values are: asc = ascending sort order desc = descending sort order
    • :order_by (String.t): An optional value that sets the file attribute used to sort the item list. Valid values are: modified name
    • :to_date (String.t): End of the search date range. Only returns templates created up to this date/time. If no value is provided, this defaults to the current date.

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

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

Returns the list of PowerForms available to the user.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters
    • :start_position (String.t): The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

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

Creates a new PowerForm.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters
    • :power_forms (PowerForms):

Returns

} on success {:error, info} on failure

Link to this function

power_forms_put_power_form(connection, account_id, power_form_id, opts \\ [])

View Source

Specs

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

Creates a new PowerForm.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • power_form_id (String.t):
  • opts (KeywordList): [optional] Optional parameters
    • :power_forms (PowerForms):

Returns

} on success {:error, info} on failure