module:api/CloudStorageApi

new module:api/CloudStorageApi(apiClient)

Source:

api/CloudStorageApi.js, line 41

Constructs a new CloudStorageApi.

Parameters:

Name	Type	Description
`apiClient`	module:ApiClient	Optional API client implementation to use, default to `module:ApiClient#instance` if unspecified.

Methods

createProvider(accountId, userId, optsOrCallback, callback)

Source:

api/CloudStorageApi.js, line 72

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:

Name Type Description

accountId

String

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

userId

String

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.

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`cloudStorageProviders`	module:model/CloudStorageProviders

callback

module:api/CloudStorageApi~createProviderCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/CloudStorageProviders

deleteProvider(accountId, userId, serviceId, callback)

Source:

api/CloudStorageApi.js, line 141

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:

Name	Type	Description
`accountId`	String	The external account number (int) or account ID Guid.
`userId`	String	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.
`serviceId`	String	The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").
`callback`	module:api/CloudStorageApi~deleteProviderCallback	The callback function, accepting three arguments: error, data, response data is of type: `module:model/CloudStorageProviders`

deleteProviders(accountId, userId, optsOrCallback, callback)

Source:

api/CloudStorageApi.js, line 208

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:

Name Type Description

accountId

String

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

userId

String

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`cloudStorageProviders`	module:model/CloudStorageProviders

callback

module:api/CloudStorageApi~deleteProvidersCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/CloudStorageProviders

getProvider(accountId, userId, serviceId, optsOrCallback, callback)

Source:

api/CloudStorageApi.js, line 279

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:

Name Type Description

accountId

String

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

userId

String

serviceId

String

The ID of the service to access.

Valid values are the service name ("Box") or the numerical serviceId ("4136").

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`redirectUrl`	String	The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl. The redirectUrl is restricted to URLs in the docusign.com or docusign.net domains.

callback

module:api/CloudStorageApi~getProviderCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/CloudStorageProviders

list(accountId, userId, serviceId, folderId, optsOrCallback, callback)

Source:

api/CloudStorageApi.js, line 364

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:

Name Type Description

accountId

String

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

userId

String

serviceId

String

The ID of the service to access.

Valid values are the service name ("Box") or the numerical serviceId ("4136").

folderId

String

The ID of the folder being accessed.

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`cloudStorageFolderPath`	String
`cloudStorageFolderidPlain`	String
`count`	String	An optional value that sets how many items are included in the response. The default setting for this is 25.
`order`	String	An optional value that sets the direction order used to sort the item list. Valid values are: * asc = ascending sort order * desc = descending sort order
`orderBy`	String	An optional value that sets the file attribute used to sort the item list. Valid values are: * modified * name
`searchText`	String
`startPosition`	String	Indicates the starting point of the first item included in the response set. It uses a 0-based index. The default setting for this is 0.

callback

module:api/CloudStorageApi~listCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/ExternalFolder

listFolders(accountId, userId, serviceId, optsOrCallback, callback)

Source:

api/CloudStorageApi.js, line 459

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:

Name Type Description

accountId

String

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

userId

String

serviceId

String

The ID of the service to access.

Valid values are the service name ("Box") or the numerical serviceId ("4136").

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`cloudStorageFolderPath`	String	A comma separated list of folder IDs included in the request.
`count`	String	An optional value that sets how many items are included in the response. The default setting for this is 25.
`order`	String	An optional value that sets the direction order used to sort the item list. Valid values are: * asc = ascending sort order * desc = descending sort order
`orderBy`	String	An optional value that sets the file attribute used to sort the item list. Valid values are: * modified * name
`searchText`	String
`startPosition`	String	Indicates the starting point of the first item included in the response set. It uses a 0-based index. The default setting for this is 0.

callback

module:api/CloudStorageApi~listFoldersCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/ExternalFolder

listProviders(accountId, userId, optsOrCallback, callback)

Source:

api/CloudStorageApi.js, line 541

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:

Name Type Description

accountId

String

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

userId

String

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`redirectUrl`	String	The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl. The redirectUrl is restricted to URLs in the docusign.com or docusign.net domains.

callback

module:api/CloudStorageApi~listProvidersCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/CloudStorageProviders

Type Definitions

createProviderCallback(error, data, If)

Source:

api/CloudStorageApi.js, line 54

(Optional) Callback function to receive the result of the createProvider operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/CloudStorageProviders	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteProviderCallback(error, data, If)

Source:

api/CloudStorageApi.js, line 122

(Optional) Callback function to receive the result of the deleteProvider operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/CloudStorageProviders	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteProvidersCallback(error, data, If)

Source:

api/CloudStorageApi.js, line 190

(Optional) Callback function to receive the result of the deleteProviders operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/CloudStorageProviders	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getProviderCallback(error, data, If)

Source:

api/CloudStorageApi.js, line 258

(Optional) Callback function to receive the result of the getProvider operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/CloudStorageProviders	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listCallback(error, data, If)

Source:

api/CloudStorageApi.js, line 336

(Optional) Callback function to receive the result of the list operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/ExternalFolder	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listFoldersCallback(error, data, If)

Source:

api/CloudStorageApi.js, line 433

(Optional) Callback function to receive the result of the listFolders operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/ExternalFolder	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listProvidersCallback(error, data, If)

Source:

api/CloudStorageApi.js, line 521

(Optional) Callback function to receive the result of the listProviders operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/CloudStorageProviders	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.