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

API calls for all endpoints tagged ConnectConfigurations.

Link to this section Summary

Functions

Deletes the specified connect configuration. Deletes the specified DocuSign Connect configuration. ###### Note: Connect must be enabled for your account to use this function.

Get information on a Connect Configuration Retrieves the information for the specified DocuSign Connect configuration. ###### Note: Connect must be enabled for your account to use this function.

Get Connect Configuration Information Retrieves all the DocuSign Custom Connect definitions for the specified account. ###### Note: Connect must be enabled for your account to use this function. This does not retrieve information for Connect configurations for Box, eOriginal, or Salesforce.

Returns users from the configured Connect service. Returns users from the configured Connect service.

Creates a connect configuration for the specified account. Creates a DocuSign Custom Connect definition for your account. DocuSign Connect enables the sending of real-time data updates to external applications. These updates are generated by user transactions as the envelope progresses through actions to completion. The Connect Service provides updated information about the status of these transactions and returns updates that include the actual content of document form fields. Be aware that, these updates might or might not include the document itself. For more information about Connect, see the [ML:DocuSign Connect Service Guide]. ###### Note: Connect must be enabled for your account to use this function. This cannot be used to set up Connect configurations for Salesforce or eOriginal.

Updates a specified Connect configuration. Updates the specified DocuSign Connect configuration in your account. ###### Note: Connect must be enabled for your account to use this function. This cannot be used to update Connect configurations for Box, eOriginal, or Salesforce.

Link to this section Functions

Link to this function

connect_delete_connect_config(connection, account_id, connect_id, opts \\ [])

View Source

Specs

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

Deletes the specified connect configuration. Deletes the specified DocuSign Connect configuration. ###### Note: Connect must be enabled for your account to use this function.

Parameters

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

Returns

} on success {:error, info} on failure

Link to this function

connect_get_connect_config(connection, account_id, connect_id, opts \\ [])

View Source

Specs

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

Get information on a Connect Configuration Retrieves the information for the specified DocuSign Connect configuration. ###### Note: Connect must be enabled for your account to use this function.

Parameters

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

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

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

Get Connect Configuration Information Retrieves all the DocuSign Custom Connect definitions for the specified account. ###### Note: Connect must be enabled for your account to use this function. This does not retrieve information for Connect configurations for Box, eOriginal, or Salesforce.

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

Returns

} on success {:error, info} on failure

Link to this function

connect_get_connect_users(connection, account_id, connect_id, opts \\ [])

View Source

Specs

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

Returns users from the configured Connect service. Returns users from the configured Connect service.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • connect_id (String.t): The ID of the custom Connect configuration being accessed.
  • opts (KeywordList): [optional] Optional parameters
    • :count (String.t): Optional. Number of items to return.
    • :email_substring (String.t): Filters the returned user records by the email address or a sub-string of email address.
    • :list_included_users (String.t):
    • :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.
    • :status (String.t): Filters the results by user status. You can specify a comma-separated list of the following statuses: ActivationRequired ActivationSent Active Closed * Disabled
    • :user_name_substring (String.t): Filters the user records returned by the user name or a sub-string of user name.

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

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

Creates a connect configuration for the specified account. Creates a DocuSign Custom Connect definition for your account. DocuSign Connect enables the sending of real-time data updates to external applications. These updates are generated by user transactions as the envelope progresses through actions to completion. The Connect Service provides updated information about the status of these transactions and returns updates that include the actual content of document form fields. Be aware that, these updates might or might not include the document itself. For more information about Connect, see the [ML:DocuSign Connect Service Guide]. ###### Note: Connect must be enabled for your account to use this function. This cannot be used to set up Connect configurations for Salesforce or eOriginal.

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
    • :connect_configurations (ConnectConfigurations):

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

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

Updates a specified Connect configuration. Updates the specified DocuSign Connect configuration in your account. ###### Note: Connect must be enabled for your account to use this function. This cannot be used to update Connect configurations for Box, eOriginal, or Salesforce.

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
    • :connect_configurations (ConnectConfigurations):

Returns

} on success {:error, info} on failure