Class: DocuSign_eSign::BulkEnvelopesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = BulkEnvelopesApi.default) ⇒ BulkEnvelopesApi

Returns a new instance of BulkEnvelopesApi.


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

def initialize(api_client = BulkEnvelopesApi.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/bulk_envelopes_api.rb', line 76

def api_client
  @api_client
end

Instance Method Details

#create_bulk_send_list(account_id, bulk_sending_list) ⇒ BulkSendingList

Creates a new bulk send list

Parameters:

  • account_id

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

  • bulk_sending_list (optional parameter)

Returns:


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

def create_bulk_send_list(, bulk_sending_list)
  data, _status_code, _headers = create_bulk_send_list_with_http_info(,  bulk_sending_list)
  return data
end

#create_bulk_send_list_with_http_info(account_id, bulk_sending_list) ⇒ Array<(BulkSendingList, Fixnum, Hash)>

Creates a new bulk send list

Parameters:

  • account_id

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

  • bulk_sending_list (optional parameter)

Returns:

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

    BulkSendingList 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/bulk_envelopes_api.rb', line 97

def create_bulk_send_list_with_http_info(, bulk_sending_list)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.create_bulk_send_list ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.create_bulk_send_list" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/bulk_send_lists".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(bulk_sending_list)
  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 => 'BulkSendingList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkEnvelopesApi#create_bulk_send_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_bulk_send_request(account_id, bulk_send_list_id, bulk_send_request) ⇒ BulkSendResponse

Uses the specified bulk send list to send the envelope specified in the payload

Parameters:

  • account_id

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

  • bulk_send_list_id
  • bulk_send_request (optional parameter)

Returns:


139
140
141
142
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 139

def create_bulk_send_request(, bulk_send_list_id, bulk_send_request)
  data, _status_code, _headers = create_bulk_send_request_with_http_info(, bulk_send_list_id,  bulk_send_request)
  return data
end

#create_bulk_send_request_with_http_info(account_id, bulk_send_list_id, bulk_send_request) ⇒ Array<(BulkSendResponse, Fixnum, Hash)>

Uses the specified bulk send list to send the envelope specified in the payload

Parameters:

  • account_id

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

  • bulk_send_list_id
  • bulk_send_request (optional parameter)

Returns:

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

    BulkSendResponse data, response status code and response headers


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
184
185
186
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 150

def create_bulk_send_request_with_http_info(, bulk_send_list_id, bulk_send_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.create_bulk_send_request ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.create_bulk_send_request" if .nil?
  # verify the required parameter 'bulk_send_list_id' is set
  fail ArgumentError, "Missing the required parameter 'bulk_send_list_id' when calling BulkEnvelopesApi.create_bulk_send_request" if bulk_send_list_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/send".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'bulkSendListId' + '}', bulk_send_list_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(bulk_send_request)
  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 => 'BulkSendResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkEnvelopesApi#create_bulk_send_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_bulk_send_test_request(account_id, bulk_send_list_id, bulk_send_request) ⇒ BulkSendTestResponse

Tests whether the specified bulk sending list can be used to send an envelope

Parameters:

  • account_id

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

  • bulk_send_list_id
  • bulk_send_request (optional parameter)

Returns:


194
195
196
197
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 194

def create_bulk_send_test_request(, bulk_send_list_id, bulk_send_request)
  data, _status_code, _headers = create_bulk_send_test_request_with_http_info(, bulk_send_list_id,  bulk_send_request)
  return data
end

#create_bulk_send_test_request_with_http_info(account_id, bulk_send_list_id, bulk_send_request) ⇒ Array<(BulkSendTestResponse, Fixnum, Hash)>

Tests whether the specified bulk sending list can be used to send an envelope

Parameters:

  • account_id

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

  • bulk_send_list_id
  • bulk_send_request (optional parameter)

Returns:

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

    BulkSendTestResponse data, response status code and response headers


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
236
237
238
239
240
241
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 205

def create_bulk_send_test_request_with_http_info(, bulk_send_list_id, bulk_send_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.create_bulk_send_test_request ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.create_bulk_send_test_request" if .nil?
  # verify the required parameter 'bulk_send_list_id' is set
  fail ArgumentError, "Missing the required parameter 'bulk_send_list_id' when calling BulkEnvelopesApi.create_bulk_send_test_request" if bulk_send_list_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/test".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'bulkSendListId' + '}', bulk_send_list_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(bulk_send_request)
  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 => 'BulkSendTestResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkEnvelopesApi#create_bulk_send_test_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_bulk_send_list(account_id, bulk_send_list_id) ⇒ BulkSendingListSummaries

Deletes an existing bulk send list

Parameters:

  • account_id

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

  • bulk_send_list_id

Returns:


248
249
250
251
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 248

def delete_bulk_send_list(, bulk_send_list_id)
  data, _status_code, _headers = delete_bulk_send_list_with_http_info(, bulk_send_list_id)
  return data
end

#delete_bulk_send_list_with_http_info(account_id, bulk_send_list_id) ⇒ Array<(BulkSendingListSummaries, Fixnum, Hash)>

Deletes an existing bulk send list

Parameters:

  • account_id

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

  • bulk_send_list_id

Returns:

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

    BulkSendingListSummaries data, response status code and response headers


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
288
289
290
291
292
293
294
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 258

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

#delete_recipients(account_id, envelope_id, recipient_id) ⇒ BulkRecipientsUpdateResponse

Deletes the bulk recipient file from an envelope. Deletes the bulk recipient file from an envelope. This cannot be used if the envelope has been sent. After using this, the `bulkRecipientsUri` property is not returned in subsequent GET calls for the envelope, but the recipient will remain as a bulk recipient.

Parameters:

  • account_id

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

  • envelope_id

    The envelopeId Guid of the envelope being accessed.

  • recipient_id

    The ID of the recipient being accessed.

Returns:


302
303
304
305
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 302

def delete_recipients(, envelope_id, recipient_id)
  data, _status_code, _headers = delete_recipients_with_http_info(, envelope_id, recipient_id)
  return data
end

#delete_recipients_with_http_info(account_id, envelope_id, recipient_id) ⇒ Array<(BulkRecipientsUpdateResponse, Fixnum, Hash)>

Deletes the bulk recipient file from an envelope. Deletes the bulk recipient file from an envelope. This cannot be used if the envelope has been sent. After using this, the &#x60;bulkRecipientsUri&#x60; property is not returned in subsequent GET calls for the envelope, but the recipient will remain as a bulk recipient.

Parameters:

  • account_id

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

  • envelope_id

    The envelopeId Guid of the envelope being accessed.

  • recipient_id

    The ID of the recipient being accessed.

Returns:


313
314
315
316
317
318
319
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
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 313

def delete_recipients_with_http_info(, envelope_id, recipient_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.delete_recipients ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.delete_recipients" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling BulkEnvelopesApi.delete_recipients" if envelope_id.nil?
  # verify the required parameter 'recipient_id' is set
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling BulkEnvelopesApi.delete_recipients" if recipient_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/bulk_recipients".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_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 => 'BulkRecipientsUpdateResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkEnvelopesApi#delete_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get(account_id, batch_id, options = DocuSign_eSign::GetOptions.default) ⇒ BulkEnvelopeStatus

Gets the status of a specified bulk send operation. Retrieves the status information of a single bulk recipient batch. A bulk recipient batch is the set of envelopes sent from a single bulk recipient file.

Parameters:

  • account_id

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

  • batch_id
  • DocuSign_eSign::GetOptions

    Options for modifying the behavior of the function.

Returns:


359
360
361
362
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 359

def get(, batch_id, options = DocuSign_eSign::GetOptions.default)
  data, _status_code, _headers = get_with_http_info(, batch_id, options)
  return data
end

#get_bulk_send_batch_status(account_id, bulk_send_batch_id) ⇒ BulkSendBatchStatus

Gets a specific bulk send batch status

Parameters:

  • account_id

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

  • bulk_send_batch_id

Returns:


416
417
418
419
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 416

def get_bulk_send_batch_status(, bulk_send_batch_id)
  data, _status_code, _headers = get_bulk_send_batch_status_with_http_info(, bulk_send_batch_id)
  return data
end

#get_bulk_send_batch_status_with_http_info(account_id, bulk_send_batch_id) ⇒ Array<(BulkSendBatchStatus, Fixnum, Hash)>

Gets a specific bulk send batch status

Parameters:

  • account_id

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

  • bulk_send_batch_id

Returns:

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

    BulkSendBatchStatus data, response status code and response headers


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
459
460
461
462
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 426

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

#get_bulk_send_batches(account_id, options = DocuSign_eSign::GetBulkSendBatchesOptions.default) ⇒ BulkSendBatchSummaries

Returns a list of bulk send batch satuses initiated by account.

Parameters:

  • account_id

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

  • DocuSign_eSign::GetBulkSendBatchesOptions

    Options for modifying the behavior of the function.

Returns:


469
470
471
472
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 469

def get_bulk_send_batches(, options = DocuSign_eSign::GetBulkSendBatchesOptions.default)
  data, _status_code, _headers = get_bulk_send_batches_with_http_info(, options)
  return data
end

#get_bulk_send_batches_with_http_info(account_id, options = DocuSign_eSign::GetBulkSendBatchesOptions.default) ⇒ Array<(BulkSendBatchSummaries, Fixnum, Hash)>

Returns a list of bulk send batch satuses initiated by account.

Parameters:

  • account_id

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

  • DocuSign_eSign::GetBulkSendBatchesOptions

    Options for modifying the behavior of the function.

Returns:

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

    BulkSendBatchSummaries data, response status code and response headers


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
511
512
513
514
515
516
517
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 479

def get_bulk_send_batches_with_http_info(, options = DocuSign_eSign::GetBulkSendBatchesOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.get_bulk_send_batches ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.get_bulk_send_batches" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/bulk_send_batch".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

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

#get_bulk_send_list(account_id, bulk_send_list_id) ⇒ BulkSendingList

Gets a specific bulk send list

Parameters:

  • account_id

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

  • bulk_send_list_id

Returns:


524
525
526
527
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 524

def get_bulk_send_list(, bulk_send_list_id)
  data, _status_code, _headers = get_bulk_send_list_with_http_info(, bulk_send_list_id)
  return data
end

#get_bulk_send_list_with_http_info(account_id, bulk_send_list_id) ⇒ Array<(BulkSendingList, Fixnum, Hash)>

Gets a specific bulk send list

Parameters:

  • account_id

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

  • bulk_send_list_id

Returns:

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

    BulkSendingList data, response status code and response headers


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
559
560
561
562
563
564
565
566
567
568
569
570
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 534

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

#get_bulk_send_lists(account_id) ⇒ BulkSendingListSummaries

Lists top-level details for all bulk send lists visible to the current user

Parameters:

  • account_id

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

Returns:


576
577
578
579
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 576

def get_bulk_send_lists()
  data, _status_code, _headers = get_bulk_send_lists_with_http_info()
  return data
end

#get_bulk_send_lists_with_http_info(account_id) ⇒ Array<(BulkSendingListSummaries, Fixnum, Hash)>

Lists top-level details for all bulk send lists visible to the current user

Parameters:

  • account_id

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

Returns:

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

    BulkSendingListSummaries data, response status code and response headers


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
610
611
612
613
614
615
616
617
618
619
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 585

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

#get_recipients(account_id, envelope_id, recipient_id, options = DocuSign_eSign::GetRecipientsOptions.default) ⇒ BulkRecipientsResponse

Gets the bulk recipient file from an envelope. Retrieves the bulk recipient file information from an envelope that has a bulk recipient.

Parameters:

  • account_id

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

  • envelope_id

    The envelopeId Guid of the envelope being accessed.

  • recipient_id

    The ID of the recipient being accessed.

  • DocuSign_eSign::GetRecipientsOptions

    Options for modifying the behavior of the function.

Returns:


628
629
630
631
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 628

def get_recipients(, envelope_id, recipient_id, options = DocuSign_eSign::GetRecipientsOptions.default)
  data, _status_code, _headers = get_recipients_with_http_info(, envelope_id, recipient_id, options)
  return data
end

#get_recipients_with_http_info(account_id, envelope_id, recipient_id, options = DocuSign_eSign::GetRecipientsOptions.default) ⇒ Array<(BulkRecipientsResponse, Fixnum, Hash)>

Gets the bulk recipient file from an envelope. Retrieves the bulk recipient file information from an envelope that has a bulk recipient.

Parameters:

  • account_id

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

  • envelope_id

    The envelopeId Guid of the envelope being accessed.

  • recipient_id

    The ID of the recipient being accessed.

  • DocuSign_eSign::GetRecipientsOptions

    Options for modifying the behavior of the function.

Returns:

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

    BulkRecipientsResponse data, response status code and response headers


640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 640

def get_recipients_with_http_info(, envelope_id, recipient_id, options = DocuSign_eSign::GetRecipientsOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.get_recipients ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.get_recipients" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling BulkEnvelopesApi.get_recipients" if envelope_id.nil?
  # verify the required parameter 'recipient_id' is set
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling BulkEnvelopesApi.get_recipients" if recipient_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/bulk_recipients".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)

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

#get_with_http_info(account_id, batch_id, options = DocuSign_eSign::GetOptions.default) ⇒ Array<(BulkEnvelopeStatus, Fixnum, Hash)>

Gets the status of a specified bulk send operation. Retrieves the status information of a single bulk recipient batch. A bulk recipient batch is the set of envelopes sent from a single bulk recipient file.

Parameters:

  • account_id

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

  • batch_id
  • DocuSign_eSign::GetOptions

    Options for modifying the behavior of the function.

Returns:

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

    BulkEnvelopeStatus data, 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
406
407
408
409
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 370

def get_with_http_info(, batch_id, options = DocuSign_eSign::GetOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.get ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.get" if .nil?
  # verify the required parameter 'batch_id' is set
  fail ArgumentError, "Missing the required parameter 'batch_id' when calling BulkEnvelopesApi.get" if batch_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/bulk_envelopes/{batchId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'batchId' + '}', batch_id.to_s)

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

#list(account_id, options = DocuSign_eSign::ListOptions.default) ⇒ BulkEnvelopesResponse

Gets status information about bulk recipient batches. Retrieves status information about all the bulk recipient batches. A bulk recipient batch is the set of envelopes sent from a single bulk recipient file. The response includes general information about each bulk recipient batch. The response returns information about the envelopes sent with bulk recipient batches, including the `batchId` property, which can be used to retrieve a more detailed status of individual bulk recipient batches.

Parameters:

  • account_id

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

  • DocuSign_eSign::ListOptions

    Options for modifying the behavior of the function.

Returns:


687
688
689
690
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 687

def list(, options = DocuSign_eSign::ListOptions.default)
  data, _status_code, _headers = list_with_http_info(, options)
  return data
end

#list_with_http_info(account_id, options = DocuSign_eSign::ListOptions.default) ⇒ Array<(BulkEnvelopesResponse, Fixnum, Hash)>

Gets status information about bulk recipient batches. Retrieves status information about all the bulk recipient batches. A bulk recipient batch is the set of envelopes sent from a single bulk recipient file. The response includes general information about each bulk recipient batch. The response returns information about the envelopes sent with bulk recipient batches, including the &#x60;batchId&#x60; property, which can be used to retrieve a more detailed status of individual bulk recipient batches.

Parameters:

  • account_id

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

  • DocuSign_eSign::ListOptions

    Options for modifying the behavior of the function.

Returns:

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

    BulkEnvelopesResponse data, response status code and response headers


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
724
725
726
727
728
729
730
731
732
733
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 697

def list_with_http_info(, options = DocuSign_eSign::ListOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.list ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.list" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/bulk_envelopes".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

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

#update_bulk_send_list(account_id, bulk_send_list_id, bulk_sending_list) ⇒ BulkSendingList

Updates an existing bulk send list. If send_envelope query string value is provided, will accept an empty payload and try to send the specified envelope

Parameters:

  • account_id

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

  • bulk_send_list_id
  • bulk_sending_list (optional parameter)

Returns:


741
742
743
744
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 741

def update_bulk_send_list(, bulk_send_list_id, bulk_sending_list)
  data, _status_code, _headers = update_bulk_send_list_with_http_info(, bulk_send_list_id,  bulk_sending_list)
  return data
end

#update_bulk_send_list_with_http_info(account_id, bulk_send_list_id, bulk_sending_list) ⇒ Array<(BulkSendingList, Fixnum, Hash)>

Updates an existing bulk send list. If send_envelope query string value is provided, will accept an empty payload and try to send the specified envelope

Parameters:

  • account_id

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

  • bulk_send_list_id
  • bulk_sending_list (optional parameter)

Returns:

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

    BulkSendingList data, response status code and response headers


752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 752

def update_bulk_send_list_with_http_info(, bulk_send_list_id, bulk_sending_list)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.update_bulk_send_list ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.update_bulk_send_list" if .nil?
  # verify the required parameter 'bulk_send_list_id' is set
  fail ArgumentError, "Missing the required parameter 'bulk_send_list_id' when calling BulkEnvelopesApi.update_bulk_send_list" if bulk_send_list_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'bulkSendListId' + '}', bulk_send_list_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(bulk_sending_list)
  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 => 'BulkSendingList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkEnvelopesApi#update_bulk_send_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_recipients(account_id, envelope_id, recipient_id, bulk_recipients_request) ⇒ BulkRecipientsSummaryResponse

Adds or replaces envelope bulk recipients. Updates the bulk recipients in a draft envelope using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv). The REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file.

Parameters:

  • account_id

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

  • envelope_id

    The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`

  • recipient_id

    A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.

  • bulk_recipients_request

Returns:


797
798
799
800
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 797

def update_recipients(, envelope_id, recipient_id, bulk_recipients_request)
  data, _status_code, _headers = update_recipients_with_http_info(, envelope_id, recipient_id,  bulk_recipients_request)
  return data
end

#update_recipients_with_http_info(account_id, envelope_id, recipient_id, bulk_recipients_request) ⇒ Array<(BulkRecipientsSummaryResponse, Fixnum, Hash)>

Adds or replaces envelope bulk recipients. Updates the bulk recipients in a draft envelope using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv). The REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file.

Parameters:

  • account_id

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

  • envelope_id

    The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`

  • recipient_id

    A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.

  • bulk_recipients_request

Returns:


809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 809

def update_recipients_with_http_info(, envelope_id, recipient_id, bulk_recipients_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.update_recipients ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.update_recipients" if .nil?
  # verify the required parameter 'envelope_id' is set
  fail ArgumentError, "Missing the required parameter 'envelope_id' when calling BulkEnvelopesApi.update_recipients" if envelope_id.nil?
  # verify the required parameter 'recipient_id' is set
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling BulkEnvelopesApi.update_recipients" if recipient_id.nil?
  # verify the required parameter 'bulk_recipients_request' is set
  fail ArgumentError, "Missing the required parameter 'bulk_recipients_request' when calling BulkEnvelopesApi.update_recipients" if bulk_recipients_request.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/bulk_recipients".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/csv'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(bulk_recipients_request)
  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 => 'BulkRecipientsSummaryResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkEnvelopesApi#update_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end