Class: DocuSign_eSign::CloudStorageApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = CloudStorageApi.default) ⇒ CloudStorageApi

Returns a new instance of CloudStorageApi.


90
91
92
# File 'lib/docusign_esign/api/cloud_storage_api.rb', line 90

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client


88
89
90
# File 'lib/docusign_esign/api/cloud_storage_api.rb', line 88

def api_client
  @api_client
end

Instance Method Details

#create_provider(account_id, user_id, cloud_storage_providers) ⇒ CloudStorageProviders

Configures the redirect URL information for one or more cloud storage providers for the specified user. Configures the redirect URL information for one or more cloud storage providers for the specified user. The redirect URL is added to the authentication URL to complete the return route.

Parameters:

  • account_id

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

  • user_id

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • cloud_storage_providers (optional parameter)

Returns:


100
101
102
103
# File 'lib/docusign_esign/api/cloud_storage_api.rb', line 100

def create_provider(, user_id, cloud_storage_providers)
  data, _status_code, _headers = create_provider_with_http_info(, user_id,  cloud_storage_providers)
  return data
end

#create_provider_with_http_info(account_id, user_id, cloud_storage_providers) ⇒ Array<(CloudStorageProviders, Fixnum, Hash)>

Configures the redirect URL information for one or more cloud storage providers for the specified user. Configures the redirect URL information for one or more cloud storage providers for the specified user. The redirect URL is added to the authentication URL to complete the return route.

Parameters:

  • account_id

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

  • user_id

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • cloud_storage_providers (optional parameter)

Returns:

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

    CloudStorageProviders data, response status code and response headers


111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
# File 'lib/docusign_esign/api/cloud_storage_api.rb', line 111

def create_provider_with_http_info(, user_id, cloud_storage_providers)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CloudStorageApi.create_provider ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling CloudStorageApi.create_provider" if .nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling CloudStorageApi.create_provider" if user_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/users/{userId}/cloud_storage".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'userId' + '}', user_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(cloud_storage_providers)
  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 => 'CloudStorageProviders')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudStorageApi#create_provider\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_provider(account_id, service_id, user_id) ⇒ CloudStorageProviders

Deletes the user authentication information for the specified cloud storage provider. Deletes the user authentication information for the specified cloud storage provider. The next time the user tries to access the cloud storage provider, they must pass normal authentication for this cloud storage provider.

Parameters:

  • account_id

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

  • service_id

    The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").

  • user_id

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

Returns:


155
156
157
158
# File 'lib/docusign_esign/api/cloud_storage_api.rb', line 155

def delete_provider(, service_id, user_id)
  data, _status_code, _headers = delete_provider_with_http_info(, service_id, user_id)
  return data
end

#delete_provider_with_http_info(account_id, service_id, user_id) ⇒ Array<(CloudStorageProviders, Fixnum, Hash)>

Deletes the user authentication information for the specified cloud storage provider. Deletes the user authentication information for the specified cloud storage provider. The next time the user tries to access the cloud storage provider, they must pass normal authentication for this cloud storage provider.

Parameters:

  • account_id

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

  • service_id

    The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").

  • user_id

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

Returns:

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

    CloudStorageProviders data, response status code and response headers


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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
# File 'lib/docusign_esign/api/cloud_storage_api.rb', line 166

def delete_provider_with_http_info(, service_id, user_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CloudStorageApi.delete_provider ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling CloudStorageApi.delete_provider" if .nil?
  # verify the required parameter 'service_id' is set
  fail ArgumentError, "Missing the required parameter 'service_id' when calling CloudStorageApi.delete_provider" if service_id.nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling CloudStorageApi.delete_provider" if user_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'serviceId' + '}', service_id.to_s).sub('{' + 'userId' + '}', user_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 => 'CloudStorageProviders')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudStorageApi#delete_provider\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_providers(account_id, user_id, cloud_storage_providers) ⇒ CloudStorageProviders

Deletes the user authentication information for one or more cloud storage providers. Deletes the user authentication information for one or more cloud storage providers. The next time the user tries to access the cloud storage provider, they must pass normal authentication.

Parameters:

  • account_id

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

  • user_id

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • cloud_storage_providers (optional parameter)

Returns:


212
213
214
215
# File 'lib/docusign_esign/api/cloud_storage_api.rb', line 212

def delete_providers(, user_id, cloud_storage_providers)
  data, _status_code, _headers = delete_providers_with_http_info(, user_id,  cloud_storage_providers)
  return data
end

#delete_providers_with_http_info(account_id, user_id, cloud_storage_providers) ⇒ Array<(CloudStorageProviders, Fixnum, Hash)>

Deletes the user authentication information for one or more cloud storage providers. Deletes the user authentication information for one or more cloud storage providers. The next time the user tries to access the cloud storage provider, they must pass normal authentication.

Parameters:

  • account_id

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

  • user_id

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • cloud_storage_providers (optional parameter)

Returns:

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

    CloudStorageProviders data, response status code and response headers


223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
# File 'lib/docusign_esign/api/cloud_storage_api.rb', line 223

def delete_providers_with_http_info(, user_id, cloud_storage_providers)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CloudStorageApi.delete_providers ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling CloudStorageApi.delete_providers" if .nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling CloudStorageApi.delete_providers" if user_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/users/{userId}/cloud_storage".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'userId' + '}', user_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(cloud_storage_providers)
  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 => 'CloudStorageProviders')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudStorageApi#delete_providers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_provider(account_id, service_id, user_id, options = DocuSign_eSign::GetProviderOptions.default) ⇒ CloudStorageProviders

