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.


78
79
80
# File 'lib/docusign_esign/api/connect_api.rb', line 78

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client


76
77
78
# File 'lib/docusign_esign/api/connect_api.rb', line 76

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:


87
88
89
90
# File 'lib/docusign_esign/api/connect_api.rb', line 87

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


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
131
# File 'lib/docusign_esign/api/connect_api.rb', line 97

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

#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)

138
139
140
141
# File 'lib/docusign_esign/api/connect_api.rb', line 138

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


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
183
# File 'lib/docusign_esign/api/connect_api.rb', line 148

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_event_failure_log(account_id, failure_id) ⇒ nil

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:

  • (nil)

190
191
192
193
# File 'lib/docusign_esign/api/connect_api.rb', line 190

def delete_event_failure_log(, failure_id)
  delete_event_failure_log_with_http_info(, 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.

Parameters:

  • account_id

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

  • failure_id

    The ID of the failed connect log entry.

Returns:

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

    nil, response status code and response headers


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
235
# File 'lib/docusign_esign/api/connect_api.rb', line 200

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)
  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)

242
243
244
245
# File 'lib/docusign_esign/api/connect_api.rb', line 242

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


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
287
# File 'lib/docusign_esign/api/connect_api.rb', line 252

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)

293
294
295
296
# File 'lib/docusign_esign/api/connect_api.rb', line 293

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


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
335
# File 'lib/docusign_esign/api/connect_api.rb', line 302

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:


342
343
344
345
# File 'lib/docusign_esign/api/connect_api.rb', line 342

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:


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

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:


393
394
395
396
# File 'lib/docusign_esign/api/connect_api.rb', line 393

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


403
404
405
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
# File 'lib/docusign_esign/api/connect_api.rb', line 403

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_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:


447
448
449
450
# File 'lib/docusign_esign/api/connect_api.rb', line 447

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


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
493
494
495
# File 'lib/docusign_esign/api/connect_api.rb', line 458

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:


501
502
503
504
# File 'lib/docusign_esign/api/connect_api.rb', line 501

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


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

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:


551
552
553
554
# File 'lib/docusign_esign/api/connect_api.rb', line 551

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


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

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:


604
605
606
607
# File 'lib/docusign_esign/api/connect_api.rb', line 604

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


614
615
616
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
# File 'lib/docusign_esign/api/connect_api.rb', line 614

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:


656
657
658
659
# File 'lib/docusign_esign/api/connect_api.rb', line 656

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:


665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
# File 'lib/docusign_esign/api/connect_api.rb', line 665

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_tests(account_id, connect_id) ⇒ ResourceInformation

Test connect configuration.

Parameters:

  • account_id

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

  • connect_id

    The ID of the custom Connect configuration being accessed.

Returns:


706
707
708
709
# File 'lib/docusign_esign/api/connect_api.rb', line 706

def list_tests(, connect_id)
  data, _status_code, _headers = list_tests_with_http_info(, connect_id)
  return data
end

#list_tests_with_http_info(account_id, connect_id) ⇒ Array<(ResourceInformation, Fixnum, Hash)>

Test connect configuration.

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<(ResourceInformation, Fixnum, Hash)>)

    ResourceInformation data, response status code and response headers


716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
# File 'lib/docusign_esign/api/connect_api.rb', line 716

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


760
761
762
763
# File 'lib/docusign_esign/api/connect_api.rb', line 760

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


771
772
773
774
775
776
777
778
779
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
# File 'lib/docusign_esign/api/connect_api.rb', line 771

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:


820
821
822
823
# File 'lib/docusign_esign/api/connect_api.rb', line 820

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


830
831
832
833
834
835
836
837
838
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
# File 'lib/docusign_esign/api/connect_api.rb', line 830

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:


873
874
875
876
# File 'lib/docusign_esign/api/connect_api.rb', line 873

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


883
884
885
886
887
888
889
890
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
# File 'lib/docusign_esign/api/connect_api.rb', line 883

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:


924
925
926
927
# File 'lib/docusign_esign/api/connect_api.rb', line 924

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


934
935
936
937
938
939
940
941
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
# File 'lib/docusign_esign/api/connect_api.rb', line 934

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_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:


975
976
977
978
# File 'lib/docusign_esign/api/connect_api.rb', line 975

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:


985
986
987
988
989
990
991
992
993
994
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
# File 'lib/docusign_esign/api/connect_api.rb', line 985

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