Class: DocuSign_Admin::BulkExportsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = BulkExportsApi.default) ⇒ BulkExportsApi

Returns a new instance of BulkExportsApi.



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

def initialize(api_client = BulkExportsApi.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_admin/api/bulk_exports_api.rb', line 18

def api_client
  @api_client
end

Instance Method Details

#create_account_settings_export(organization_id, request) ⇒ OrganizationExportResponse

Creates a new Account Setting Export request. Required scopes: account_read

Parameters:

  • organization_id —

    The organization ID Guid

  • request —

    Request body containing details about the accounts be compared

Returns:



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

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

#create_account_settings_export_with_http_info(organization_id, request) ⇒ Array<(OrganizationExportResponse, Fixnum, Hash)>

Creates a new Account Setting Export request. Required scopes: account_read

Parameters:

  • organization_id —

    The organization ID Guid

  • request —

    Request body containing details about the accounts be compared

Returns:

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

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

def (organization_id, request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkExportsApi.create_account_settings_export ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling BulkExportsApi.create_account_settings_export" if organization_id.nil?
  # verify the required parameter 'request' is set
  fail ArgumentError, "Missing the required parameter 'request' when calling BulkExportsApi.create_account_settings_export" if request.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/exports/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 = @api_client.object_to_http_body(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 => 'OrganizationExportResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkExportsApi#create_account_settings_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_user_list_export(organization_id, request) ⇒ OrganizationExportResponse

Creates a new User List Export request. Required scopes: user_read

Parameters:

  • organization_id —

    The organization ID Guid

  • request —

    Request body containing details about what is to be exported

Returns:



84
85
86
87
 
# File 'lib/docusign_admin/api/bulk_exports_api.rb', line 84

def create_user_list_export(organization_id, request)
  data, _status_code, _headers = create_user_list_export_with_http_info(organization_id,  request)
  return data
end

#create_user_list_export_with_http_info(organization_id, request) ⇒ Array<(OrganizationExportResponse, Fixnum, Hash)>

Creates a new User List Export request. Required scopes: user_read

Parameters:

  • organization_id —

    The organization ID Guid

  • request —

    Request body containing details about what is to be exported

Returns:

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

    OrganizationExportResponse data, response status code and response headers



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
129
130
131
132
 
# File 'lib/docusign_admin/api/bulk_exports_api.rb', line 94

def create_user_list_export_with_http_info(organization_id, request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkExportsApi.create_user_list_export ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling BulkExportsApi.create_user_list_export" if organization_id.nil?
  # verify the required parameter 'request' is set
  fail ArgumentError, "Missing the required parameter 'request' when calling BulkExportsApi.create_user_list_export" if request.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/exports/user_list".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 = @api_client.object_to_http_body(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 => 'OrganizationExportResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkExportsApi#create_user_list_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_account_settings_export(organization_id, export_id) ⇒ Object

Deletes a single Account Settings Export request Required scopes: account_read

Parameters:

  • organization_id —

    The organization ID Guid

  • export_id —

    The export ID Guid for the request

Returns:

  • (Object) 


139
140
141
142
 
# File 'lib/docusign_admin/api/bulk_exports_api.rb', line 139

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

#delete_account_settings_export_with_http_info(organization_id, export_id) ⇒ Array<(Object, Fixnum, Hash)>

Deletes a single Account Settings Export request Required scopes: account_read

Parameters:

  • organization_id —

    The organization ID Guid

  • export_id —

    The export ID Guid for the request

Returns:

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

    Object 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
186
187
 
# File 'lib/docusign_admin/api/bulk_exports_api.rb', line 149

def (organization_id, export_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkExportsApi.delete_account_settings_export ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling BulkExportsApi.delete_account_settings_export" if organization_id.nil?
  # verify the required parameter 'export_id' is set
  fail ArgumentError, "Missing the required parameter 'export_id' when calling BulkExportsApi.delete_account_settings_export" if export_id.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/exports/account_settings/{exportId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'exportId' + '}', export_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: BulkExportsApi#delete_account_settings_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_user_list_export(organization_id, export_id) ⇒ Object

Deletes a single User List Export request Required scopes: user_read

Parameters:

  • organization_id —

    The organization ID Guid

  • export_id —

    The export ID Guid for the request

Returns:

  • (Object) 


194
195
196
197
 
# File 'lib/docusign_admin/api/bulk_exports_api.rb', line 194

def delete_user_list_export(organization_id, export_id)
  data, _status_code, _headers = delete_user_list_export_with_http_info(organization_id, export_id)
  return data
end

#delete_user_list_export_with_http_info(organization_id, export_id) ⇒ Array<(Object, Fixnum, Hash)>

Deletes a single User List Export request Required scopes: user_read

Parameters:

  • organization_id —

    The organization ID Guid

  • export_id —

    The export ID Guid for the request

Returns:

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

    Object 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
241
242
 
# File 'lib/docusign_admin/api/bulk_exports_api.rb', line 204

def delete_user_list_export_with_http_info(organization_id, export_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkExportsApi.delete_user_list_export ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling BulkExportsApi.delete_user_list_export" if organization_id.nil?
  # verify the required parameter 'export_id' is set
  fail ArgumentError, "Missing the required parameter 'export_id' when calling BulkExportsApi.delete_user_list_export" if export_id.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/exports/user_list/{exportId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'exportId' + '}', export_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: BulkExportsApi#delete_user_list_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_account_settings_export(organization_id, export_id) ⇒ OrganizationExportResponse

Returns the details/metadata for a single Account Setting Export request Required scopes: account_read

Parameters:

  • organization_id —

    The organization ID Guid

  • export_id —

    The export ID Guid for the request

Returns:



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

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

#get_account_settings_export_with_http_info(organization_id, export_id) ⇒ Array<(OrganizationExportResponse, Fixnum, Hash)>

Returns the details/metadata for a single Account Setting Export request Required scopes: account_read

Parameters:

  • organization_id —

    The organization ID Guid

  • export_id —

    The export ID Guid for the request

Returns:

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

    OrganizationExportResponse data, response status code and response headers



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
294
295
296
297
 
# File 'lib/docusign_admin/api/bulk_exports_api.rb', line 259

def (organization_id, export_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkExportsApi.get_account_settings_export ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling BulkExportsApi.get_account_settings_export" if organization_id.nil?
  # verify the required parameter 'export_id' is set
  fail ArgumentError, "Missing the required parameter 'export_id' when calling BulkExportsApi.get_account_settings_export" if export_id.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/exports/account_settings/{exportId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'exportId' + '}', export_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 => 'OrganizationExportResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkExportsApi#get_account_settings_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_account_settings_exports(organization_id) ⇒ OrganizationExportsResponse

Returns the details/metadata for Account Setting Export requests Required scopes: account_read

Parameters:

  • organization_id —

    The organization ID Guid

Returns:



303
304
305
306
 
# File 'lib/docusign_admin/api/bulk_exports_api.rb', line 303

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

#get_account_settings_exports_with_http_info(organization_id) ⇒ Array<(OrganizationExportsResponse, Fixnum, Hash)>

Returns the details/metadata for Account Setting Export requests Required scopes: account_read

Parameters:

  • organization_id —

    The organization ID Guid

Returns:



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
 
# File 'lib/docusign_admin/api/bulk_exports_api.rb', line 312

def (organization_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkExportsApi.get_account_settings_exports ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling BulkExportsApi.get_account_settings_exports" if organization_id.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/exports/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 => 'OrganizationExportsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkExportsApi#get_account_settings_exports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_user_list_export(organization_id, export_id) ⇒ OrganizationExportResponse

Returns the details/metadata for a single User List Export request Required scopes: user_read

Parameters:

  • organization_id —

    The organization ID Guid

  • export_id —

    The export ID Guid for the request

Returns:



355
356
357
358
 
# File 'lib/docusign_admin/api/bulk_exports_api.rb', line 355

def get_user_list_export(organization_id, export_id)
  data, _status_code, _headers = get_user_list_export_with_http_info(organization_id, export_id)
  return data
end

#get_user_list_export_with_http_info(organization_id, export_id) ⇒ Array<(OrganizationExportResponse, Fixnum, Hash)>

Returns the details/metadata for a single User List Export request Required scopes: user_read

Parameters:

  • organization_id —

    The organization ID Guid

  • export_id —

    The export ID Guid for the request

Returns:

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

    OrganizationExportResponse data, response status code and response headers



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
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/docusign_admin/api/bulk_exports_api.rb', line 365

def get_user_list_export_with_http_info(organization_id, export_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkExportsApi.get_user_list_export ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling BulkExportsApi.get_user_list_export" if organization_id.nil?
  # verify the required parameter 'export_id' is set
  fail ArgumentError, "Missing the required parameter 'export_id' when calling BulkExportsApi.get_user_list_export" if export_id.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/exports/user_list/{exportId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'exportId' + '}', export_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 => 'OrganizationExportResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkExportsApi#get_user_list_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_user_list_exports(organization_id) ⇒ OrganizationExportsResponse

Returns a list of existing User List Exports (requests and completed exports) and their details/metadata Required scopes: user_read

Parameters:

  • organization_id —

    The organization ID Guid

Returns:



409
410
411
412
 
# File 'lib/docusign_admin/api/bulk_exports_api.rb', line 409

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

#get_user_list_exports_with_http_info(organization_id) ⇒ Array<(OrganizationExportsResponse, Fixnum, Hash)>

Returns a list of existing User List Exports (requests and completed exports) and their details/metadata Required scopes: user_read

Parameters:

  • organization_id —

    The organization ID Guid

Returns:



418
419
420
421
422
423
424
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
 
# File 'lib/docusign_admin/api/bulk_exports_api.rb', line 418

def get_user_list_exports_with_http_info(organization_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkExportsApi.get_user_list_exports ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling BulkExportsApi.get_user_list_exports" if organization_id.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/exports/user_list".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 => 'OrganizationExportsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkExportsApi#get_user_list_exports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end