# DocuSign_eSign::ConnectApi

All URIs are relative to *https://www.docusign.net/restapi*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_configuration**](ConnectApi.md#create_configuration) | **POST** /v2/accounts/{accountId}/connect | Creates a connect configuration for the specified account.
[**delete_configuration**](ConnectApi.md#delete_configuration) | **DELETE** /v2/accounts/{accountId}/connect/{connectId} | Deletes the specified connect configuration.
[**delete_event_failure_log**](ConnectApi.md#delete_event_failure_log) | **DELETE** /v2/accounts/{accountId}/connect/failures/{failureId} | Deletes a Connect failure log entry.
[**delete_event_log**](ConnectApi.md#delete_event_log) | **DELETE** /v2/accounts/{accountId}/connect/logs/{logId} | Deletes a specified Connect log entry.
[**delete_event_logs**](ConnectApi.md#delete_event_logs) | **DELETE** /v2/accounts/{accountId}/connect/logs | Gets a list of Connect log entries.
[**delete_mobile_notifiers**](ConnectApi.md#delete_mobile_notifiers) | **DELETE** /v2/accounts/{accountId}/connect/mobile_notifiers | Reserved
[**get_configuration**](ConnectApi.md#get_configuration) | **GET** /v2/accounts/{accountId}/connect/{connectId} | Get a Connect Configuration Information
[**get_event_log**](ConnectApi.md#get_event_log) | **GET** /v2/accounts/{accountId}/connect/logs/{logId} | Get the specified Connect log entry.
[**list_configurations**](ConnectApi.md#list_configurations) | **GET** /v2/accounts/{accountId}/connect | Get Connect Configuration Information
[**list_event_failure_logs**](ConnectApi.md#list_event_failure_logs) | **GET** /v2/accounts/{accountId}/connect/failures | Gets the Connect failure log information.
[**list_event_logs**](ConnectApi.md#list_event_logs) | **GET** /v2/accounts/{accountId}/connect/logs | Gets the Connect log.
[**list_mobile_notifiers**](ConnectApi.md#list_mobile_notifiers) | **GET** /v2/accounts/{accountId}/connect/mobile_notifiers | Reserved
[**list_users**](ConnectApi.md#list_users) | **GET** /v2/accounts/{accountId}/connect/{connectId}/users | Returns users from the configured Connect service.
[**retry_event_for_envelope**](ConnectApi.md#retry_event_for_envelope) | **PUT** /v2/accounts/{accountId}/connect/envelopes/{envelopeId}/retry_queue | Republishes Connect information for the specified envelope.
[**retry_event_for_envelopes**](ConnectApi.md#retry_event_for_envelopes) | **PUT** /v2/accounts/{accountId}/connect/envelopes/retry_queue | Republishes Connect information for multiple envelopes.
[**update_configuration**](ConnectApi.md#update_configuration) | **PUT** /v2/accounts/{accountId}/connect | Updates a specified Connect configuration.
[**update_mobile_notifiers**](ConnectApi.md#update_mobile_notifiers) | **PUT** /v2/accounts/{accountId}/connect/mobile_notifiers | Reserved


# **create_configuration**
> ConnectCustomConfiguration create_configuration(account_id, opts)

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.

### Example
```ruby
# load the gem
require 'docusign_esign'

api_instance = DocuSign_eSign::ConnectApi.new

account_id = "account_id_example" # String | The external account number (int) or account ID Guid.

opts = { 
  connect_custom_configuration: DocuSign_eSign::ConnectCustomConfiguration.new # ConnectCustomConfiguration | 
}

begin
  #Creates a connect configuration for the specified account.
  result = api_instance.create_configuration(account_id, opts)
  p result
rescue DocuSign_eSign::ApiError => e
  puts "Exception when calling ConnectApi->create_configuration: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **String**| The external account number (int) or account ID Guid. | 
 **connect_custom_configuration** | [**ConnectCustomConfiguration**](ConnectCustomConfiguration.md)|  | [optional] 

### Return type

[**ConnectCustomConfiguration**](ConnectCustomConfiguration.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json



# **delete_configuration**
> delete_configuration(account_id, connect_id)

Deletes the specified connect configuration.

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

### Example
```ruby
# load the gem
require 'docusign_esign'

api_instance = DocuSign_eSign::ConnectApi.new

account_id = "account_id_example" # String | The external account number (int) or account ID Guid.

connect_id = "connect_id_example" # String | The ID of the custom Connect configuration being accessed.


begin
  #Deletes the specified connect configuration.
  api_instance.delete_configuration(account_id, connect_id)
rescue DocuSign_eSign::ApiError => e
  puts "Exception when calling ConnectApi->delete_configuration: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **String**| The external account number (int) or account ID Guid. | 
 **connect_id** | **String**| The ID of the custom Connect configuration being accessed. | 

### Return type

nil (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json



# **delete_event_failure_log**
> delete_event_failure_log(account_id, failure_id)

Deletes a Connect failure log entry.

Deletes the Connect failure log information for the specified entry.

### Example
```ruby
# load the gem
require 'docusign_esign'

api_instance = DocuSign_eSign::ConnectApi.new

account_id = "account_id_example" # String | The external account number (int) or account ID Guid.

failure_id = "failure_id_example" # String | The ID of the failed connect log entry.


begin
  #Deletes a Connect failure log entry.
  api_instance.delete_event_failure_log(account_id, failure_id)
rescue DocuSign_eSign::ApiError => e
  puts "Exception when calling ConnectApi->delete_event_failure_log: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **String**| The external account number (int) or account ID Guid. | 
 **failure_id** | **String**| The ID of the failed connect log entry. | 

### Return type

nil (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json



# **delete_event_log**
> delete_event_log(account_id, log_id)

Deletes a specified Connect log entry.

Deletes a specified entry from the Connect Log. 

### Example
```ruby
# load the gem
require 'docusign_esign'

api_instance = DocuSign_eSign::ConnectApi.new

account_id = "account_id_example" # String | The external account number (int) or account ID Guid.

log_id = "log_id_example" # String | The ID of the connect log entry


begin
  #Deletes a specified Connect log entry.
  api_instance.delete_event_log(account_id, log_id)
rescue DocuSign_eSign::ApiError => e
  puts "Exception when calling ConnectApi->delete_event_log: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **String**| The external account number (int) or account ID Guid. | 
 **log_id** | **String**| The ID of the connect log entry | 

### Return type

nil (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json



# **delete_event_logs**
> delete_event_logs(account_id)

Gets a list of Connect log entries.

Retrieves a list of connect log entries for your account.  ###### Note: The `enableLog` property in the Connect configuration must be set to **true** to enable logging. If logging is not enabled, then no log entries are recorded.

### Example
```ruby
# load the gem
require 'docusign_esign'

api_instance = DocuSign_eSign::ConnectApi.new

account_id = "account_id_example" # String | The external account number (int) or account ID Guid.


begin
  #Gets a list of Connect log entries.
  api_instance.delete_event_logs(account_id)
rescue DocuSign_eSign::ApiError => e
  puts "Exception when calling ConnectApi->delete_event_logs: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **String**| The external account number (int) or account ID Guid. | 

### Return type

nil (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json



# **delete_mobile_notifiers**
> MobileNotifierConfigurationInformation delete_mobile_notifiers(account_id, opts)

Reserved

Reserved:

### Example
```ruby
# load the gem
require 'docusign_esign'

api_instance = DocuSign_eSign::ConnectApi.new

account_id = "account_id_example" # String | The external account number (int) or account ID Guid.

opts = { 
  mobile_notifier_configuration_information: DocuSign_eSign::MobileNotifierConfigurationInformation.new # MobileNotifierConfigurationInformation | 
}

begin
  #Reserved
  result = api_instance.delete_mobile_notifiers(account_id, opts)
  p result
rescue DocuSign_eSign::ApiError => e
  puts "Exception when calling ConnectApi->delete_mobile_notifiers: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **String**| The external account number (int) or account ID Guid. | 
 **mobile_notifier_configuration_information** | [**MobileNotifierConfigurationInformation**](MobileNotifierConfigurationInformation.md)|  | [optional] 

### Return type

[**MobileNotifierConfigurationInformation**](MobileNotifierConfigurationInformation.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json



# **get_configuration**
> ConnectConfigResults get_configuration(account_id, connect_id)

Get a Connect Configuration Information

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

### Example
```ruby
# load the gem
require 'docusign_esign'

api_instance = DocuSign_eSign::ConnectApi.new

account_id = "account_id_example" # String | The external account number (int) or account ID Guid.

connect_id = "connect_id_example" # String | The ID of the custom Connect configuration being accessed.


begin
  #Get a Connect Configuration Information
  result = api_instance.get_configuration(account_id, connect_id)
  p result
rescue DocuSign_eSign::ApiError => e
  puts "Exception when calling ConnectApi->get_configuration: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **String**| The external account number (int) or account ID Guid. | 
 **connect_id** | **String**| The ID of the custom Connect configuration being accessed. | 

### Return type

[**ConnectConfigResults**](ConnectConfigResults.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json



# **get_event_log**
> ConnectLog get_event_log(account_id, log_id, opts)

Get the specified Connect log entry.

Retrieves the specified Connect log entry for your account.  ###### Note: 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. 

### Example
```ruby
# load the gem
require 'docusign_esign'

api_instance = DocuSign_eSign::ConnectApi.new

account_id = "account_id_example" # String | The external account number (int) or account ID Guid.

log_id = "log_id_example" # String | The ID of the connect log entry

opts = { 
  additional_info: "additional_info_example" # String | When true, the connectDebugLog information is included in the response.
}

begin
  #Get the specified Connect log entry.
  result = api_instance.get_event_log(account_id, log_id, opts)
  p result
rescue DocuSign_eSign::ApiError => e
  puts "Exception when calling ConnectApi->get_event_log: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **String**| The external account number (int) or account ID Guid. | 
 **log_id** | **String**| The ID of the connect log entry | 
 **additional_info** | **String**| When true, the connectDebugLog information is included in the response. | [optional] 

### Return type

[**ConnectLog**](ConnectLog.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json



# **list_configurations**
> ConnectConfigResults list_configurations(account_id)

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.

### Example
```ruby
# load the gem
require 'docusign_esign'

api_instance = DocuSign_eSign::ConnectApi.new

account_id = "account_id_example" # String | The external account number (int) or account ID Guid.


begin
  #Get Connect Configuration Information
  result = api_instance.list_configurations(account_id)
  p result
rescue DocuSign_eSign::ApiError => e
  puts "Exception when calling ConnectApi->list_configurations: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **String**| The external account number (int) or account ID Guid. | 

### Return type

[**ConnectConfigResults**](ConnectConfigResults.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json



# **list_event_failure_logs**
> ConnectLogs list_event_failure_logs(account_id, opts)

Gets the Connect failure log information.

Retrieves the Connect Failure Log information. It can be used to determine which envelopes failed to post, so a republish request can be created.

### Example
```ruby
# load the gem
require 'docusign_esign'

api_instance = DocuSign_eSign::ConnectApi.new

account_id = "account_id_example" # String | The external account number (int) or account ID Guid.

opts = { 
  from_date: "from_date_example", # String | 
  to_date: "to_date_example" # String | 
}

begin
  #Gets the Connect failure log information.
  result = api_instance.list_event_failure_logs(account_id, opts)
  p result
rescue DocuSign_eSign::ApiError => e
  puts "Exception when calling ConnectApi->list_event_failure_logs: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **String**| The external account number (int) or account ID Guid. | 
 **from_date** | **String**|  | [optional] 
 **to_date** | **String**|  | [optional] 

### Return type

[**ConnectLogs**](ConnectLogs.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json



# **list_event_logs**
> ConnectLogs list_event_logs(account_id, opts)

Gets the Connect log.

Retrieves a list of connect log entries for your account.  ###### Note: 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. 

### Example
```ruby
# load the gem
require 'docusign_esign'

api_instance = DocuSign_eSign::ConnectApi.new

account_id = "account_id_example" # String | The external account number (int) or account ID Guid.

opts = { 
  from_date: "from_date_example", # String | 
  to_date: "to_date_example" # String | 
}

begin
  #Gets the Connect log.
  result = api_instance.list_event_logs(account_id, opts)
  p result
rescue DocuSign_eSign::ApiError => e
  puts "Exception when calling ConnectApi->list_event_logs: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **String**| The external account number (int) or account ID Guid. | 
 **from_date** | **String**|  | [optional] 
 **to_date** | **String**|  | [optional] 

### Return type

[**ConnectLogs**](ConnectLogs.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json



# **list_mobile_notifiers**
> MobileNotifierConfigurationInformation list_mobile_notifiers(account_id)

Reserved

Reserved:

### Example
```ruby
# load the gem
require 'docusign_esign'

api_instance = DocuSign_eSign::ConnectApi.new

account_id = "account_id_example" # String | The external account number (int) or account ID Guid.


begin
  #Reserved
  result = api_instance.list_mobile_notifiers(account_id)
  p result
rescue DocuSign_eSign::ApiError => e
  puts "Exception when calling ConnectApi->list_mobile_notifiers: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **String**| The external account number (int) or account ID Guid. | 

### Return type

[**MobileNotifierConfigurationInformation**](MobileNotifierConfigurationInformation.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json



# **list_users**
> IntegratedUserInfoList list_users(account_id, connect_id, opts)

Returns users from the configured Connect service.

Returns users from the configured Connect service.

### Example
```ruby
# load the gem
require 'docusign_esign'

api_instance = DocuSign_eSign::ConnectApi.new

account_id = "account_id_example" # String | The external account number (int) or account ID Guid.

connect_id = "connect_id_example" # String | The ID of the custom Connect configuration being accessed.

opts = { 
  count: "count_example", # String | 
  email_substring: "email_substring_example", # String | 
  list_included_users: "list_included_users_example", # String | 
  start_position: "start_position_example", # String | 
  status: "status_example", # String | 
  user_name_substring: "user_name_substring_example" # String | 
}

begin
  #Returns users from the configured Connect service.
  result = api_instance.list_users(account_id, connect_id, opts)
  p result
rescue DocuSign_eSign::ApiError => e
  puts "Exception when calling ConnectApi->list_users: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **String**| The external account number (int) or account ID Guid. | 
 **connect_id** | **String**| The ID of the custom Connect configuration being accessed. | 
 **count** | **String**|  | [optional] 
 **email_substring** | **String**|  | [optional] 
 **list_included_users** | **String**|  | [optional] 
 **start_position** | **String**|  | [optional] 
 **status** | **String**|  | [optional] 
 **user_name_substring** | **String**|  | [optional] 

### Return type

[**IntegratedUserInfoList**](IntegratedUserInfoList.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json



# **retry_event_for_envelope**
> ConnectFailureResults retry_event_for_envelope(account_id, envelope_id)

Republishes Connect information for the specified envelope.

Republishes Connect information for the specified envelope.

### Example
```ruby
# load the gem
require 'docusign_esign'

api_instance = DocuSign_eSign::ConnectApi.new

account_id = "account_id_example" # String | The external account number (int) or account ID Guid.

envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.


begin
  #Republishes Connect information for the specified envelope.
  result = api_instance.retry_event_for_envelope(account_id, envelope_id)
  p result
rescue DocuSign_eSign::ApiError => e
  puts "Exception when calling ConnectApi->retry_event_for_envelope: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **String**| The external account number (int) or account ID Guid. | 
 **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. | 

### Return type

[**ConnectFailureResults**](ConnectFailureResults.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json



# **retry_event_for_envelopes**
> ConnectFailureResults retry_event_for_envelopes(account_id, opts)

Republishes Connect information for multiple envelopes.

Republishes Connect information for the  specified set of envelopes. 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 [ML:GetConnectLog] retrieve the failure log.

### Example
```ruby
# load the gem
require 'docusign_esign'

api_instance = DocuSign_eSign::ConnectApi.new

account_id = "account_id_example" # String | The external account number (int) or account ID Guid.

opts = { 
  connect_failure_filter: DocuSign_eSign::ConnectFailureFilter.new # ConnectFailureFilter | 
}

begin
  #Republishes Connect information for multiple envelopes.
  result = api_instance.retry_event_for_envelopes(account_id, opts)
  p result
rescue DocuSign_eSign::ApiError => e
  puts "Exception when calling ConnectApi->retry_event_for_envelopes: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **String**| The external account number (int) or account ID Guid. | 
 **connect_failure_filter** | [**ConnectFailureFilter**](ConnectFailureFilter.md)|  | [optional] 

### Return type

[**ConnectFailureResults**](ConnectFailureResults.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json



# **update_configuration**
> ConnectCustomConfiguration update_configuration(account_id, opts)

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.

### Example
```ruby
# load the gem
require 'docusign_esign'

api_instance = DocuSign_eSign::ConnectApi.new

account_id = "account_id_example" # String | The external account number (int) or account ID Guid.

opts = { 
  connect_custom_configuration: DocuSign_eSign::ConnectCustomConfiguration.new # ConnectCustomConfiguration | 
}

begin
  #Updates a specified Connect configuration.
  result = api_instance.update_configuration(account_id, opts)
  p result
rescue DocuSign_eSign::ApiError => e
  puts "Exception when calling ConnectApi->update_configuration: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **String**| The external account number (int) or account ID Guid. | 
 **connect_custom_configuration** | [**ConnectCustomConfiguration**](ConnectCustomConfiguration.md)|  | [optional] 

### Return type

[**ConnectCustomConfiguration**](ConnectCustomConfiguration.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json



# **update_mobile_notifiers**
> MobileNotifierConfigurationInformation update_mobile_notifiers(account_id, opts)

Reserved

Reserved:

### Example
```ruby
# load the gem
require 'docusign_esign'

api_instance = DocuSign_eSign::ConnectApi.new

account_id = "account_id_example" # String | The external account number (int) or account ID Guid.

opts = { 
  mobile_notifier_configuration_information: DocuSign_eSign::MobileNotifierConfigurationInformation.new # MobileNotifierConfigurationInformation | 
}

begin
  #Reserved
  result = api_instance.update_mobile_notifiers(account_id, opts)
  p result
rescue DocuSign_eSign::ApiError => e
  puts "Exception when calling ConnectApi->update_mobile_notifiers: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **String**| The external account number (int) or account ID Guid. | 
 **mobile_notifier_configuration_information** | [**MobileNotifierConfigurationInformation**](MobileNotifierConfigurationInformation.md)|  | [optional] 

### Return type

[**MobileNotifierConfigurationInformation**](MobileNotifierConfigurationInformation.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json