Class: DocuSign_eSign::BulkProcessDataApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = BulkProcessDataApi.default) ⇒ BulkProcessDataApi

Returns a new instance of BulkProcessDataApi.



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

def initialize(api_client = BulkProcessDataApi.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_process_data_api.rb', line 18

def api_client
  @api_client
end

Instance Method Details

#create_bulk_process_request(account_id, process_action) ⇒ nil

Uses the specified bulk envelopes list to update the envelopes specified in the payload

Parameters:

  • account_id —

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

  • process_action

Returns:

  • (nil) 


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

def create_bulk_process_request(, process_action)
  create_bulk_process_request_with_http_info(, process_action)
  return nil
end

#create_bulk_process_request_to_queue(account_id, bulk_process_list_id, process_action, bulk_process_request) ⇒ BulkProcessResponse

Uses the specified bulk envelopes list to update the envelopes specified in the payload

Parameters:

  • account_id —

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

  • bulk_process_list_id
  • process_action
  • bulk_process_request (optional parameter)

Returns:



83
84
85
86
 
# File 'lib/docusign_esign/api/bulk_process_data_api.rb', line 83

def create_bulk_process_request_to_queue(, bulk_process_list_id, process_action, bulk_process_request)
  data, _status_code, _headers = create_bulk_process_request_to_queue_with_http_info(, bulk_process_list_id, process_action,  bulk_process_request)
  return data
end

#create_bulk_process_request_to_queue_with_http_info(account_id, bulk_process_list_id, process_action, bulk_process_request) ⇒ Array<(BulkProcessResponse, Fixnum, Hash)>

Uses the specified bulk envelopes list to update the envelopes specified in the payload

Parameters:

  • account_id —

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

  • bulk_process_list_id
  • process_action
  • bulk_process_request (optional parameter)

Returns:

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

    BulkProcessResponse data, response status code and response headers



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
129
130
131
132
133
 
# File 'lib/docusign_esign/api/bulk_process_data_api.rb', line 95

def create_bulk_process_request_to_queue_with_http_info(, bulk_process_list_id, process_action, bulk_process_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkProcessDataApi.create_bulk_process_request_to_queue ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkProcessDataApi.create_bulk_process_request_to_queue" if .nil?
  # verify the required parameter 'bulk_process_list_id' is set
  fail ArgumentError, "Missing the required parameter 'bulk_process_list_id' when calling BulkProcessDataApi.create_bulk_process_request_to_queue" if bulk_process_list_id.nil?
  # verify the required parameter 'process_action' is set
  fail ArgumentError, "Missing the required parameter 'process_action' when calling BulkProcessDataApi.create_bulk_process_request_to_queue" if process_action.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/bulk_process_data/actions/{processAction}/{bulkProcessListId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'bulkProcessListId' + '}', bulk_process_list_id.to_s).sub('{' + 'processAction' + '}', process_action.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_process_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 => 'BulkProcessResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkProcessDataApi#create_bulk_process_request_to_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_bulk_process_request_with_http_info(account_id, process_action) ⇒ Array<(nil, Fixnum, Hash)>

Uses the specified bulk envelopes list to update the envelopes specified in the payload

Parameters:

  • account_id —

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

  • process_action

Returns:

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

    nil, 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
74
 
# File 'lib/docusign_esign/api/bulk_process_data_api.rb', line 39

def create_bulk_process_request_with_http_info(, process_action)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkProcessDataApi.create_bulk_process_request ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkProcessDataApi.create_bulk_process_request" if .nil?
  # verify the required parameter 'process_action' is set
  fail ArgumentError, "Missing the required parameter 'process_action' when calling BulkProcessDataApi.create_bulk_process_request" if process_action.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/bulk_process_data/actions/{processAction}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'processAction' + '}', process_action.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(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkProcessDataApi#create_bulk_process_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_bulk_process_list(account_id, bulk_process_list_id, process_action) ⇒ BulkProcessResult

Deletes a specific bulk process list

Parameters:

  • account_id —

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

  • bulk_process_list_id
  • process_action

Returns:



141
142
143
144
 
# File 'lib/docusign_esign/api/bulk_process_data_api.rb', line 141

def delete_bulk_process_list(, bulk_process_list_id, process_action)
  data, _status_code, _headers = delete_bulk_process_list_with_http_info(, bulk_process_list_id, process_action)
  return data
end

#delete_bulk_process_list_with_http_info(account_id, bulk_process_list_id, process_action) ⇒ Array<(BulkProcessResult, Fixnum, Hash)>

Deletes a specific bulk process list

Parameters:

  • account_id —

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

  • bulk_process_list_id
  • process_action

Returns:

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

    BulkProcessResult data, response status code and response headers



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
187
188
189
190
 
# File 'lib/docusign_esign/api/bulk_process_data_api.rb', line 152

def delete_bulk_process_list_with_http_info(, bulk_process_list_id, process_action)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkProcessDataApi.delete_bulk_process_list ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkProcessDataApi.delete_bulk_process_list" if .nil?
  # verify the required parameter 'bulk_process_list_id' is set
  fail ArgumentError, "Missing the required parameter 'bulk_process_list_id' when calling BulkProcessDataApi.delete_bulk_process_list" if bulk_process_list_id.nil?
  # verify the required parameter 'process_action' is set
  fail ArgumentError, "Missing the required parameter 'process_action' when calling BulkProcessDataApi.delete_bulk_process_list" if process_action.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/bulk_process_data/actions/{processAction}/{bulkProcessListId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'bulkProcessListId' + '}', bulk_process_list_id.to_s).sub('{' + 'processAction' + '}', process_action.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 => 'BulkProcessResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkProcessDataApi#delete_bulk_process_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_bulk_process_lists(account_id, process_action, bulk_processing_lists) ⇒ BulkProcessResult

Deletes a specific bulk process list

Parameters:

  • account_id —

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

  • process_action
  • bulk_processing_lists (optional parameter)

Returns:



198
199
200
201
 
# File 'lib/docusign_esign/api/bulk_process_data_api.rb', line 198

def delete_bulk_process_lists(, process_action, bulk_processing_lists)
  data, _status_code, _headers = delete_bulk_process_lists_with_http_info(, process_action,  bulk_processing_lists)
  return data
end

#delete_bulk_process_lists_with_http_info(account_id, process_action, bulk_processing_lists) ⇒ Array<(BulkProcessResult, Fixnum, Hash)>

Deletes a specific bulk process list

Parameters:

  • account_id —

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

  • process_action
  • bulk_processing_lists (optional parameter)

Returns:

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

    BulkProcessResult data, response status code and response headers



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
242
243
244
245
 
# File 'lib/docusign_esign/api/bulk_process_data_api.rb', line 209

def delete_bulk_process_lists_with_http_info(, process_action, bulk_processing_lists)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkProcessDataApi.delete_bulk_process_lists ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkProcessDataApi.delete_bulk_process_lists" if .nil?
  # verify the required parameter 'process_action' is set
  fail ArgumentError, "Missing the required parameter 'process_action' when calling BulkProcessDataApi.delete_bulk_process_lists" if process_action.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/bulk_process_data/actions/{processAction}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'processAction' + '}', process_action.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_processing_lists)
  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 => 'BulkProcessResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkProcessDataApi#delete_bulk_process_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_bulk_process_list(account_id, bulk_process_list_id, process_action) ⇒ nil

Gets a specific bulk process list

Parameters:

  • account_id —

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

  • bulk_process_list_id
  • process_action

Returns:

  • (nil) 


253
254
255
256
 
# File 'lib/docusign_esign/api/bulk_process_data_api.rb', line 253

def get_bulk_process_list(, bulk_process_list_id, process_action)
  get_bulk_process_list_with_http_info(, bulk_process_list_id, process_action)
  return nil
end

#get_bulk_process_list_with_http_info(account_id, bulk_process_list_id, process_action) ⇒ Array<(nil, Fixnum, Hash)>

Gets a specific bulk process list

Parameters:

  • account_id —

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

  • bulk_process_list_id
  • process_action

Returns:

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

    nil, response status code and response headers



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
295
296
297
298
299
300
301
 
# File 'lib/docusign_esign/api/bulk_process_data_api.rb', line 264

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

#get_bulk_process_lists(account_id, process_action) ⇒ BulkProcessingListSummaries

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

Parameters:

  • account_id —

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

  • process_action

Returns:



308
309
310
311
 
# File 'lib/docusign_esign/api/bulk_process_data_api.rb', line 308

def get_bulk_process_lists(, process_action)
  data, _status_code, _headers = get_bulk_process_lists_with_http_info(, process_action)
  return data
end

#get_bulk_process_lists_with_http_info(account_id, process_action) ⇒ Array<(BulkProcessingListSummaries, Fixnum, Hash)>

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

Parameters:

  • account_id —

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

  • process_action

Returns:



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

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

#update_bulk_process_list(account_id, bulk_process_list_id, process_action) ⇒ nil

Updates a specific bulk process list

Parameters:

  • account_id —

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

  • bulk_process_list_id
  • process_action

Returns:

  • (nil) 


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

def update_bulk_process_list(, bulk_process_list_id, process_action)
  update_bulk_process_list_with_http_info(, bulk_process_list_id, process_action)
  return nil
end

#update_bulk_process_list_with_http_info(account_id, bulk_process_list_id, process_action) ⇒ Array<(nil, Fixnum, Hash)>

Updates a specific bulk process list

Parameters:

  • account_id —

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

  • bulk_process_list_id
  • process_action

Returns:

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

    nil, response status code and response headers



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
410
 
# File 'lib/docusign_esign/api/bulk_process_data_api.rb', line 373

def update_bulk_process_list_with_http_info(, bulk_process_list_id, process_action)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkProcessDataApi.update_bulk_process_list ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkProcessDataApi.update_bulk_process_list" if .nil?
  # verify the required parameter 'bulk_process_list_id' is set
  fail ArgumentError, "Missing the required parameter 'bulk_process_list_id' when calling BulkProcessDataApi.update_bulk_process_list" if bulk_process_list_id.nil?
  # verify the required parameter 'process_action' is set
  fail ArgumentError, "Missing the required parameter 'process_action' when calling BulkProcessDataApi.update_bulk_process_list" if process_action.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/bulk_process_data/actions/{processAction}/{bulkProcessListId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'bulkProcessListId' + '}', bulk_process_list_id.to_s).sub('{' + 'processAction' + '}', process_action.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkProcessDataApi#update_bulk_process_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end