# `DocuSign.Api.ConnectEvents`
[🔗](https://github.com/neilberkman/docusign_elixir/blob/v3.5.1/lib/docusign/api/connect_events.ex#L5)
API calls for all endpoints tagged `ConnectEvents`.
# `connect_failures_delete_connect_failure_log`
```elixir
@spec connect_failures_delete_connect_failure_log(
DocuSign.Connection.t(),
String.t(),
String.t(),
keyword()
) :: {:ok, map()} | {:error, Req.Response.t()}
```
Deletes a Connect failure log entry.
Deletes a Connect failure log entry. To delete all the Connect failure log entries, specify `all` for the `failureId` path parameter. To use this method, 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.
- `failure_id` (String.t): The ID of the Connect post failure. Use `all` to delete all failures for the account.
- `opts` (keyword): Optional parameters
### Returns
- `{:ok, map()}` on success
- `{:error, Req.Response.t}` on failure
# `connect_failures_get_connect_logs`
```elixir
@spec connect_failures_get_connect_logs(
DocuSign.Connection.t(),
String.t(),
keyword()
) ::
{:ok, DocuSign.Model.ConnectLogs.t()} | {:error, Req.Response.t()}
```
Gets the Connect failure log information.
Retrieves the Connect failure log information. To use this method, you must be an account administrator and Connect must be enabled on your account. Use this method to determine which envelopes failed to post. You can then use [ConnectEvents: retryForEnvelopes][retry] to create a republish request. [retry]: /docs/esign-rest-api/reference/connect/connectevents/retryforenvelopes/
### Parameters
- `connection` (DocuSign.Connection): Connection to server
- `account_id` (String.t): The external account number (int) or account ID GUID.
- `opts` (keyword): Optional parameters
- `:from_date` (String.t): The start date for a date range in UTC DateTime format. **Note:** If this property is null, no date filtering is applied.
- `:to_date` (String.t): The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned. **Note:** If this property is null, the value defaults to the current date.
### Returns
- `{:ok, DocuSign.Model.ConnectLogs.t}` on success
- `{:error, Req.Response.t}` on failure
# `connect_log_delete_connect_log`
```elixir
@spec connect_log_delete_connect_log(
DocuSign.Connection.t(),
String.t(),
String.t(),
keyword()
) ::
{:ok, nil} | {:error, Req.Response.t()}
```
Deletes a specified Connect log entry.
Deletes a specified entry from the Connect Log. To use this method, 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.
- `log_id` (String.t): The ID of the Connect log entry. Use `all` to delete all entries for the account.
- `opts` (keyword): Optional parameters
### Returns
- `{:ok, nil}` on success
- `{:error, Req.Response.t}` on failure
# `connect_log_delete_connect_logs`
```elixir
@spec connect_log_delete_connect_logs(DocuSign.Connection.t(), String.t(), keyword()) ::
{:ok, nil} | {:error, Req.Response.t()}
```
Deletes a list of Connect log entries.
Deletes a list of Connect log entries for your account. To use this method, 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, nil}` on success
- `{:error, Req.Response.t}` on failure
# `connect_log_get_connect_log`
```elixir
@spec connect_log_get_connect_log(
DocuSign.Connection.t(),
String.t(),
String.t(),
keyword()
) ::
{:ok, DocuSign.Model.ConnectLog.t()} | {:error, Req.Response.t()}
```
Gets a Connect log entry.
Retrieves the specified Connect log entry for your account. To use this method, you must be an account administrator and Connect must be enabled on your account. The `enableLog` setting in the Connect configuration must be set to **true** to enable logging. If logging is not enabled, then no log entries are recorded.
### Parameters
- `connection` (DocuSign.Connection): Connection to server
- `account_id` (String.t): The external account number (int) or account ID GUID.
- `log_id` (String.t): The ID of the Connect log entry.
- `opts` (keyword): Optional parameters
- `:additional_info` (String.t): When **true,** the response includes the `connectDebugLog` information.
### Returns
- `{:ok, DocuSign.Model.ConnectLog.t}` on success
- `{:error, Req.Response.t}` on failure
# `connect_log_get_connect_logs`
```elixir
@spec connect_log_get_connect_logs(DocuSign.Connection.t(), String.t(), keyword()) ::
{:ok, DocuSign.Model.ConnectLogs.t()} | {:error, Req.Response.t()}
```
Gets the Connect log.
Retrieves a list of the 100 most recent Connect log entries for your account. To use this method, you must be an account administrator and Connect must be enabled on your account. The `enableLog` setting in the Connect configuration must be set to **true** to enable logging. Log entries are deleted after 15 days.
### Parameters
- `connection` (DocuSign.Connection): Connection to server
- `account_id` (String.t): The external account number (int) or account ID GUID.
- `opts` (keyword): Optional parameters
- `:from_date` (String.t): The start date for a date range in UTC DateTime format. **Note:** If this property is null, no date filtering is applied.
- `:to_date` (String.t): The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned. **Note:** If this property is null, the value defaults to the current date.
### Returns
- `{:ok, DocuSign.Model.ConnectLogs.t}` on success
- `{:error, Req.Response.t}` on failure
# `connect_publish_put_connect_retry`
```elixir
@spec connect_publish_put_connect_retry(
DocuSign.Connection.t(),
String.t(),
keyword()
) ::
{:ok, DocuSign.Model.ConnectFailureResults.t()} | {:error, Req.Response.t()}
```
Republishes Connect information for multiple envelopes.
Republishes Connect information for the specified set of envelopes. To use this method, you must be an account administrator and Connect must be enabled on your account. The primary use is to republish Connect post failures by including envelope IDs for the envelopes that failed to post in the request. The list of envelope IDs that failed to post correctly can be retrieved by calling to [Connect::listEventLogs](/docs/esign-rest-api/reference/connect/connectevents/list/) retrieve the failure log.
### 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` (ConnectFailureFilter):
### Returns
- `{:ok, DocuSign.Model.ConnectFailureResults.t}` on success
- `{:error, Req.Response.t}` on failure
# `connect_publish_put_connect_retry_by_envelope`
```elixir
@spec connect_publish_put_connect_retry_by_envelope(
DocuSign.Connection.t(),
String.t(),
String.t(),
keyword()
) ::
{:ok, DocuSign.Model.ConnectFailureResults.t()} | {:error, Req.Response.t()}
```
Republishes Connect information for the specified envelope.
Republishes Connect information for the specified envelope. To use this method, 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.
- `envelope_id` (String.t): The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
- `opts` (keyword): Optional parameters
### Returns
- `{:ok, DocuSign.Model.ConnectFailureResults.t}` on success
- `{:error, Req.Response.t}` on failure
---
*Consult [api-reference.md](api-reference.md) for complete listing*