Class: DocuSign_eSign::ConnectApi

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/api/connect_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ConnectApi.default) ⇒ ConnectApi

Returns a new instance of ConnectApi.



101
102
103
 
# File 'lib/docusign_esign/api/connect_api.rb', line 101

def initialize(api_client = ConnectApi.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



99
100
101
 
# File 'lib/docusign_esign/api/connect_api.rb', line 99

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.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • connect_custom_configuration (optional parameter)

Returns:



110
111
112
113
 
# File 'lib/docusign_esign/api/connect_api.rb', line 110

def create_configuration(, connect_custom_configuration)
  data, _status_code, _headers = create_configuration_with_http_info(,  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.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • connect_custom_configuration (optional parameter)

Returns:

  • (Array<(ConnectCustomConfiguration, Fixnum, Hash)>) —

    ConnectCustomConfiguration data, response status code and response headers



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/docusign_esign/api/connect_api.rb', line 120

def create_configuration_with_http_info(, 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 .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/connect".sub('{format}','json').sub('{' + 'accountId' + '}', .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

#create_connect_o_auth_config(account_id, connect_o_auth_config) ⇒ ConnectOAuthConfig

Sets the Connect OAuth Config for the account.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • connect_o_auth_config (optional parameter)

Returns:



161
162
163
164
 
# File 'lib/docusign_esign/api/connect_api.rb', line 161

def create_connect_o_auth_config(, connect_o_auth_config)
  data, _status_code, _headers = create_connect_o_auth_config_with_http_info(,  connect_o_auth_config)
  return data
end

#create_connect_o_auth_config_with_http_info(account_id, connect_o_auth_config) ⇒ Array<(ConnectOAuthConfig, Fixnum, Hash)>

Sets the Connect OAuth Config for the account.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • connect_o_auth_config (optional parameter)

Returns:

  • (Array<(ConnectOAuthConfig, Fixnum, Hash)>) —

    ConnectOAuthConfig data, response status code and response headers



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/docusign_esign/api/connect_api.rb', line 171

def create_connect_o_auth_config_with_http_info(, connect_o_auth_config)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConnectApi.create_connect_o_auth_config ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.create_connect_o_auth_config" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/connect/oauth".sub('{format}','json').sub('{' + 'accountId' + '}', .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_o_auth_config)
  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 => 'ConnectOAuthConfig')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConnectApi#create_connect_o_auth_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_connect_secret(account_id) ⇒ nil

Generates a new connect HMAC Secret.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

Returns:

  • (nil) 


211
212
213
214
 
# File 'lib/docusign_esign/api/connect_api.rb', line 211

def create_connect_secret()
  create_connect_secret_with_http_info()
  return nil
end

#create_connect_secret_with_http_info(account_id) ⇒ Array<(nil, Fixnum, Hash)>

Generates a new connect HMAC Secret.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/docusign_esign/api/connect_api.rb', line 220

def create_connect_secret_with_http_info()
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConnectApi.create_connect_secret ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.create_connect_secret" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/connect/secret".sub('{format}','json').sub('{' + 'accountId' + '}', .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(:POST, 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#create_connect_secret\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.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • connect_id —

    The ID of the custom Connect configuration being accessed.

Returns:

  • (nil) 


260
261
262
263
 
# File 'lib/docusign_esign/api/connect_api.rb', line 260

def delete_configuration(, connect_id)
  delete_configuration_with_http_info(, 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.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • connect_id —

    The ID of the custom Connect configuration being accessed.

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/docusign_esign/api/connect_api.rb', line 270

def delete_configuration_with_http_info(, 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 .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' + '}', .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_connect_o_auth_config(account_id) ⇒ nil

Sets the Connect OAuth Config for the account.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

Returns:

  • (nil) 


311
312
313
314
 
# File 'lib/docusign_esign/api/connect_api.rb', line 311

def delete_connect_o_auth_config()
  delete_connect_o_auth_config_with_http_info()
  return nil
end

#delete_connect_o_auth_config_with_http_info(account_id) ⇒ Array<(nil, Fixnum, Hash)>

Sets the Connect OAuth Config for the account.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/docusign_esign/api/connect_api.rb', line 320

def delete_connect_o_auth_config_with_http_info()
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConnectApi.delete_connect_o_auth_config ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.delete_connect_o_auth_config" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/connect/oauth".sub('{format}','json').sub('{' + 'accountId' + '}', .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_connect_o_auth_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_connect_secret(account_id, key_id) ⇒ nil

Delete the connect HMAC Secret for AccountID

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • key_id

Returns:

  • (nil) 


360
361
362
363
 
# File 'lib/docusign_esign/api/connect_api.rb', line 360

def delete_connect_secret(, key_id)
  delete_connect_secret_with_http_info(, key_id)
  return nil
end

#delete_connect_secret_with_http_info(account_id, key_id) ⇒ Array<(nil, Fixnum, Hash)>

Delete the connect HMAC Secret for AccountID

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • key_id

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/docusign_esign/api/connect_api.rb', line 370

def delete_connect_secret_with_http_info(, key_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConnectApi.delete_connect_secret ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.delete_connect_secret" if .nil?
  # verify the required parameter 'key_id' is set
  fail ArgumentError, "Missing the required parameter 'key_id' when calling ConnectApi.delete_connect_secret" if key_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/connect/secret/{keyId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'keyId' + '}', key_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_connect_secret\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_event_failure_log(account_id, failure_id) ⇒ ConnectDeleteFailureResult

Deletes a Connect failure log entry. Deletes the Connect failure log information for the specified entry.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • failure_id —

    The ID of the failed connect log entry.

Returns:



412
413
414
415
 
# File 'lib/docusign_esign/api/connect_api.rb', line 412

def delete_event_failure_log(, failure_id)
  data, _status_code, _headers = delete_event_failure_log_with_http_info(, failure_id)
  return data
end

#delete_event_failure_log_with_http_info(account_id, failure_id) ⇒ Array<(ConnectDeleteFailureResult, Fixnum, Hash)>

Deletes a Connect failure log entry. Deletes the Connect failure log information for the specified entry.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • failure_id —

    The ID of the failed connect log entry.

Returns:

  • (Array<(ConnectDeleteFailureResult, Fixnum, Hash)>) —

    ConnectDeleteFailureResult data, response status code and response headers



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/docusign_esign/api/connect_api.rb', line 422

def delete_event_failure_log_with_http_info(, 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 .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' + '}', .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,
    :return_type => 'ConnectDeleteFailureResult')
  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.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • log_id —

    The ID of the connect log entry

Returns:

  • (nil) 


465
466
467
468
 
# File 'lib/docusign_esign/api/connect_api.rb', line 465

def delete_event_log(, log_id)
  delete_event_log_with_http_info(, 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.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • log_id —

    The ID of the connect log entry

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'lib/docusign_esign/api/connect_api.rb', line 475

def delete_event_log_with_http_info(, 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 .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' + '}', .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.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

Returns:

  • (nil) 


516
517
518
519
 
# File 'lib/docusign_esign/api/connect_api.rb', line 516

def delete_event_logs()
  delete_event_logs_with_http_info()
  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 &#x60;enableLog&#x60; property in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'lib/docusign_esign/api/connect_api.rb', line 525

def delete_event_logs_with_http_info()
  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 .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/connect/logs".sub('{format}','json').sub('{' + 'accountId' + '}', .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

#delete_mobile_notifiers(account_id, mobile_notifier_configuration_information) ⇒ MobileNotifierConfigurationInformation

Reserved Reserved:

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • mobile_notifier_configuration_information (optional parameter)

Returns:



565
566
567
568
 
# File 'lib/docusign_esign/api/connect_api.rb', line 565

def delete_mobile_notifiers(, mobile_notifier_configuration_information)
  data, _status_code, _headers = delete_mobile_notifiers_with_http_info(,  mobile_notifier_configuration_information)
  return data
end

#delete_mobile_notifiers_with_http_info(account_id, mobile_notifier_configuration_information) ⇒ Array<(MobileNotifierConfigurationInformation, Fixnum, Hash)>

Reserved Reserved:

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • mobile_notifier_configuration_information (optional parameter)

Returns:



575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
 
# File 'lib/docusign_esign/api/connect_api.rb', line 575

def delete_mobile_notifiers_with_http_info(, mobile_notifier_configuration_information)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConnectApi.delete_mobile_notifiers ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.delete_mobile_notifiers" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/connect/mobile_notifiers".sub('{format}','json').sub('{' + 'accountId' + '}', .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(mobile_notifier_configuration_information)
  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,
    :return_type => 'MobileNotifierConfigurationInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConnectApi#delete_mobile_notifiers\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.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • connect_id —

    The ID of the custom Connect configuration being accessed.

Returns:



616
617
618
619
 
# File 'lib/docusign_esign/api/connect_api.rb', line 616

def get_configuration(, connect_id)
  data, _status_code, _headers = get_configuration_with_http_info(, 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.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • connect_id —

    The ID of the custom Connect configuration being accessed.

Returns:

  • (Array<(ConnectConfigResults, Fixnum, Hash)>) —

    ConnectConfigResults data, response status code and response headers



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
660
661
662
 
# File 'lib/docusign_esign/api/connect_api.rb', line 626

def get_configuration_with_http_info(, 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 .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' + '}', .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_connect_all_users(account_id, connect_id, options = DocuSign_eSign::GetConnectAllUsersOptions.default) ⇒ IntegratedConnectUserInfoList

Returns all users from the configured Connect service.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • connect_id —

    The ID of the custom Connect configuration being accessed.

  • DocuSign_eSign::GetConnectAllUsersOptions —

    Options for modifying the behavior of the function.

Returns:



670
671
672
673
 
# File 'lib/docusign_esign/api/connect_api.rb', line 670

def get_connect_all_users(, connect_id, options = DocuSign_eSign::GetConnectAllUsersOptions.default)
  data, _status_code, _headers = get_connect_all_users_with_http_info(, connect_id, options)
  return data
end

#get_connect_all_users_with_http_info(account_id, connect_id, options = DocuSign_eSign::GetConnectAllUsersOptions.default) ⇒ Array<(IntegratedConnectUserInfoList, Fixnum, Hash)>

Returns all users from the configured Connect service.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • connect_id —

    The ID of the custom Connect configuration being accessed.

  • DocuSign_eSign::GetConnectAllUsersOptions —

    Options for modifying the behavior of the function.

Returns:



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
713
714
715
716
717
718
719
720
721
722
723
 
# File 'lib/docusign_esign/api/connect_api.rb', line 681

def get_connect_all_users_with_http_info(, connect_id, options = DocuSign_eSign::GetConnectAllUsersOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConnectApi.get_connect_all_users ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.get_connect_all_users" if .nil?
  # verify the required parameter 'connect_id' is set
  fail ArgumentError, "Missing the required parameter 'connect_id' when calling ConnectApi.get_connect_all_users" if connect_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/connect/{connectId}/all/users".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'connectId' + '}', connect_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'count'] = options.count if !options.count.nil?
  query_params[:'domain_users_only'] = options.domain_users_only if !options.domain_users_only.nil?
  query_params[:'email_substring'] = options.email_substring if !options.email_substring.nil?
  query_params[:'start_position'] = options.start_position if !options.start_position.nil?
  query_params[:'status'] = options.status if !options.status.nil?
  query_params[:'user_name_substring'] = options.user_name_substring if !options.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 => 'IntegratedConnectUserInfoList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConnectApi#get_connect_all_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_connect_o_auth_config(account_id) ⇒ ConnectOAuthConfig

Sets the Connect OAuth Config for the account.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

Returns:



729
730
731
732
 
# File 'lib/docusign_esign/api/connect_api.rb', line 729

def get_connect_o_auth_config()
  data, _status_code, _headers = get_connect_o_auth_config_with_http_info()
  return data
end

#get_connect_o_auth_config_with_http_info(account_id) ⇒ Array<(ConnectOAuthConfig, Fixnum, Hash)>

Sets the Connect OAuth Config for the account.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

Returns:

  • (Array<(ConnectOAuthConfig, Fixnum, Hash)>) —

    ConnectOAuthConfig data, response status code and response headers



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
764
765
766
767
768
769
770
771
772
 
# File 'lib/docusign_esign/api/connect_api.rb', line 738

def get_connect_o_auth_config_with_http_info()
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConnectApi.get_connect_o_auth_config ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.get_connect_o_auth_config" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/connect/oauth".sub('{format}','json').sub('{' + 'accountId' + '}', .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 => 'ConnectOAuthConfig')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConnectApi#get_connect_o_auth_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_connect_secret(account_id) ⇒ nil

Get the connect HMAC Secrets for AccountID

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

Returns:

  • (nil) 


778
779
780
781
 
# File 'lib/docusign_esign/api/connect_api.rb', line 778

def get_connect_secret()
  get_connect_secret_with_http_info()
  return nil
end

#get_connect_secret_with_http_info(account_id) ⇒ Array<(nil, Fixnum, Hash)>

Get the connect HMAC Secrets for AccountID

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



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
815
816
817
818
819
820
 
# File 'lib/docusign_esign/api/connect_api.rb', line 787

def get_connect_secret_with_http_info()
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConnectApi.get_connect_secret ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.get_connect_secret" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/connect/secret".sub('{format}','json').sub('{' + 'accountId' + '}', .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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConnectApi#get_connect_secret\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.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • log_id —

    The ID of the connect log entry

  • DocuSign_eSign::GetEventLogOptions —

    Options for modifying the behavior of the function.

Returns:



828
829
830
831
 
# File 'lib/docusign_esign/api/connect_api.rb', line 828

def get_event_log(, log_id, options = DocuSign_eSign::GetEventLogOptions.default)
  data, _status_code, _headers = get_event_log_with_http_info(, log_id, options)
  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 &#x60;enableLog&#x60; 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:

  • account_id —

    The external account number (int) or account ID Guid.

  • log_id —

    The ID of the connect log entry

  • DocuSign_eSign::GetEventLogOptions —

    Options for modifying the behavior of the function.

Returns:

  • (Array<(ConnectLog, Fixnum, Hash)>) —

    ConnectLog data, response status code and response headers



839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
 
# File 'lib/docusign_esign/api/connect_api.rb', line 839

def get_event_log_with_http_info(, log_id, options = 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 .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' + '}', .to_s).sub('{' + 'logId' + '}', log_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'additional_info'] = options.additional_info if !options.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.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

Returns:



882
883
884
885
 
# File 'lib/docusign_esign/api/connect_api.rb', line 882

def list_configurations()
  data, _status_code, _headers = list_configurations_with_http_info()
  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.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

Returns:

  • (Array<(ConnectConfigResults, Fixnum, Hash)>) —

    ConnectConfigResults data, response status code and response headers



891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
 
# File 'lib/docusign_esign/api/connect_api.rb', line 891

def list_configurations_with_http_info()
  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 .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/connect".sub('{format}','json').sub('{' + 'accountId' + '}', .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.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • DocuSign_eSign::ListEventFailureLogsOptions —

    Options for modifying the behavior of the function.

Returns:



932
933
934
935
 
# File 'lib/docusign_esign/api/connect_api.rb', line 932

def list_event_failure_logs(, options = DocuSign_eSign::ListEventFailureLogsOptions.default)
  data, _status_code, _headers = list_event_failure_logs_with_http_info(, options)
  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.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • DocuSign_eSign::ListEventFailureLogsOptions —

    Options for modifying the behavior of the function.

Returns:

  • (Array<(ConnectLogs, Fixnum, Hash)>) —

    ConnectLogs data, response status code and response headers



942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
 
# File 'lib/docusign_esign/api/connect_api.rb', line 942

def list_event_failure_logs_with_http_info(, options = 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 .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/connect/failures".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'from_date'] = options.from_date if !options.from_date.nil?
  query_params[:'to_date'] = options.to_date if !options.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.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • DocuSign_eSign::ListEventLogsOptions —

    Options for modifying the behavior of the function.

Returns:



985
986
987
988
 
# File 'lib/docusign_esign/api/connect_api.rb', line 985

def list_event_logs(, options = DocuSign_eSign::ListEventLogsOptions.default)
  data, _status_code, _headers = list_event_logs_with_http_info(, options)
  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 &#x60;enableLog&#x60; 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:

  • account_id —

    The external account number (int) or account ID Guid.

  • DocuSign_eSign::ListEventLogsOptions —

    Options for modifying the behavior of the function.

Returns:

  • (Array<(ConnectLogs, Fixnum, Hash)>) —

    ConnectLogs data, response status code and response headers



995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
 
# File 'lib/docusign_esign/api/connect_api.rb', line 995

def list_event_logs_with_http_info(, options = 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 .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/connect/logs".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'from_date'] = options.from_date if !options.from_date.nil?
  query_params[:'to_date'] = options.to_date if !options.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_mobile_notifiers(account_id) ⇒ MobileNotifierConfigurationInformation

Reserved Reserved:

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

Returns:



1037
1038
1039
1040
 
# File 'lib/docusign_esign/api/connect_api.rb', line 1037

def list_mobile_notifiers()
  data, _status_code, _headers = list_mobile_notifiers_with_http_info()
  return data
end

#list_mobile_notifiers_with_http_info(account_id) ⇒ Array<(MobileNotifierConfigurationInformation, Fixnum, Hash)>

Reserved Reserved:

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

Returns:



1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
 
# File 'lib/docusign_esign/api/connect_api.rb', line 1046

def list_mobile_notifiers_with_http_info()
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConnectApi.list_mobile_notifiers ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.list_mobile_notifiers" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/connect/mobile_notifiers".sub('{format}','json').sub('{' + 'accountId' + '}', .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 => 'MobileNotifierConfigurationInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConnectApi#list_mobile_notifiers\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.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • connect_id —

    The ID of the custom Connect configuration being accessed.

  • DocuSign_eSign::ListUsersOptions —

    Options for modifying the behavior of the function.

Returns:



1088
1089
1090
1091
 
# File 'lib/docusign_esign/api/connect_api.rb', line 1088

def list_users(, connect_id, options = DocuSign_eSign::ListUsersOptions.default)
  data, _status_code, _headers = list_users_with_http_info(, connect_id, options)
  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.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • connect_id —

    The ID of the custom Connect configuration being accessed.

  • DocuSign_eSign::ListUsersOptions —

    Options for modifying the behavior of the function.

Returns:

  • (Array<(IntegratedUserInfoList, Fixnum, Hash)>) —

    IntegratedUserInfoList data, response status code and response headers



1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
 
# File 'lib/docusign_esign/api/connect_api.rb', line 1099

def list_users_with_http_info(, connect_id, options = 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 .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' + '}', .to_s).sub('{' + 'connectId' + '}', connect_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'count'] = options.count if !options.count.nil?
  query_params[:'email_substring'] = options.email_substring if !options.email_substring.nil?
  query_params[:'list_included_users'] = options.list_included_users if !options.list_included_users.nil?
  query_params[:'start_position'] = options.start_position if !options.start_position.nil?
  query_params[:'status'] = options.status if !options.status.nil?
  query_params[:'user_name_substring'] = options.user_name_substring if !options.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.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:



1148
1149
1150
1151
 
# File 'lib/docusign_esign/api/connect_api.rb', line 1148

def retry_event_for_envelope(, envelope_id)
  data, _status_code, _headers = retry_event_for_envelope_with_http_info(, 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.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • envelope_id —

    The envelopeId Guid of the envelope being accessed.

Returns:

  • (Array<(ConnectFailureResults, Fixnum, Hash)>) —

    ConnectFailureResults data, response status code and response headers



1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
 
# File 'lib/docusign_esign/api/connect_api.rb', line 1158

def retry_event_for_envelope_with_http_info(, 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 .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' + '}', .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.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • connect_failure_filter (optional parameter)

Returns:



1201
1202
1203
1204
 
# File 'lib/docusign_esign/api/connect_api.rb', line 1201

def retry_event_for_envelopes(, connect_failure_filter)
  data, _status_code, _headers = retry_event_for_envelopes_with_http_info(,  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.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • connect_failure_filter (optional parameter)

Returns:

  • (Array<(ConnectFailureResults, Fixnum, Hash)>) —

    ConnectFailureResults data, response status code and response headers



1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
 
# File 'lib/docusign_esign/api/connect_api.rb', line 1211

def retry_event_for_envelopes_with_http_info(, 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 .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/connect/envelopes/retry_queue".sub('{format}','json').sub('{' + 'accountId' + '}', .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.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • connect_custom_configuration (optional parameter)

Returns:



1252
1253
1254
1255
 
# File 'lib/docusign_esign/api/connect_api.rb', line 1252

def update_configuration(, connect_custom_configuration)
  data, _status_code, _headers = update_configuration_with_http_info(,  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.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • connect_custom_configuration (optional parameter)

Returns:

  • (Array<(ConnectCustomConfiguration, Fixnum, Hash)>) —

    ConnectCustomConfiguration data, response status code and response headers



1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
 
# File 'lib/docusign_esign/api/connect_api.rb', line 1262

def update_configuration_with_http_info(, 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 .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/connect".sub('{format}','json').sub('{' + 'accountId' + '}', .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

#update_connect_o_auth_config(account_id, connect_o_auth_config) ⇒ ConnectOAuthConfig

Updates the existing Connect OAuth Config for the account.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • connect_o_auth_config (optional parameter)

Returns:



1303
1304
1305
1306
 
# File 'lib/docusign_esign/api/connect_api.rb', line 1303

def update_connect_o_auth_config(, connect_o_auth_config)
  data, _status_code, _headers = update_connect_o_auth_config_with_http_info(,  connect_o_auth_config)
  return data
end

#update_connect_o_auth_config_with_http_info(account_id, connect_o_auth_config) ⇒ Array<(ConnectOAuthConfig, Fixnum, Hash)>

Updates the existing Connect OAuth Config for the account.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • connect_o_auth_config (optional parameter)

Returns:

  • (Array<(ConnectOAuthConfig, Fixnum, Hash)>) —

    ConnectOAuthConfig data, response status code and response headers



1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
 
# File 'lib/docusign_esign/api/connect_api.rb', line 1313

def update_connect_o_auth_config_with_http_info(, connect_o_auth_config)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConnectApi.update_connect_o_auth_config ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.update_connect_o_auth_config" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/connect/oauth".sub('{format}','json').sub('{' + 'accountId' + '}', .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_o_auth_config)
  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 => 'ConnectOAuthConfig')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConnectApi#update_connect_o_auth_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_mobile_notifiers(account_id, mobile_notifier_configuration_information) ⇒ MobileNotifierConfigurationInformation

Reserved Reserved:

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • mobile_notifier_configuration_information (optional parameter)

Returns:



1354
1355
1356
1357
 
# File 'lib/docusign_esign/api/connect_api.rb', line 1354

def update_mobile_notifiers(, mobile_notifier_configuration_information)
  data, _status_code, _headers = update_mobile_notifiers_with_http_info(,  mobile_notifier_configuration_information)
  return data
end

#update_mobile_notifiers_with_http_info(account_id, mobile_notifier_configuration_information) ⇒ Array<(MobileNotifierConfigurationInformation, Fixnum, Hash)>

Reserved Reserved:

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • mobile_notifier_configuration_information (optional parameter)

Returns:



1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
 
# File 'lib/docusign_esign/api/connect_api.rb', line 1364

def update_mobile_notifiers_with_http_info(, mobile_notifier_configuration_information)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ConnectApi.update_mobile_notifiers ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.update_mobile_notifiers" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/connect/mobile_notifiers".sub('{format}','json').sub('{' + 'accountId' + '}', .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(mobile_notifier_configuration_information)
  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 => 'MobileNotifierConfigurationInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConnectApi#update_mobile_notifiers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end