com.docusign.esign.api

Class CloudStorageApi

java.lang.Object

com.docusign.esign.api.CloudStorageApi

public class CloudStorageApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CloudStorageApi.GetProviderOptions
class	CloudStorageApi.ListFoldersOptions
class	CloudStorageApi.ListOptions
class	CloudStorageApi.ListProvidersOptions

Constructor Summary

Constructors

Constructor and Description
CloudStorageApi()
CloudStorageApi(ApiClient apiClient)

Method Summary

Methods

Modifier and Type	Method and Description
CloudStorageProviders	createProvider(String accountId, String userId, CloudStorageProviders cloudStorageProviders) Configures the redirect URL information for one or more cloud storage providers for the specified user.
CloudStorageProviders	deleteProvider(String accountId, String userId, String serviceId) Deletes the user authentication information for the specified cloud storage provider.
CloudStorageProviders	deleteProviders(String accountId, String userId, CloudStorageProviders cloudStorageProviders) Deletes the user authentication information for one or more cloud storage providers.
ApiClient	getApiClient()
CloudStorageProviders	getProvider(String accountId, String userId, String serviceId) Gets the specified Cloud Storage Provider configuration for the User.
CloudStorageProviders	getProvider(String accountId, String userId, String serviceId, CloudStorageApi.GetProviderOptions options) Gets the specified Cloud Storage Provider configuration for the User.
ExternalFolder	list(String accountId, String userId, String serviceId, String folderId) Gets a list of all the items from the specified cloud storage provider.
ExternalFolder	list(String accountId, String userId, String serviceId, String folderId, CloudStorageApi.ListOptions options) Gets a list of all the items from the specified cloud storage provider.
ExternalFolder	listFolders(String accountId, String userId, String serviceId) Retrieves a list of all the items in a specified folder from the specified cloud storage provider.
ExternalFolder	listFolders(String accountId, String userId, String serviceId, CloudStorageApi.ListFoldersOptions options) Retrieves a list of all the items in a specified folder from the specified cloud storage provider.
CloudStorageProviders	listProviders(String accountId, String userId) Get the Cloud Storage Provider configuration for the specified user.
CloudStorageProviders	listProviders(String accountId, String userId, CloudStorageApi.ListProvidersOptions options) Get the Cloud Storage Provider configuration for the specified user.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CloudStorageApi

public CloudStorageApi()

CloudStorageApi

public CloudStorageApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createProvider

public CloudStorageProviders createProvider(String accountId,
                                   String userId,
                                   CloudStorageProviders cloudStorageProviders)
                                     throws ApiException

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:

accountId - The external account number (int) or account ID Guid. (required)

userId - 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. (required)

cloudStorageProviders - (optional)

Returns:

CloudStorageProviders

Throws:

ApiException - if fails to make API call

deleteProvider

public CloudStorageProviders deleteProvider(String accountId,
                                   String userId,
                                   String serviceId)
                                     throws ApiException

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:

accountId - The external account number (int) or account ID Guid. (required)

userId - 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. (required)

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

Returns:

CloudStorageProviders

Throws:

ApiException - if fails to make API call

deleteProviders

public CloudStorageProviders deleteProviders(String accountId,
                                    String userId,
                                    CloudStorageProviders cloudStorageProviders)
                                      throws ApiException

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:

accountId - The external account number (int) or account ID Guid. (required)

userId - 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. (required)

cloudStorageProviders - (optional)

Returns:

CloudStorageProviders

Throws:

ApiException - if fails to make API call

getProvider

public CloudStorageProviders getProvider(String accountId,
                                String userId,
                                String serviceId)
                                  throws ApiException

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:

accountId - The external account number (int) or account ID Guid. (required)

userId - 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. (required)

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

Returns:

CloudStorageProviders

Throws:

ApiException

getProvider

public CloudStorageProviders getProvider(String accountId,
                                String userId,
                                String serviceId,
                                CloudStorageApi.GetProviderOptions options)
                                  throws ApiException

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:

accountId - The external account number (int) or account ID Guid. (required)

userId - 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. (required)

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

options - for modifying the method behavior.

Returns:

CloudStorageProviders

Throws:

ApiException - if fails to make API call

list

public ExternalFolder list(String accountId,
                  String userId,
                  String serviceId,
                  String folderId)
                    throws ApiException

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:

accountId - The external account number (int) or account ID Guid. (required)

userId - 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. (required)

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

folderId - The ID of the folder being accessed. (required)

Returns:

ExternalFolder

Throws:

ApiException

list

public ExternalFolder list(String accountId,
                  String userId,
                  String serviceId,
                  String folderId,
                  CloudStorageApi.ListOptions options)
                    throws ApiException

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:

accountId - The external account number (int) or account ID Guid. (required)

userId - 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. (required)

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

folderId - The ID of the folder being accessed. (required)

options - for modifying the method behavior.

Returns:

ExternalFolder

Throws:

ApiException - if fails to make API call

listFolders

public ExternalFolder listFolders(String accountId,
                         String userId,
                         String serviceId)
                           throws ApiException

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:

accountId - The external account number (int) or account ID Guid. (required)

userId - 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. (required)

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

Returns:

ExternalFolder

Throws:

ApiException

listFolders

public ExternalFolder listFolders(String accountId,
                         String userId,
                         String serviceId,
                         CloudStorageApi.ListFoldersOptions options)
                           throws ApiException

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:

accountId - The external account number (int) or account ID Guid. (required)

userId - 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. (required)

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

options - for modifying the method behavior.

Returns:

ExternalFolder

Throws:

ApiException - if fails to make API call

listProviders

public CloudStorageProviders listProviders(String accountId,
                                  String userId)
                                    throws ApiException

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:

accountId - The external account number (int) or account ID Guid. (required)

userId - 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. (required)

Returns:

CloudStorageProviders

Throws:

ApiException

listProviders

public CloudStorageProviders listProviders(String accountId,
                                  String userId,
                                  CloudStorageApi.ListProvidersOptions options)
                                    throws ApiException

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:

accountId - The external account number (int) or account ID Guid. (required)

userId - 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. (required)

options - for modifying the method behavior.

Returns:

CloudStorageProviders

Throws:

ApiException - if fails to make API call