Class: DocuSign_eSign::ConnectApi
- Inherits:
-
Object
- Object
- DocuSign_eSign::ConnectApi
- Defined in:
- lib/docusign_esign/api/connect_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_configuration(account_id, connect_custom_configuration) ⇒ ConnectCustomConfiguration
Creates a connect configuration for the specified account.
-
#create_configuration_with_http_info(account_id, connect_custom_configuration) ⇒ Array<(ConnectCustomConfiguration, Fixnum, Hash)>
Creates a connect configuration for the specified account.
-
#delete_configuration(account_id, connect_id) ⇒ nil
Deletes the specified connect configuration.
-
#delete_configuration_with_http_info(account_id, connect_id) ⇒ Array<(nil, Fixnum, Hash)>
Deletes the specified connect configuration.
-
#delete_event_failure_log(account_id, failure_id) ⇒ nil
Deletes a Connect failure log entry.
-
#delete_event_failure_log_with_http_info(account_id, failure_id) ⇒ Array<(nil, Fixnum, Hash)>
Deletes a Connect failure log entry.
-
#delete_event_log(account_id, log_id) ⇒ nil
Deletes a specified Connect log entry.
-
#delete_event_log_with_http_info(account_id, log_id) ⇒ Array<(nil, Fixnum, Hash)>
Deletes a specified Connect log entry.
-
#delete_event_logs(account_id) ⇒ nil
Gets a list of Connect log entries.
-
#delete_event_logs_with_http_info(account_id) ⇒ Array<(nil, Fixnum, Hash)>
Gets a list of Connect log entries.
-
#get_configuration(account_id, connect_id) ⇒ ConnectConfigResults
Get a Connect Configuration Information Retrieves the information for the specified DocuSign Connect configuration.
-
#get_configuration_with_http_info(account_id, connect_id) ⇒ Array<(ConnectConfigResults, Fixnum, Hash)>
Get a Connect Configuration Information Retrieves the information for the specified DocuSign Connect configuration.
-
#get_event_log(account_id, log_id, options = DocuSign_eSign::GetEventLogOptions.default) ⇒ ConnectLog
Get the specified Connect log entry.
-
#get_event_log_with_http_info(account_id, log_id, options = DocuSign_eSign::GetEventLogOptions.default) ⇒ Array<(ConnectLog, Fixnum, Hash)>
Get the specified Connect log entry.
-
#initialize(api_client = ConnectApi.default) ⇒ ConnectApi
constructor
A new instance of ConnectApi.
-
#list_configurations(account_id) ⇒ ConnectConfigResults
Get Connect Configuration Information Retrieves all the DocuSign Custom Connect definitions for the specified account.
-
#list_configurations_with_http_info(account_id) ⇒ Array<(ConnectConfigResults, Fixnum, Hash)>
Get Connect Configuration Information Retrieves all the DocuSign Custom Connect definitions for the specified account.
-
#list_event_failure_logs(account_id, options = DocuSign_eSign::ListEventFailureLogsOptions.default) ⇒ ConnectLogs
Gets the Connect failure log information.
-
#list_event_failure_logs_with_http_info(account_id, options = DocuSign_eSign::ListEventFailureLogsOptions.default) ⇒ Array<(ConnectLogs, Fixnum, Hash)>
Gets the Connect failure log information.
-
#list_event_logs(account_id, options = DocuSign_eSign::ListEventLogsOptions.default) ⇒ ConnectLogs
Gets the Connect log.
-
#list_event_logs_with_http_info(account_id, options = DocuSign_eSign::ListEventLogsOptions.default) ⇒ Array<(ConnectLogs, Fixnum, Hash)>
Gets the Connect log.
-
#list_users(account_id, connect_id, options = DocuSign_eSign::ListUsersOptions.default) ⇒ IntegratedUserInfoList
Returns users from the configured Connect service.
-
#list_users_with_http_info(account_id, connect_id, options = DocuSign_eSign::ListUsersOptions.default) ⇒ Array<(IntegratedUserInfoList, Fixnum, Hash)>
Returns users from the configured Connect service.
-
#retry_event_for_envelope(account_id, envelope_id) ⇒ ConnectFailureResults
Republishes Connect information for the specified envelope.
-
#retry_event_for_envelope_with_http_info(account_id, envelope_id) ⇒ Array<(ConnectFailureResults, Fixnum, Hash)>
Republishes Connect information for the specified envelope.
-
#retry_event_for_envelopes(account_id, connect_failure_filter) ⇒ ConnectFailureResults
Republishes Connect information for multiple envelopes.
-
#retry_event_for_envelopes_with_http_info(account_id, connect_failure_filter) ⇒ Array<(ConnectFailureResults, Fixnum, Hash)>
Republishes Connect information for multiple envelopes.
-
#update_configuration(account_id, connect_custom_configuration) ⇒ ConnectCustomConfiguration
Updates a specified Connect configuration.
-
#update_configuration_with_http_info(account_id, connect_custom_configuration) ⇒ Array<(ConnectCustomConfiguration, Fixnum, Hash)>
Updates a specified Connect configuration.
Constructor Details
#initialize(api_client = ConnectApi.default) ⇒ ConnectApi
Returns a new instance of ConnectApi.
77 78 79 |
# File 'lib/docusign_esign/api/connect_api.rb', line 77 def initialize(api_client = ConnectApi.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
75 76 77 |
# File 'lib/docusign_esign/api/connect_api.rb', line 75 def api_client @api_client end |
Instance Method Details
#create_configuration(account_id, connect_custom_configuration) ⇒ ConnectCustomConfiguration
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.
86 87 88 89 |
# File 'lib/docusign_esign/api/connect_api.rb', line 86 def create_configuration(account_id, connect_custom_configuration) data, _status_code, _headers = create_configuration_with_http_info(account_id, connect_custom_configuration) return data end |
#create_configuration_with_http_info(account_id, connect_custom_configuration) ⇒ Array<(ConnectCustomConfiguration, Fixnum, Hash)>
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.
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 |
# File 'lib/docusign_esign/api/connect_api.rb', line 96 def create_configuration_with_http_info(account_id, connect_custom_configuration) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: ConnectApi.create_configuration ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.create_configuration" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/connect".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(connect_custom_configuration) auth_names = [] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ConnectCustomConfiguration') if @api_client.config.debugging @api_client.config.logger.debug "API called: ConnectApi#create_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_configuration(account_id, connect_id) ⇒ nil
Deletes the specified connect configuration. Deletes the specified DocuSign Connect configuration. ###### Note: Connect must be enabled for your account to use this function.
137 138 139 140 |
# File 'lib/docusign_esign/api/connect_api.rb', line 137 def delete_configuration(account_id, connect_id) delete_configuration_with_http_info(account_id, connect_id) return nil end |
#delete_configuration_with_http_info(account_id, connect_id) ⇒ Array<(nil, Fixnum, Hash)>
Deletes the specified connect configuration. Deletes the specified DocuSign Connect configuration. ###### Note: Connect must be enabled for your account to use this function.
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 |
# File 'lib/docusign_esign/api/connect_api.rb', line 147 def delete_configuration_with_http_info(account_id, connect_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: ConnectApi.delete_configuration ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.delete_configuration" if account_id.nil? # verify the required parameter 'connect_id' is set fail ArgumentError, "Missing the required parameter 'connect_id' when calling ConnectApi.delete_configuration" if connect_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/connect/{connectId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'connectId' + '}', connect_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: ConnectApi#delete_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_event_failure_log(account_id, failure_id) ⇒ nil
Deletes a Connect failure log entry. Deletes the Connect failure log information for the specified entry.
189 190 191 192 |
# File 'lib/docusign_esign/api/connect_api.rb', line 189 def delete_event_failure_log(account_id, failure_id) delete_event_failure_log_with_http_info(account_id, failure_id) return nil end |
#delete_event_failure_log_with_http_info(account_id, failure_id) ⇒ Array<(nil, Fixnum, Hash)>
Deletes a Connect failure log entry. Deletes the Connect failure log information for the specified entry.
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'lib/docusign_esign/api/connect_api.rb', line 199 def delete_event_failure_log_with_http_info(account_id, failure_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: ConnectApi.delete_event_failure_log ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.delete_event_failure_log" if account_id.nil? # verify the required parameter 'failure_id' is set fail ArgumentError, "Missing the required parameter 'failure_id' when calling ConnectApi.delete_event_failure_log" if failure_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/connect/failures/{failureId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'failureId' + '}', failure_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: ConnectApi#delete_event_failure_log\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_event_log(account_id, log_id) ⇒ nil
Deletes a specified Connect log entry. Deletes a specified entry from the Connect Log.
241 242 243 244 |
# File 'lib/docusign_esign/api/connect_api.rb', line 241 def delete_event_log(account_id, log_id) delete_event_log_with_http_info(account_id, log_id) return nil end |
#delete_event_log_with_http_info(account_id, log_id) ⇒ Array<(nil, Fixnum, Hash)>
Deletes a specified Connect log entry. Deletes a specified entry from the Connect Log.
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 |
# File 'lib/docusign_esign/api/connect_api.rb', line 251 def delete_event_log_with_http_info(account_id, log_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: ConnectApi.delete_event_log ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.delete_event_log" if account_id.nil? # verify the required parameter 'log_id' is set fail ArgumentError, "Missing the required parameter 'log_id' when calling ConnectApi.delete_event_log" if log_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/connect/logs/{logId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'logId' + '}', log_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: ConnectApi#delete_event_log\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_event_logs(account_id) ⇒ nil
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.
292 293 294 295 |
# File 'lib/docusign_esign/api/connect_api.rb', line 292 def delete_event_logs(account_id) delete_event_logs_with_http_info(account_id) return nil end |
#delete_event_logs_with_http_info(account_id) ⇒ Array<(nil, Fixnum, Hash)>
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.
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 |
# File 'lib/docusign_esign/api/connect_api.rb', line 301 def delete_event_logs_with_http_info(account_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: ConnectApi.delete_event_logs ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.delete_event_logs" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/connect/logs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: ConnectApi#delete_event_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_configuration(account_id, connect_id) ⇒ ConnectConfigResults
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.
341 342 343 344 |
# File 'lib/docusign_esign/api/connect_api.rb', line 341 def get_configuration(account_id, connect_id) data, _status_code, _headers = get_configuration_with_http_info(account_id, connect_id) return data end |
#get_configuration_with_http_info(account_id, connect_id) ⇒ Array<(ConnectConfigResults, Fixnum, Hash)>
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.
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 |
# File 'lib/docusign_esign/api/connect_api.rb', line 351 def get_configuration_with_http_info(account_id, connect_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: ConnectApi.get_configuration ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.get_configuration" if account_id.nil? # verify the required parameter 'connect_id' is set fail ArgumentError, "Missing the required parameter 'connect_id' when calling ConnectApi.get_configuration" if connect_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/connect/{connectId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'connectId' + '}', connect_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ConnectConfigResults') if @api_client.config.debugging @api_client.config.logger.debug "API called: ConnectApi#get_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_event_log(account_id, log_id, options = DocuSign_eSign::GetEventLogOptions.default) ⇒ ConnectLog
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.
395 396 397 398 |
# File 'lib/docusign_esign/api/connect_api.rb', line 395 def get_event_log(account_id, log_id, = DocuSign_eSign::GetEventLogOptions.default) data, _status_code, _headers = get_event_log_with_http_info(account_id, log_id, ) return data end |
#get_event_log_with_http_info(account_id, log_id, options = DocuSign_eSign::GetEventLogOptions.default) ⇒ Array<(ConnectLog, Fixnum, Hash)>
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.
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 |
# File 'lib/docusign_esign/api/connect_api.rb', line 406 def get_event_log_with_http_info(account_id, log_id, = DocuSign_eSign::GetEventLogOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: ConnectApi.get_event_log ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.get_event_log" if account_id.nil? # verify the required parameter 'log_id' is set fail ArgumentError, "Missing the required parameter 'log_id' when calling ConnectApi.get_event_log" if log_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/connect/logs/{logId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'logId' + '}', log_id.to_s) # query parameters query_params = {} query_params[:'additional_info'] = .additional_info if !.additional_info.nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ConnectLog') if @api_client.config.debugging @api_client.config.logger.debug "API called: ConnectApi#get_event_log\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_configurations(account_id) ⇒ ConnectConfigResults
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.
449 450 451 452 |
# File 'lib/docusign_esign/api/connect_api.rb', line 449 def list_configurations(account_id) data, _status_code, _headers = list_configurations_with_http_info(account_id) return data end |
#list_configurations_with_http_info(account_id) ⇒ Array<(ConnectConfigResults, Fixnum, Hash)>
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.
458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 |
# File 'lib/docusign_esign/api/connect_api.rb', line 458 def list_configurations_with_http_info(account_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: ConnectApi.list_configurations ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.list_configurations" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/connect".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ConnectConfigResults') if @api_client.config.debugging @api_client.config.logger.debug "API called: ConnectApi#list_configurations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_event_failure_logs(account_id, options = DocuSign_eSign::ListEventFailureLogsOptions.default) ⇒ ConnectLogs
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.
499 500 501 502 |
# File 'lib/docusign_esign/api/connect_api.rb', line 499 def list_event_failure_logs(account_id, = DocuSign_eSign::ListEventFailureLogsOptions.default) data, _status_code, _headers = list_event_failure_logs_with_http_info(account_id, ) return data end |
#list_event_failure_logs_with_http_info(account_id, options = DocuSign_eSign::ListEventFailureLogsOptions.default) ⇒ Array<(ConnectLogs, Fixnum, Hash)>
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.
509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 |
# File 'lib/docusign_esign/api/connect_api.rb', line 509 def list_event_failure_logs_with_http_info(account_id, = DocuSign_eSign::ListEventFailureLogsOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: ConnectApi.list_event_failure_logs ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.list_event_failure_logs" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/connect/failures".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} query_params[:'from_date'] = .from_date if !.from_date.nil? query_params[:'to_date'] = .to_date if !.to_date.nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ConnectLogs') if @api_client.config.debugging @api_client.config.logger.debug "API called: ConnectApi#list_event_failure_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_event_logs(account_id, options = DocuSign_eSign::ListEventLogsOptions.default) ⇒ ConnectLogs
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.
552 553 554 555 |
# File 'lib/docusign_esign/api/connect_api.rb', line 552 def list_event_logs(account_id, = DocuSign_eSign::ListEventLogsOptions.default) data, _status_code, _headers = list_event_logs_with_http_info(account_id, ) return data end |
#list_event_logs_with_http_info(account_id, options = DocuSign_eSign::ListEventLogsOptions.default) ⇒ Array<(ConnectLogs, Fixnum, Hash)>
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.
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 |
# File 'lib/docusign_esign/api/connect_api.rb', line 562 def list_event_logs_with_http_info(account_id, = DocuSign_eSign::ListEventLogsOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: ConnectApi.list_event_logs ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.list_event_logs" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/connect/logs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} query_params[:'from_date'] = .from_date if !.from_date.nil? query_params[:'to_date'] = .to_date if !.to_date.nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ConnectLogs') if @api_client.config.debugging @api_client.config.logger.debug "API called: ConnectApi#list_event_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_users(account_id, connect_id, options = DocuSign_eSign::ListUsersOptions.default) ⇒ IntegratedUserInfoList
Returns users from the configured Connect service. Returns users from the configured Connect service.
606 607 608 609 |
# File 'lib/docusign_esign/api/connect_api.rb', line 606 def list_users(account_id, connect_id, = DocuSign_eSign::ListUsersOptions.default) data, _status_code, _headers = list_users_with_http_info(account_id, connect_id, ) return data end |
#list_users_with_http_info(account_id, connect_id, options = DocuSign_eSign::ListUsersOptions.default) ⇒ Array<(IntegratedUserInfoList, Fixnum, Hash)>
Returns users from the configured Connect service. Returns users from the configured Connect service.
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 |
# File 'lib/docusign_esign/api/connect_api.rb', line 617 def list_users_with_http_info(account_id, connect_id, = DocuSign_eSign::ListUsersOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: ConnectApi.list_users ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.list_users" if account_id.nil? # verify the required parameter 'connect_id' is set fail ArgumentError, "Missing the required parameter 'connect_id' when calling ConnectApi.list_users" if connect_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/connect/{connectId}/users".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'connectId' + '}', connect_id.to_s) # query parameters query_params = {} query_params[:'count'] = .count if !.count.nil? query_params[:'email_substring'] = .email_substring if !.email_substring.nil? query_params[:'list_included_users'] = .list_included_users if !.list_included_users.nil? query_params[:'start_position'] = .start_position if !.start_position.nil? query_params[:'status'] = .status if !.status.nil? query_params[:'user_name_substring'] = .user_name_substring if !.user_name_substring.nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'IntegratedUserInfoList') if @api_client.config.debugging @api_client.config.logger.debug "API called: ConnectApi#list_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#retry_event_for_envelope(account_id, envelope_id) ⇒ ConnectFailureResults
Republishes Connect information for the specified envelope. Republishes Connect information for the specified envelope.
666 667 668 669 |
# File 'lib/docusign_esign/api/connect_api.rb', line 666 def retry_event_for_envelope(account_id, envelope_id) data, _status_code, _headers = retry_event_for_envelope_with_http_info(account_id, envelope_id) return data end |
#retry_event_for_envelope_with_http_info(account_id, envelope_id) ⇒ Array<(ConnectFailureResults, Fixnum, Hash)>
Republishes Connect information for the specified envelope. Republishes Connect information for the specified envelope.
676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 |
# File 'lib/docusign_esign/api/connect_api.rb', line 676 def retry_event_for_envelope_with_http_info(account_id, envelope_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: ConnectApi.retry_event_for_envelope ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.retry_event_for_envelope" if account_id.nil? # verify the required parameter 'envelope_id' is set fail ArgumentError, "Missing the required parameter 'envelope_id' when calling ConnectApi.retry_event_for_envelope" if envelope_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/connect/envelopes/{envelopeId}/retry_queue".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ConnectFailureResults') if @api_client.config.debugging @api_client.config.logger.debug "API called: ConnectApi#retry_event_for_envelope\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#retry_event_for_envelopes(account_id, connect_failure_filter) ⇒ ConnectFailureResults
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.
719 720 721 722 |
# File 'lib/docusign_esign/api/connect_api.rb', line 719 def retry_event_for_envelopes(account_id, connect_failure_filter) data, _status_code, _headers = retry_event_for_envelopes_with_http_info(account_id, connect_failure_filter) return data end |
#retry_event_for_envelopes_with_http_info(account_id, connect_failure_filter) ⇒ Array<(ConnectFailureResults, Fixnum, Hash)>
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.
729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 |
# File 'lib/docusign_esign/api/connect_api.rb', line 729 def retry_event_for_envelopes_with_http_info(account_id, connect_failure_filter) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: ConnectApi.retry_event_for_envelopes ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.retry_event_for_envelopes" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/connect/envelopes/retry_queue".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(connect_failure_filter) auth_names = [] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ConnectFailureResults') if @api_client.config.debugging @api_client.config.logger.debug "API called: ConnectApi#retry_event_for_envelopes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_configuration(account_id, connect_custom_configuration) ⇒ ConnectCustomConfiguration
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.
770 771 772 773 |
# File 'lib/docusign_esign/api/connect_api.rb', line 770 def update_configuration(account_id, connect_custom_configuration) data, _status_code, _headers = update_configuration_with_http_info(account_id, connect_custom_configuration) return data end |
#update_configuration_with_http_info(account_id, connect_custom_configuration) ⇒ Array<(ConnectCustomConfiguration, Fixnum, Hash)>
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.
780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 |
# File 'lib/docusign_esign/api/connect_api.rb', line 780 def update_configuration_with_http_info(account_id, connect_custom_configuration) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: ConnectApi.update_configuration ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.update_configuration" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/connect".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(connect_custom_configuration) auth_names = [] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ConnectCustomConfiguration') if @api_client.config.debugging @api_client.config.logger.debug "API called: ConnectApi#update_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |