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.



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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



75
76
77
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 75

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:



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

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



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 96

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:



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

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



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

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:



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

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



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

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:



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

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



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

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_envelopes(account_id, bulk_send_batch_id, options = DocuSign_eSign::GetBulkSendBatchEnvelopesOptions.default) ⇒ EnvelopesInformation

Gets envelopes from a specific bulk send batch

Parameters:

  • account_id —

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

  • bulk_send_batch_id
  • DocuSign_eSign::GetBulkSendBatchEnvelopesOptions —

    Options for modifying the behavior of the function.

Returns:



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

def get_bulk_send_batch_envelopes(, bulk_send_batch_id, options = DocuSign_eSign::GetBulkSendBatchEnvelopesOptions.default)
  data, _status_code, _headers = get_bulk_send_batch_envelopes_with_http_info(, bulk_send_batch_id, options)
  return data
end

#get_bulk_send_batch_envelopes_with_http_info(account_id, bulk_send_batch_id, options = DocuSign_eSign::GetBulkSendBatchEnvelopesOptions.default) ⇒ Array<(EnvelopesInformation, Fixnum, Hash)>

Gets envelopes from a specific bulk send batch

Parameters:

  • account_id —

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

  • bulk_send_batch_id
  • DocuSign_eSign::GetBulkSendBatchEnvelopesOptions —

    Options for modifying the behavior of the function.

Returns:

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

    EnvelopesInformation data, response status code and response headers



312
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
352
353
354
355
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 312

def get_bulk_send_batch_envelopes_with_http_info(, bulk_send_batch_id, options = DocuSign_eSign::GetBulkSendBatchEnvelopesOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.get_bulk_send_batch_envelopes ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.get_bulk_send_batch_envelopes" 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_envelopes" if bulk_send_batch_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/envelopes".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'bulkSendBatchId' + '}', bulk_send_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[:'order'] = options.order if !options.order.nil?
  query_params[:'order_by'] = options.order_by if !options.order_by.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 => 'EnvelopesInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkEnvelopesApi#get_bulk_send_batch_envelopes\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:

  • account_id —

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

  • bulk_send_batch_id

Returns:



362
363
364
365
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 362

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



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

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:



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

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



425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 425

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[:'from_date'] = options.from_date if !options.from_date.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?
  query_params[:'to_date'] = options.to_date if !options.to_date.nil?
  query_params[:'user_id'] = options.user_id if !options.user_id.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:



474
475
476
477
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 474

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



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

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:



526
527
528
529
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 526

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



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

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_action(account_id, bulk_action, bulk_send_batch_id, bulk_send_batch_action_request) ⇒ BulkSendBatchStatus

Initiate a specific bulk send batch action

Parameters:

  • account_id —

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

  • bulk_action
  • bulk_send_batch_id
  • bulk_send_batch_action_request (optional parameter)

Returns:



578
579
580
581
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 578

def update_bulk_send_batch_action(, bulk_action, bulk_send_batch_id, bulk_send_batch_action_request)
  data, _status_code, _headers = update_bulk_send_batch_action_with_http_info(, bulk_action, bulk_send_batch_id,  bulk_send_batch_action_request)
  return data
end

#update_bulk_send_batch_action_with_http_info(account_id, bulk_action, bulk_send_batch_id, bulk_send_batch_action_request) ⇒ Array<(BulkSendBatchStatus, Fixnum, Hash)>

Initiate a specific bulk send batch action

Parameters:

  • account_id —

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

  • bulk_action
  • bulk_send_batch_id
  • bulk_send_batch_action_request (optional parameter)

Returns:

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

    BulkSendBatchStatus data, response status code and response headers



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
620
621
622
623
624
625
626
627
628
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 590

def update_bulk_send_batch_action_with_http_info(, bulk_action, bulk_send_batch_id, bulk_send_batch_action_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.update_bulk_send_batch_action ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.update_bulk_send_batch_action" if .nil?
  # verify the required parameter 'bulk_action' is set
  fail ArgumentError, "Missing the required parameter 'bulk_action' when calling BulkEnvelopesApi.update_bulk_send_batch_action" if bulk_action.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_action" if bulk_send_batch_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/{bulkAction}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'bulkAction' + '}', bulk_action.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_action_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_action\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:

  • account_id —

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

  • bulk_send_batch_id
  • bulk_send_batch_request (optional parameter)

Returns:



636
637
638
639
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 636

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:

  • account_id —

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

  • bulk_send_batch_id
  • bulk_send_batch_request (optional parameter)

Returns:

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

    BulkSendBatchStatus data, response status code and response headers



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
681
682
683
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 647

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:

  • account_id —

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

  • bulk_send_list_id
  • bulk_sending_list (optional parameter)

Returns:



691
692
693
694
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 691

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



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
734
735
736
737
738
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 702

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