View Source DocuSign.Api.ConnectConfigurations (DocuSign v1.2.0)

API calls for all endpoints tagged ConnectConfigurations.

Summary

Functions

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

Deletes the specified Connect configuration. Deletes the specified DocuSign Connect configuration. Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

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

Returns all users from the configured Connect service. Returns all users from the configured Connect service. Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

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

Gets the details about a Connect configuration. Retrieves the information for the specified DocuSign Connect configuration. Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

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

Get Connect configuration information. Retrieves all the DocuSign Custom Connect definitions for the specified account. Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

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

Returns users from the configured Connect service. Returns users from the configured Connect service. Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

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

Delete the Connect OAuth configuration. Deletes the Connect OAuth configuration for the specified account. Note: To use this function, you must be an account administrator and Connect must be enabled on your account. ## Related topics: - OAuth for DocuSign Connect

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

Retrieves the Connect OAuth information for the account. Gets the Connect OAuth configuration for the specified account. Note: To use this function, you must be an account administrator and Connect must be enabled on your account. ## Related topics: - OAuth for DocuSign Connect

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

Set up Connect OAuth for the specified account. Sets up Connect OAuth for the specified account using an authorization server of your choice. To use this endpoint, get the client ID and client secret from your authorization server. When you call this endpoint, DocuSign requests an access token from your authorization server. DocuSign will use that token in the Authorization HTTP header of your account's Connect messages. Finally, your listener will be responsible for validating the token by calling the authorization server. Note: To use this function, you must be an account administrator and Connect must be enabled on your account. ## Related topics: - OAuth for DocuSign Connect

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

Updates the existing Connect OAuth configuration for the account.

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

Creates a Connect configuration. Creates a custom Connect configuration for the specified account. Connect is a webhook service that provides updates when certain events occur in your eSignature workflows. You can use this endpoint to create: Account-level Connect configurations to listen for events related to any envelopes sent by one or more account users Recipient Connect configurations that are triggered when one or more of your account users receive an envelope To set an account-level configuration, set configurationType to custom. To set a Recipient Connect configuration, set configurationType to customrecipient. If you want to listen for events on only one envelope, use the eventNotification object instead. Note: To use this function, you must be an account administrator and Connect must be enabled on your account. ## Data models There are four possible data models for your Connect configuration. Consider: Do you want the data in JSON or XML? Do you want events sent individually (SIM) or in aggregate? DocuSign recommends using the JSON SIM event model. <ds-column> <ds-step open="false" hideIcon="true"> <h3>JSON SIM (Recommended)</h3> <div> Set deliveryMode to SIM and eventData.version to restv2.1. Use the events property to set the event statuses that will trigger your configuration. The following sample request shows how to create an envelope-level configuration using JSON SIM: { "configurationType": "custom", "urlToPublishTo": "YOUR-WEBHOOK-URL", "allUsers": "true", "name": "jsonSimTest", "deliveryMode": "SIM", "allowEnvelopePublish": "true", "enableLog": "true", "eventData": { "version": "restv2.1" }, "events": [ "envelope-sent", "envelope-delivered", "envelope-completed" ] } The following sample request shows how to create a Recipient Connect configuration using JSON SIM: { "configurationType": "customrecipient", "urlToPublishTo": "YOUR-WEBHOOK-URL", "allUsers": "true", "name": "jsonSimTest", "deliveryMode": "SIM", "allowEnvelopePublish": "true", "enableLog": "true", "eventData": { "version": "restv2.1" }, "events": [ "recipient-sent", "recipient-completed" ] } </div></ds-step> <ds-step open="false" hideIcon="true"> <h3>JSON Aggregate</h3> <div> Set deliveryMode to aggregate and eventData.version to restv2.1. Use the envelopeEvents or recipientEvents property to set the event statuses that will trigger your configuration. </div></ds-step> <ds-step open="false" hideIcon="true"> <h3>XML Aggregate</h3> <div> Set deliveryMode to aggregate. Use the envelopeEvents or recipientEvents property to set the event statuses that will trigger your configuration. </div></ds-step> <ds-step open="false" hideIcon="true"> <h3>XML SIM (Legacy apps only)</h3> <div> Note: This model will be deprecated. Set deliveryMode to SIM. Use the envelopeEvents or recipientEvents property to set the event statuses that will trigger your configuration. </div></ds-step> </ds-column> ## Troubleshooting If your configuration is not working, check the following. Connect must be enabled for your account to use this function. If you are using envelopeEvents or recipientEvents, make sure that the event values are sentence case, not lowercase. Make sure you have either set allUsers to true or set userIds to a non-empty array of IDs. By default, this endpoint creates a disabled configuration. To enable the configuration immediately, set the body parameter allowEnvelopePublish to true. You can also enable the configuration in the UI. To check if events are being emitted, set enableLog to true to view event logs in the Connect console. ## Related topics For more information about Connect, see the DocuSign Connect guide. * Use the MyAPICalls sample app to see an example of this endpoint using the JSON SIM model.

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

