Class: DocuSign_Admin::BulkImportsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_admin/api/bulk_imports_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = BulkImportsApi.default) ⇒ BulkImportsApi

Returns a new instance of BulkImportsApi.



20
21
22
# File 'lib/docusign_admin/api/bulk_imports_api.rb', line 20

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



18
19
20
# File 'lib/docusign_admin/api/bulk_imports_api.rb', line 18

def api_client
  @api_client
end

Instance Method Details

#add_bulk_account_settings_import(organization_id, file_csv) ⇒ OrganizationAccountSettingsImportResponse

Creates a new account settings import request. Required scopes: account_write

Parameters:

  • organization_id

    The organization ID Guid

  • file_csv

    CSV file.

Returns:



29
30
31
32
# File 'lib/docusign_admin/api/bulk_imports_api.rb', line 29

def (organization_id, file_csv)
  data, _status_code, _headers = (organization_id, file_csv)
  return data
end

#add_bulk_account_settings_import_with_http_info(organization_id, file_csv) ⇒ Array<(OrganizationAccountSettingsImportResponse, Fixnum, Hash)>

Creates a new account settings import request. Required scopes: account_write

Parameters:

  • organization_id

    The organization ID Guid

  • file_csv

    CSV file.

Returns:



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
75
76
77
78
# File 'lib/docusign_admin/api/bulk_imports_api.rb', line 39

def (organization_id, file_csv)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkImportsApi.add_bulk_account_settings_import ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling BulkImportsApi.add_bulk_account_settings_import" if organization_id.nil?
  # verify the required parameter 'file_csv' is set
  fail ArgumentError, "Missing the required parameter 'file_csv' when calling BulkImportsApi.add_bulk_account_settings_import" if file_csv.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/imports/account_settings".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params["file.csv"] = file_csv

  # 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,
    :return_type => 'OrganizationAccountSettingsImportResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkImportsApi#add_bulk_account_settings_import\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_bulk_import_add_users_request(organization_id, file_csv) ⇒ OrganizationImportResponse

Import request for adding users to accounts within the organization. Required scopes: user_write

Parameters:

  • organization_id

    The organization ID Guid

  • file_csv

    CSV file.

Returns:



85
86
87
88
# File 'lib/docusign_admin/api/bulk_imports_api.rb', line 85

def create_bulk_import_add_users_request(organization_id, file_csv)
  data, _status_code, _headers = create_bulk_import_add_users_request_with_http_info(organization_id, file_csv)
  return data
end

#create_bulk_import_add_users_request_with_http_info(organization_id, file_csv) ⇒ Array<(OrganizationImportResponse, Fixnum, Hash)>

Import request for adding users to accounts within the organization. Required scopes: user_write

Parameters:

  • organization_id

    The organization ID Guid

  • file_csv

    CSV file.

Returns:

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

    OrganizationImportResponse 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
134
# File 'lib/docusign_admin/api/bulk_imports_api.rb', line 95

def create_bulk_import_add_users_request_with_http_info(organization_id, file_csv)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkImportsApi.create_bulk_import_add_users_request ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling BulkImportsApi.create_bulk_import_add_users_request" if organization_id.nil?
  # verify the required parameter 'file_csv' is set
  fail ArgumentError, "Missing the required parameter 'file_csv' when calling BulkImportsApi.create_bulk_import_add_users_request" if file_csv.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/imports/bulk_users/add".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params["file.csv"] = file_csv

  # 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,
    :return_type => 'OrganizationImportResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkImportsApi#create_bulk_import_add_users_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_bulk_import_close_users_request(organization_id, file_csv) ⇒ OrganizationImportResponse

Closes the Bulk User Import request Required scopes: user_write

Parameters:

  • organization_id

    The organization ID Guid

  • file_csv

    CSV file.

Returns:



141
142
143
144
# File 'lib/docusign_admin/api/bulk_imports_api.rb', line 141

def create_bulk_import_close_users_request(organization_id, file_csv)
  data, _status_code, _headers = create_bulk_import_close_users_request_with_http_info(organization_id, file_csv)
  return data
end

#create_bulk_import_close_users_request_with_http_info(organization_id, file_csv) ⇒ Array<(OrganizationImportResponse, Fixnum, Hash)>

Closes the Bulk User Import request Required scopes: user_write

Parameters:

  • organization_id

    The organization ID Guid

  • file_csv

    CSV file.

