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.



20
21
22
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 20

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



18
19
20
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 18

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:



29
30
31
32
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 29

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



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 39

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:



81
82
83
84
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 81

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



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

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:



136
137
138
139
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 136

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



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 147

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:



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

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



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 200

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



243
244
245
246
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 243

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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 253

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:



295
296
297
298
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 295

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



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 304

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



346
347
348
349
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 346

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



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 357

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