Updates a specified Connect configuration. Updates the specified DocuSign Connect configuration in your account. To enable the configuration, set the allowEnvelopePublish property to true. After any updates, test your configuration to make sure it works as expected. Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

Functions

Link to this function

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

View Source 
@spec connect_delete_connect_config(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, nil} | {:ok, DocuSign.Model.ErrorDetails.t()} | {:error, Tesla.Env.t()}

Deletes the specified Connect configuration. Deletes the specified DocuSign Connect configuration. Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

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 (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

View Source 
@spec connect_get_connect_all_users(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.IntegratedConnectUserInfoList.t()}
  | {:error, Tesla.Env.t()}

Returns all users from the configured Connect service. Returns all users from the configured Connect service. Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

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 (keyword): Optional parameters
    • :count (String.t): The maximum number of results to return.
    • :domain_users_only (String.t):
    • :email_substring (String.t): Filters returned user records by full email address or a substring of email address.
    • :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): The status of the item.
    • :user_name_substring (String.t): Filters results based on a full or partial user name. Note: When you enter a partial user name, you do not use a wildcard character.

Returns

  • {:ok, DocuSign.Model.IntegratedConnectUserInfoList.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

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

Gets the details about a Connect configuration. Retrieves the information for the specified DocuSign Connect configuration. Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

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 (keyword): Optional parameters

Returns

  • {:ok, DocuSign.Model.ConnectConfigResults.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

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

Get Connect configuration information. Retrieves all the DocuSign Custom Connect definitions for the specified account. Note: To use this function, you must be an account administrator and Connect must be enabled on your 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.ConnectConfigResults.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

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

Returns users from the configured Connect service. Returns users from the configured Connect service. Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

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 (keyword): Optional parameters
    • :count (String.t): The maximum number of results to return. Use start_position to specify the number of results to skip.
    • :email_substring (String.t): Filters returned user records by full email address or a substring of email address.
    • :list_included_users (String.t):
    • :start_position (String.t): The zero-based index of the result from which to start returning results. Use with count to limit the number of results. The default value is 0.
    • :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 results based on a full or partial user name. Note: When you enter a partial user name, you do not use a wildcard character.

Returns

  • {:ok, DocuSign.Model.IntegratedUserInfoList.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

View Source 
@spec connect_o_auth_config_delete_connect_o_auth_config(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, nil} | {:ok, DocuSign.Model.ErrorDetails.t()} | {:error, Tesla.Env.t()}

Delete the Connect OAuth configuration. Deletes the Connect OAuth configuration for the specified account. Note: To use this function, you must be an account administrator and Connect must be enabled on your account. ## Related topics: - OAuth for DocuSign Connect

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, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

View Source 
@spec connect_o_auth_config_get_connect_o_auth_config(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.ConnectOAuthConfig.t()}
  | {:error, Tesla.Env.t()}

Retrieves the Connect OAuth information for the account. Gets the Connect OAuth configuration for the specified account. Note: To use this function, you must be an account administrator and Connect must be enabled on your account. ## Related topics: - OAuth for DocuSign Connect

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.ConnectOAuthConfig.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

View Source 
@spec connect_o_auth_config_post_connect_o_auth_config(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.ConnectOAuthConfig.t()}
  | {:error, Tesla.Env.t()}

Set up Connect OAuth for the specified account. Sets up Connect OAuth for the specified account using an authorization server of your choice. To use this endpoint, get the client ID and client secret from your authorization server. When you call this endpoint, DocuSign requests an access token from your authorization server. DocuSign will use that token in the Authorization HTTP header of your account's Connect messages. Finally, your listener will be responsible for validating the token by calling the authorization server. Note: To use this function, you must be an account administrator and Connect must be enabled on your account. ## Related topics: - OAuth for DocuSign Connect

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • opts (keyword): Optional parameters
    • :body (ConnectOAuthConfig):

Returns

  • {:ok, DocuSign.Model.ConnectOAuthConfig.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

View Source 
@spec connect_o_auth_config_put_connect_o_auth_config(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.ConnectOAuthConfig.t()}
  | {:error, Tesla.Env.t()}

Updates the existing Connect OAuth configuration for the 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
    • :body (ConnectOAuthConfig):

Returns

  • {:ok, DocuSign.Model.ConnectOAuthConfig.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

View Source 
@spec connect_post_connect_configuration(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.ConnectCustomConfiguration.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Creates a Connect configuration. Creates a custom Connect configuration for the specified account. Connect is a webhook service that provides updates when certain events occur in your eSignature workflows. You can use this endpoint to create: Account-level Connect configurations to listen for events related to any envelopes sent by one or more account users Recipient Connect configurations that are triggered when one or more of your account users receive an envelope To set an account-level configuration, set configurationType to custom. To set a Recipient Connect configuration, set configurationType to customrecipient. If you want to listen for events on only one envelope, use the eventNotification object instead. Note: To use this function, you must be an account administrator and Connect must be enabled on your account. ## Data models There are four possible data models for your Connect configuration. Consider: Do you want the data in JSON or XML? Do you want events sent individually (SIM) or in aggregate? DocuSign recommends using the JSON SIM event model. <ds-column> <ds-step open="false" hideIcon="true"> <h3>JSON SIM (Recommended)</h3> <div> Set deliveryMode to SIM and eventData.version to restv2.1. Use the events property to set the event statuses that will trigger your configuration. The following sample request shows how to create an envelope-level configuration using JSON SIM: { "configurationType": "custom", "urlToPublishTo": "YOUR-WEBHOOK-URL", "allUsers": "true", "name": "jsonSimTest", "deliveryMode": "SIM", "allowEnvelopePublish": "true", "enableLog": "true", "eventData": { "version": "restv2.1" }, "events": [ "envelope-sent", "envelope-delivered", "envelope-completed" ] } The following sample request shows how to create a Recipient Connect configuration using JSON SIM: { "configurationType": "customrecipient", "urlToPublishTo": "YOUR-WEBHOOK-URL", "allUsers": "true", "name": "jsonSimTest", "deliveryMode": "SIM", "allowEnvelopePublish": "true", "enableLog": "true", "eventData": { "version": "restv2.1" }, "events": [ "recipient-sent", "recipient-completed" ] } </div></ds-step> <ds-step open="false" hideIcon="true"> <h3>JSON Aggregate</h3> <div> Set deliveryMode to aggregate and eventData.version to restv2.1. Use the envelopeEvents or recipientEvents property to set the event statuses that will trigger your configuration. </div></ds-step> <ds-step open="false" hideIcon="true"> <h3>XML Aggregate</h3> <div> Set deliveryMode to aggregate. Use the envelopeEvents or recipientEvents property to set the event statuses that will trigger your configuration. </div></ds-step> <ds-step open="false" hideIcon="true"> <h3>XML SIM (Legacy apps only)</h3> <div> Note: This model will be deprecated. Set deliveryMode to SIM. Use the envelopeEvents or recipientEvents property to set the event statuses that will trigger your configuration. </div></ds-step> </ds-column> ## Troubleshooting If your configuration is not working, check the following. Connect must be enabled for your account to use this function. If you are using envelopeEvents or recipientEvents, make sure that the event values are sentence case, not lowercase. Make sure you have either set allUsers to true or set userIds to a non-empty array of IDs. By default, this endpoint creates a disabled configuration. To enable the configuration immediately, set the body parameter allowEnvelopePublish to true. You can also enable the configuration in the UI. To check if events are being emitted, set enableLog to true to view event logs in the Connect console. ## Related topics For more information about Connect, see the DocuSign Connect guide. * Use the MyAPICalls sample app to see an example of this endpoint using the JSON SIM model.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • opts (keyword): Optional parameters
    • :body (ConnectCustomConfiguration):

Returns

  • {:ok, DocuSign.Model.ConnectCustomConfiguration.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

View Source 
@spec connect_put_connect_configuration(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.ConnectCustomConfiguration.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Updates a specified Connect configuration. Updates the specified DocuSign Connect configuration in your account. To enable the configuration, set the allowEnvelopePublish property to true. After any updates, test your configuration to make sure it works as expected. Note: To use this function, you must be an account administrator and Connect must be enabled on your 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
    • :body (ConnectCustomConfiguration):

Returns

  • {:ok, DocuSign.Model.ConnectCustomConfiguration.t} on success
  • {:error, Tesla.Env.t} on failure