Returns:

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

    OrganizationImportResponse data, response status code and response headers



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
# File 'lib/docusign_admin/api/bulk_imports_api.rb', line 151

def create_bulk_import_close_users_request_with_http_info(organization_id, file_csv)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkImportsApi.create_bulk_import_close_users_request ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling BulkImportsApi.create_bulk_import_close_users_request" if organization_id.nil?
  # verify the required parameter 'file_csv' is set
  fail ArgumentError, "Missing the required parameter 'file_csv' when calling BulkImportsApi.create_bulk_import_close_users_request" if file_csv.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/imports/bulk_users/close".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params["file.csv"] = file_csv

  # 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,
    :return_type => 'OrganizationImportResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkImportsApi#create_bulk_import_close_users_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_bulk_import_external_close_users_request(organization_id) ⇒ OrganizationImportResponse

Closes memberships which are not in an account which is part of the organization, but which do have email addresses which are @ a verified reserved web domain which belongs to the organization Required scopes: user_write

Parameters:

  • organization_id

    The organization ID Guid

Returns:



196
197
198
199
# File 'lib/docusign_admin/api/bulk_imports_api.rb', line 196

def create_bulk_import_external_close_users_request(organization_id)
  data, _status_code, _headers = create_bulk_import_external_close_users_request_with_http_info(organization_id)
  return data
end

#create_bulk_import_external_close_users_request_with_http_info(organization_id) ⇒ Array<(OrganizationImportResponse, Fixnum, Hash)>

Closes memberships which are not in an account which is part of the organization, but which do have email addresses which are @ a verified reserved web domain which belongs to the organization Required scopes: user_write

Parameters:

  • organization_id

    The organization ID Guid

Returns:

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

    OrganizationImportResponse data, response status code and response headers



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
# File 'lib/docusign_admin/api/bulk_imports_api.rb', line 205