Gets the specified Cloud Storage Provider configuration for the User. Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user.

Parameters:

  • account_id

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

  • service_id

    The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").

  • user_id

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • DocuSign_eSign::GetProviderOptions

    Options for modifying the behavior of the function.

Returns:


268
269
270
271
# File 'lib/docusign_esign/api/cloud_storage_api.rb', line 268

def get_provider(, service_id, user_id, options = DocuSign_eSign::GetProviderOptions.default)
  data, _status_code, _headers = get_provider_with_http_info(, service_id, user_id, options)
  return data
end

#get_provider_with_http_info(account_id, service_id, user_id, options = DocuSign_eSign::GetProviderOptions.default) ⇒ Array<(CloudStorageProviders, Fixnum, Hash)>

Gets the specified Cloud Storage Provider configuration for the User. Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user.

Parameters:

  • account_id

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

  • service_id

    The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").

  • user_id

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • DocuSign_eSign::GetProviderOptions

    Options for modifying the behavior of the function.

Returns:

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

    CloudStorageProviders data, response status code and response headers


280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
# File 'lib/docusign_esign/api/cloud_storage_api.rb', line 280

def get_provider_with_http_info(, service_id, user_id, options = DocuSign_eSign::GetProviderOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CloudStorageApi.get_provider ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling CloudStorageApi.get_provider" if .nil?
  # verify the required parameter 'service_id' is set
  fail ArgumentError, "Missing the required parameter 'service_id' when calling CloudStorageApi.get_provider" if service_id.nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling CloudStorageApi.get_provider" if user_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'serviceId' + '}', service_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'redirectUrl'] = options.redirect_url if !options.redirect_url.nil?

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

  # form parameters
  form_params = {}

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

#list(account_id, folder_id, service_id, user_id, options = DocuSign_eSign::ListOptions.default) ⇒ ExternalFolder

Gets a list of all the items from the specified cloud storage provider. Retrieves a list of all the items in all the folders associated with the user from the specified cloud storage provider. You can limit the scope of the returned items by providing a comma separated list of folder IDs in the request.

Parameters:

  • account_id

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

  • folder_id

    The ID of the folder being accessed.

  • service_id

    The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").

  • user_id

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • DocuSign_eSign::ListOptions

    Options for modifying the behavior of the function.

Returns:


329
330
331
332
# File 'lib/docusign_esign/api/cloud_storage_api.rb', line 329

def list(, folder_id, service_id, user_id, options = DocuSign_eSign::ListOptions.default)
  data, _status_code, _headers = list_with_http_info(, folder_id, service_id, user_id, options)
  return data
end

#list_folders(account_id, service_id, user_id, options = DocuSign_eSign::ListFoldersOptions.default) ⇒ ExternalFolder

Retrieves a list of all the items in a specified folder from the specified cloud storage provider. Retrieves a list of all the items in a specified folder from the specified cloud storage provider.

Parameters:

  • account_id

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

  • service_id

    The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").

  • user_id

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • DocuSign_eSign::ListFoldersOptions

    Options for modifying the behavior of the function.

Returns:


398
399
400
401
# File 'lib/docusign_esign/api/cloud_storage_api.rb', line 398

def list_folders(, service_id, user_id, options = DocuSign_eSign::ListFoldersOptions.default)
  data, _status_code, _headers = list_folders_with_http_info(, service_id, user_id, options)
  return data
end

#list_folders_with_http_info(account_id, service_id, user_id, options = DocuSign_eSign::ListFoldersOptions.default) ⇒ Array<(ExternalFolder, Fixnum, Hash)>

Retrieves a list of all the items in a specified folder from the specified cloud storage provider. Retrieves a list of all the items in a specified folder from the specified cloud storage provider.

Parameters:

  • account_id

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

  • service_id

    The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").

  • user_id

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • DocuSign_eSign::ListFoldersOptions

    Options for modifying the behavior of the function.

Returns:

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

    ExternalFolder data, response status code and response headers


410
411
412
413
414
415
416
417
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_esign/api/cloud_storage_api.rb', line 410

def list_folders_with_http_info(, service_id, user_id, options = DocuSign_eSign::ListFoldersOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CloudStorageApi.list_folders ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling CloudStorageApi.list_folders" if .nil?
  # verify the required parameter 'service_id' is set
  fail ArgumentError, "Missing the required parameter 'service_id' when calling CloudStorageApi.list_folders" if service_id.nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling CloudStorageApi.list_folders" if user_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'serviceId' + '}', service_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'cloud_storage_folder_path'] = options.cloud_storage_folder_path if !options.cloud_storage_folder_path.nil?
  query_params[:'count'] = options.count if !options.count.nil?
  query_params[:'order'] = options.order if !options.order.nil?
  query_params[:'order_by'] = options.order_by if !options.order_by.nil?
  query_params[:'search_text'] = options.search_text if !options.search_text.nil?
  query_params[:'start_position'] = options.start_position if !options.start_position.nil?

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

#list_providers(account_id, user_id, options = DocuSign_eSign::ListProvidersOptions.default) ⇒ CloudStorageProviders

Get the Cloud Storage Provider configuration for the specified user. Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user. The serviceId parameter can be either the service name or serviceId.

Parameters:

  • account_id

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

  • user_id

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • DocuSign_eSign::ListProvidersOptions

    Options for modifying the behavior of the function.

Returns:


462
463
464
465
# File 'lib/docusign_esign/api/cloud_storage_api.rb', line 462

def list_providers(, user_id, options = DocuSign_eSign::ListProvidersOptions.default)
  data, _status_code, _headers = list_providers_with_http_info(, user_id, options)
  return data
end

#list_providers_with_http_info(account_id, user_id, options = DocuSign_eSign::ListProvidersOptions.default) ⇒ Array<(CloudStorageProviders, Fixnum, Hash)>

Get the Cloud Storage Provider configuration for the specified user. Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user. The serviceId parameter can be either the service name or serviceId.

Parameters:

  • account_id

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

  • user_id

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • DocuSign_eSign::ListProvidersOptions

    Options for modifying the behavior of the function.

Returns:

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

    CloudStorageProviders data, response status code and response headers


473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
# File 'lib/docusign_esign/api/cloud_storage_api.rb', line 473

def list_providers_with_http_info(, user_id, options = DocuSign_eSign::ListProvidersOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CloudStorageApi.list_providers ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling CloudStorageApi.list_providers" if .nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling CloudStorageApi.list_providers" if user_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/users/{userId}/cloud_storage".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'redirectUrl'] = options.redirect_url if !options.redirect_url.nil?

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

  # form parameters
  form_params = {}

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

#list_with_http_info(account_id, folder_id, service_id, user_id, options = DocuSign_eSign::ListOptions.default) ⇒ Array<(ExternalFolder, Fixnum, Hash)>

Gets a list of all the items from the specified cloud storage provider. Retrieves a list of all the items in all the folders associated with the user from the specified cloud storage provider. You can limit the scope of the returned items by providing a comma separated list of folder IDs in the request.

Parameters:

  • account_id

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

  • folder_id

    The ID of the folder being accessed.

  • service_id

    The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").

  • user_id

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • DocuSign_eSign::ListOptions

    Options for modifying the behavior of the function.

Returns:

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

    ExternalFolder data, response status code and response headers


342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
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
# File 'lib/docusign_esign/api/cloud_storage_api.rb', line 342

def list_with_http_info(, folder_id, service_id, user_id, options = DocuSign_eSign::ListOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CloudStorageApi.list ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling CloudStorageApi.list" if .nil?
  # verify the required parameter 'folder_id' is set
  fail ArgumentError, "Missing the required parameter 'folder_id' when calling CloudStorageApi.list" if folder_id.nil?
  # verify the required parameter 'service_id' is set
  fail ArgumentError, "Missing the required parameter 'service_id' when calling CloudStorageApi.list" if service_id.nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling CloudStorageApi.list" if user_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders/{folderId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'folderId' + '}', folder_id.to_s).sub('{' + 'serviceId' + '}', service_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'cloud_storage_folder_path'] = options.cloud_storage_folder_path if !options.cloud_storage_folder_path.nil?
  query_params[:'cloud_storage_folderid_plain'] = options.cloud_storage_folderid_plain if !options.cloud_storage_folderid_plain.nil?
  query_params[:'count'] = options.count if !options.count.nil?
  query_params[:'order'] = options.order if !options.order.nil?
  query_params[:'order_by'] = options.order_by if !options.order_by.nil?
  query_params[:'search_text'] = options.search_text if !options.search_text.nil?
  query_params[:'start_position'] = options.start_position if !options.start_position.nil?

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