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.



41
42
43
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 41

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



39
40
41
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 39

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:

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

Returns:



50
51
52
53
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 50

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:

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

Returns:

  • BulkSendingList data, response status code and response headers



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 60

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:

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

Returns:



102
103
104
105
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 102

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:

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

Returns:

  • BulkSendResponse data, response status code and response headers



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 113

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:

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

Returns:



157
158
159
160
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 157

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:

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

Returns:

  • BulkSendTestResponse data, response status code and response headers



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

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:

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

Returns:



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

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:

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

Returns:

  • BulkSendingListSummaries data, response status code and response headers



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

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

#get_bulk_send_batch_status(account_id, bulk_send_batch_id) ⇒ BulkSendBatchStatus

Gets a specific bulk send batch status

Parameters:

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

Returns:



264
265
266
267
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 264

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:

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

Returns:

  • BulkSendBatchStatus data, response status code and response headers



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 274

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:

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

  • Options for modifying the behavior of the function.

Returns:



317
318
319
320
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 317

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:

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

  • Options for modifying the behavior of the function.

Returns:

  • BulkSendBatchSummaries data, response status code and response headers



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 327

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[:'search_text'] = options.search_text if !options.search_text.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:

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

Returns:



373
374
375
376
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 373

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:

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

Returns:

  • BulkSendingList data, response status code and response headers



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
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 383

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:

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

Returns:



425
426
427
428
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 425

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:

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

Returns:

  • BulkSendingListSummaries data, response status code and response headers



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
463
464
465
466
467
468
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 434

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

#update_bulk_send_batch_status(account_id, bulk_send_batch_id, bulk_send_batch_request) ⇒ BulkSendBatchStatus

Put/Update a specific bulk send batch status

Parameters:

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

Returns:



476
477
478
479
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 476

def update_bulk_send_batch_status(, bulk_send_batch_id, bulk_send_batch_request)
  data, _status_code, _headers = update_bulk_send_batch_status_with_http_info(, bulk_send_batch_id,  bulk_send_batch_request)
  return data
end

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

Put/Update a specific bulk send batch status

Parameters:

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

Returns:

  • BulkSendBatchStatus data, response status code and response headers



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
518
519
520
521
522
523
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 487

def update_bulk_send_batch_status_with_http_info(, bulk_send_batch_id, bulk_send_batch_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.update_bulk_send_batch_status ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.update_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.update_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 = @api_client.object_to_http_body(bulk_send_batch_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 => 'BulkSendBatchStatus')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkEnvelopesApi#update_bulk_send_batch_status\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:

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

Returns:



531
532
533
534
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 531

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:

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

Returns:

  • BulkSendingList data, response status code and response headers



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
571
572
573
574
575
576
577
578
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 542

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