def create_bulk_import_external_close_users_request_with_http_info(organization_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkImportsApi.create_bulk_import_external_close_users_request ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling BulkImportsApi.create_bulk_import_external_close_users_request" if organization_id.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/imports/bulk_users/close_external".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['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,
    :return_type => 'OrganizationImportResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkImportsApi#create_bulk_import_external_close_users_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_bulk_import_single_account_add_users_request(organization_id, account_id, file_csv) ⇒ OrganizationImportResponse

Import request for adding user to a single account within the organization. Allows upload of user information without requiring an AccountId column Required scopes: user_write

Parameters:

  • organization_id

    The organization ID Guid

  • account_id

    The account ID Guid

  • file_csv

    CSV file.

Returns:



249
250
251
252
# File 'lib/docusign_admin/api/bulk_imports_api.rb', line 249

def (organization_id, , file_csv)
  data, _status_code, _headers = (organization_id, , file_csv)
  return data
end

#create_bulk_import_single_account_add_users_request_with_http_info(organization_id, account_id, file_csv) ⇒ Array<(OrganizationImportResponse, Fixnum, Hash)>

Import request for adding user to a single account within the organization. Allows upload of user information without requiring an AccountId column Required scopes: user_write

Parameters:

  • organization_id

    The organization ID Guid

  • account_id

    The account ID Guid

  • file_csv

    CSV file.

Returns:

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

    OrganizationImportResponse data, response status code and response headers



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
# File 'lib/docusign_admin/api/bulk_imports_api.rb', line 260

def (organization_id, , file_csv)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkImportsApi.create_bulk_import_single_account_add_users_request ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling BulkImportsApi.create_bulk_import_single_account_add_users_request" if organization_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkImportsApi.create_bulk_import_single_account_add_users_request" if .nil?
  # verify the required parameter 'file_csv' is set
  fail ArgumentError, "Missing the required parameter 'file_csv' when calling BulkImportsApi.create_bulk_import_single_account_add_users_request" if file_csv.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/accounts/{accountId}/imports/bulk_users/add".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params["file.csv"] = file_csv

  # 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,
    :return_type => 'OrganizationImportResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkImportsApi#create_bulk_import_single_account_add_users_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_bulk_import_single_account_update_users_request(organization_id, account_id, file_csv) ⇒ OrganizationImportResponse

Import request for updating users for a single account within the organization. Allows upload of user information without requiring an AccountId column Required scopes: user_write

Parameters:

  • organization_id

    The organization ID Guid

  • account_id

    The account ID Guid

  • file_csv

    CSV file.

Returns:



309
310
311
312
# File 'lib/docusign_admin/api/bulk_imports_api.rb', line 309

def (organization_id, , file_csv)
  data, _status_code, _headers = (organization_id, , file_csv)
  return data
end

#create_bulk_import_single_account_update_users_request_with_http_info(organization_id, account_id, file_csv) ⇒ Array<(OrganizationImportResponse, Fixnum, Hash)>

Import request for updating users for a single account within the organization. Allows upload of user information without requiring an AccountId column Required scopes: user_write

Parameters:

  • organization_id

    The organization ID Guid

  • account_id

    The account ID Guid

  • file_csv

    CSV file.

Returns:

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

    OrganizationImportResponse data, response status code and response headers



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
356
357
358
359
360
361
# File 'lib/docusign_admin/api/bulk_imports_api.rb', line 320

def (organization_id, , file_csv)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkImportsApi.create_bulk_import_single_account_update_users_request ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling BulkImportsApi.create_bulk_import_single_account_update_users_request" if organization_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkImportsApi.create_bulk_import_single_account_update_users_request" if .nil?
  # verify the required parameter 'file_csv' is set
  fail ArgumentError, "Missing the required parameter 'file_csv' when calling BulkImportsApi.create_bulk_import_single_account_update_users_request" if file_csv.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/accounts/{accountId}/imports/bulk_users/update".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params["file.csv"] = file_csv

  # 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,
    :return_type => 'OrganizationImportResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkImportsApi#create_bulk_import_single_account_update_users_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_bulk_import_update_users_request(organization_id, file_csv) ⇒ OrganizationImportResponse

Import request for updating users to accounts within the organization. Required scopes: user_write

Parameters:

  • organization_id

    The organization ID Guid

  • file_csv

    CSV file.

Returns:



368
369
370
371
# File 'lib/docusign_admin/api/bulk_imports_api.rb', line 368

def create_bulk_import_update_users_request(organization_id, file_csv)
  data, _status_code, _headers = create_bulk_import_update_users_request_with_http_info(organization_id, file_csv)
  return data
end

#create_bulk_import_update_users_request_with_http_info(organization_id, file_csv) ⇒ Array<(OrganizationImportResponse, Fixnum, Hash)>

Import request for updating users to accounts within the organization. Required scopes: user_write

Parameters:

  • organization_id

    The organization ID Guid

  • file_csv

    CSV file.

Returns:

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

    OrganizationImportResponse data, response status code and response headers



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
411
412
413
414
415
416
417
# File 'lib/docusign_admin/api/bulk_imports_api.rb', line 378

def create_bulk_import_update_users_request_with_http_info(organization_id, file_csv)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkImportsApi.create_bulk_import_update_users_request ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling BulkImportsApi.create_bulk_import_update_users_request" if organization_id.nil?
  # verify the required parameter 'file_csv' is set
  fail ArgumentError, "Missing the required parameter 'file_csv' when calling BulkImportsApi.create_bulk_import_update_users_request" if file_csv.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/imports/bulk_users/update".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params["file.csv"] = file_csv

  # 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,
    :return_type => 'OrganizationImportResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkImportsApi#create_bulk_import_update_users_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_bulk_account_settings_import(organization_id, import_id) ⇒ Object

Deletes a Bulk Account Settings Import request Required scopes: account_write

Parameters:

  • organization_id

    The organization ID Guid

  • import_id

    The import ID Guid for the request

Returns:

  • (Object)


424
425
426
427
# File 'lib/docusign_admin/api/bulk_imports_api.rb', line 424

def (organization_id, import_id)
  data, _status_code, _headers = (organization_id, import_id)
  return data
end

#delete_bulk_account_settings_import_with_http_info(organization_id, import_id) ⇒ Array<(Object, Fixnum, Hash)>

Deletes a Bulk Account Settings Import request Required scopes: account_write

Parameters:

  • organization_id

    The organization ID Guid

  • import_id

    The import ID Guid for the request

Returns:

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

    Object 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
469
470
471
472
# File 'lib/docusign_admin/api/bulk_imports_api.rb', line 434

def (organization_id, import_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkImportsApi.delete_bulk_account_settings_import ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling BulkImportsApi.delete_bulk_account_settings_import" if organization_id.nil?
  # verify the required parameter 'import_id' is set
  fail ArgumentError, "Missing the required parameter 'import_id' when calling BulkImportsApi.delete_bulk_account_settings_import" if import_id.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/imports/account_settings/{importId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'importId' + '}', import_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['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 => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkImportsApi#delete_bulk_account_settings_import\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_bulk_user_import(organization_id, import_id) ⇒ Object

Deletes a User Import request Required scopes: user_write

Parameters:

  • organization_id

    The organization ID Guid

  • import_id

    The import ID Guid for the request

Returns:

  • (Object)


479
480
481
482
# File 'lib/docusign_admin/api/bulk_imports_api.rb', line 479

def delete_bulk_user_import(organization_id, import_id)
  data, _status_code, _headers = delete_bulk_user_import_with_http_info(organization_id, import_id)
  return data
end

#delete_bulk_user_import_with_http_info(organization_id, import_id) ⇒ Array<(Object, Fixnum, Hash)>

Deletes a User Import request Required scopes: user_write

Parameters:

  • organization_id

    The organization ID Guid

  • import_id

    The import ID Guid for the request

Returns:

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

    Object data, response status code and response headers



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
524
525
526
527
# File 'lib/docusign_admin/api/bulk_imports_api.rb', line 489

def delete_bulk_user_import_with_http_info(organization_id, import_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkImportsApi.delete_bulk_user_import ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling BulkImportsApi.delete_bulk_user_import" if organization_id.nil?
  # verify the required parameter 'import_id' is set
  fail ArgumentError, "Missing the required parameter 'import_id' when calling BulkImportsApi.delete_bulk_user_import" if import_id.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/imports/bulk_users/{importId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'importId' + '}', import_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['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 => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkImportsApi#delete_bulk_user_import\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_bulk_account_settings_import(organization_id, import_id) ⇒ OrganizationAccountSettingsImportResponse

Returns the details/metadata for a Bulk Account Settings Import request Required scopes: account_read

Parameters:

  • organization_id

    The organization ID Guid

  • import_id

    The import ID Guid for the request

Returns:



534
535
536
537
# File 'lib/docusign_admin/api/bulk_imports_api.rb', line 534

def (organization_id, import_id)
  data, _status_code, _headers = (organization_id, import_id)
  return data
end

#get_bulk_account_settings_import_with_http_info(organization_id, import_id) ⇒ Array<(OrganizationAccountSettingsImportResponse, Fixnum, Hash)>

Returns the details/metadata for a Bulk Account Settings Import request Required scopes: account_read

Parameters:

  • organization_id

    The organization ID Guid

  • import_id

    The import ID Guid for the request

Returns:



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
579
580
581
582
# File 'lib/docusign_admin/api/bulk_imports_api.rb', line 544

def (organization_id, import_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkImportsApi.get_bulk_account_settings_import ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling BulkImportsApi.get_bulk_account_settings_import" if organization_id.nil?
  # verify the required parameter 'import_id' is set
  fail ArgumentError, "Missing the required parameter 'import_id' when calling BulkImportsApi.get_bulk_account_settings_import" if import_id.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/imports/account_settings/{importId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'importId' + '}', import_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['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 => 'OrganizationAccountSettingsImportResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkImportsApi#get_bulk_account_settings_import\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_bulk_account_settings_imports(organization_id) ⇒ Array<OrganizationAccountSettingsImportResponse>

Returns the details/metadata for Bulk Account Settings Import requests in the organization Required scopes: account_read

Parameters:

  • organization_id

    The organization ID Guid

Returns:



588
589
590
591
# File 'lib/docusign_admin/api/bulk_imports_api.rb', line 588

def (organization_id)
  data, _status_code, _headers = (organization_id)
  return data
end

#get_bulk_account_settings_imports_with_http_info(organization_id) ⇒ Array<(Array<OrganizationAccountSettingsImportResponse>, Fixnum, Hash)>

Returns the details/metadata for Bulk Account Settings Import requests in the organization Required scopes: account_read

Parameters:

  • organization_id

    The organization ID Guid

Returns:



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
629
630
631
632
633
# File 'lib/docusign_admin/api/bulk_imports_api.rb', line 597

def (organization_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkImportsApi.get_bulk_account_settings_imports ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling BulkImportsApi.get_bulk_account_settings_imports" if organization_id.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/imports/account_settings".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['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 => 'Array<OrganizationAccountSettingsImportResponse>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkImportsApi#get_bulk_account_settings_imports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_bulk_user_import_csv(organization_id, import_id) ⇒ Object

Returns a text/csv file with user details for a User Import request Required scopes: user_read

Parameters:

  • organization_id

    The organization ID Guid

  • import_id

    The import ID Guid for the request

Returns:

  • (Object)


640
641
642
643
# File 'lib/docusign_admin/api/bulk_imports_api.rb', line 640

def get_bulk_user_import_csv(organization_id, import_id)
  data, _status_code, _headers = get_bulk_user_import_csv_with_http_info(organization_id, import_id)
  return data
end

#get_bulk_user_import_csv_with_http_info(organization_id, import_id) ⇒ Array<(Object, Fixnum, Hash)>

Returns a text/csv file with user details for a User Import request Required scopes: user_read

Parameters:

  • organization_id

    The organization ID Guid

  • import_id

    The import ID Guid for the request

Returns:

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

    Object data, response status code and response headers



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
684
685
686
687
688
# File 'lib/docusign_admin/api/bulk_imports_api.rb', line 650

def get_bulk_user_import_csv_with_http_info(organization_id, import_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkImportsApi.get_bulk_user_import_csv ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling BulkImportsApi.get_bulk_user_import_csv" if organization_id.nil?
  # verify the required parameter 'import_id' is set
  fail ArgumentError, "Missing the required parameter 'import_id' when calling BulkImportsApi.get_bulk_user_import_csv" if import_id.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/imports/bulk_users/{importId}/results_csv".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'importId' + '}', import_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/csv'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['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 => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkImportsApi#get_bulk_user_import_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_bulk_user_import_request(organization_id, import_id) ⇒ OrganizationImportResponse

Returns the details/metadata for a User Import request Required scopes: user_read

Parameters:

  • organization_id

    The organization ID Guid

  • import_id

    The import ID Guid for the request

Returns:



695
696
697
698
# File 'lib/docusign_admin/api/bulk_imports_api.rb', line 695

def get_bulk_user_import_request(organization_id, import_id)
  data, _status_code, _headers = get_bulk_user_import_request_with_http_info(organization_id, import_id)
  return data
end

#get_bulk_user_import_request_with_http_info(organization_id, import_id) ⇒ Array<(OrganizationImportResponse, Fixnum, Hash)>

Returns the details/metadata for a User Import request Required scopes: user_read

Parameters:

  • organization_id

    The organization ID Guid

  • import_id

    The import ID Guid for the request

Returns:

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

    OrganizationImportResponse data, response status code and response headers



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
739
740
741
742
743
# File 'lib/docusign_admin/api/bulk_imports_api.rb', line 705

def get_bulk_user_import_request_with_http_info(organization_id, import_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkImportsApi.get_bulk_user_import_request ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling BulkImportsApi.get_bulk_user_import_request" if organization_id.nil?
  # verify the required parameter 'import_id' is set
  fail ArgumentError, "Missing the required parameter 'import_id' when calling BulkImportsApi.get_bulk_user_import_request" if import_id.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/imports/bulk_users/{importId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'importId' + '}', import_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['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 => 'OrganizationImportResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkImportsApi#get_bulk_user_import_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_bulk_user_import_requests(organization_id) ⇒ OrganizationImportsResponse

Returns the details/metadata for Bulk User Import requests in the organization Required scopes: user_read

Parameters:

  • organization_id

    The organization ID Guid

Returns:



749
750
751
752
# File 'lib/docusign_admin/api/bulk_imports_api.rb', line 749

def get_bulk_user_import_requests(organization_id)
  data, _status_code, _headers = get_bulk_user_import_requests_with_http_info(organization_id)
  return data
end

#get_bulk_user_import_requests_with_http_info(organization_id) ⇒ Array<(OrganizationImportsResponse, Fixnum, Hash)>

Returns the details/metadata for Bulk User Import requests in the organization Required scopes: user_read

Parameters:

  • organization_id

    The organization ID Guid

Returns:



758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
# File 'lib/docusign_admin/api/bulk_imports_api.rb', line 758

def get_bulk_user_import_requests_with_http_info(organization_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkImportsApi.get_bulk_user_import_requests ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling BulkImportsApi.get_bulk_user_import_requests" if organization_id.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/imports/bulk_users".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['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 => 'OrganizationImportsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkImportsApi#get_bulk_user_import_requests\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end