Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for DocuSign.eSign.Api.CloudStorageApi:

Classes
class	GetProviderOptions
	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. More...

class	ListFoldersOptions
	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. More...

class	ListOptions
	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. More...

class	ListProvidersOptions
	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. More...

Public Member Functions
	CloudStorageApi (DocuSignClient aplClient)
	Initializes a new instance of the CloudStorageApi class using AplClient object More...

String	GetBasePath ()
	Gets the base path of the API client. More...

CloudStorageProviders	CreateProvider (string accountId, string userId, CloudStorageProviders cloudStorageProviders=null)
	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. More...

ApiResponse< CloudStorageProviders >	CreateProviderWithHttpInfo (string accountId, string userId, CloudStorageProviders cloudStorageProviders=null)
	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. More...

async System.Threading.Tasks.Task< CloudStorageProviders >	CreateProviderAsync (string accountId, string userId, CloudStorageProviders cloudStorageProviders=null)
	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. More...

async System.Threading.Tasks.Task< ApiResponse< CloudStorageProviders > >	CreateProviderAsyncWithHttpInfo (string accountId, string userId, CloudStorageProviders cloudStorageProviders=null)
	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. More...

CloudStorageProviders	DeleteProvider (string accountId, string userId, string serviceId)
	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. More...

ApiResponse< CloudStorageProviders >	DeleteProviderWithHttpInfo (string accountId, string userId, string serviceId)
	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. More...

async System.Threading.Tasks.Task< CloudStorageProviders >	DeleteProviderAsync (string accountId, string userId, string serviceId)
	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. More...

async System.Threading.Tasks.Task< ApiResponse< CloudStorageProviders > >	DeleteProviderAsyncWithHttpInfo (string accountId, string userId, string serviceId)
	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. More...

CloudStorageProviders	DeleteProviders (string accountId, string userId, CloudStorageProviders cloudStorageProviders=null)
	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. More...

ApiResponse< CloudStorageProviders >	DeleteProvidersWithHttpInfo (string accountId, string userId, CloudStorageProviders cloudStorageProviders=null)
	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. More...

async System.Threading.Tasks.Task< CloudStorageProviders >	DeleteProvidersAsync (string accountId, string userId, CloudStorageProviders cloudStorageProviders=null)
	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. More...

async System.Threading.Tasks.Task< ApiResponse< CloudStorageProviders > >	DeleteProvidersAsyncWithHttpInfo (string accountId, string userId, CloudStorageProviders cloudStorageProviders=null)
	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. More...

CloudStorageProviders	GetProvider (string accountId, string userId, string serviceId, CloudStorageApi.GetProviderOptions options=null)
	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. More...

ApiResponse< CloudStorageProviders >	GetProviderWithHttpInfo (string accountId, string userId, string serviceId, CloudStorageApi.GetProviderOptions options=null)
	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. More...

async System.Threading.Tasks.Task< CloudStorageProviders >	GetProviderAsync (string accountId, string userId, string serviceId, CloudStorageApi.GetProviderOptions options=null)
	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. More...

async System.Threading.Tasks.Task< ApiResponse< CloudStorageProviders > >	GetProviderAsyncWithHttpInfo (string accountId, string userId, string serviceId, CloudStorageApi.GetProviderOptions options=null)
	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. More...

ExternalFolder	List (string accountId, string userId, string serviceId, string folderId, CloudStorageApi.ListOptions options=null)
	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. More...

ApiResponse< ExternalFolder >	ListWithHttpInfo (string accountId, string userId, string serviceId, string folderId, CloudStorageApi.ListOptions options=null)
	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. More...

async System.Threading.Tasks.Task< ExternalFolder >	ListAsync (string accountId, string userId, string serviceId, string folderId, CloudStorageApi.ListOptions options=null)
	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. More...

async System.Threading.Tasks.Task< ApiResponse< ExternalFolder > >	ListAsyncWithHttpInfo (string accountId, string userId, string serviceId, string folderId, CloudStorageApi.ListOptions options=null)
	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. More...

ExternalFolder	ListFolders (string accountId, string userId, string serviceId, CloudStorageApi.ListFoldersOptions options=null)
	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. More...

ApiResponse< ExternalFolder >	ListFoldersWithHttpInfo (string accountId, string userId, string serviceId, CloudStorageApi.ListFoldersOptions options=null)
	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. More...

async System.Threading.Tasks.Task< ExternalFolder >	ListFoldersAsync (string accountId, string userId, string serviceId, CloudStorageApi.ListFoldersOptions options=null)
	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. More...

async System.Threading.Tasks.Task< ApiResponse< ExternalFolder > >	ListFoldersAsyncWithHttpInfo (string accountId, string userId, string serviceId, CloudStorageApi.ListFoldersOptions options=null)
	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. More...

CloudStorageProviders	ListProviders (string accountId, string userId, CloudStorageApi.ListProvidersOptions options=null)
	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. More...

ApiResponse< CloudStorageProviders >	ListProvidersWithHttpInfo (string accountId, string userId, CloudStorageApi.ListProvidersOptions options=null)
	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. More...

async System.Threading.Tasks.Task< CloudStorageProviders >	ListProvidersAsync (string accountId, string userId, CloudStorageApi.ListProvidersOptions options=null)
	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. More...

async System.Threading.Tasks.Task< ApiResponse< CloudStorageProviders > >	ListProvidersAsyncWithHttpInfo (string accountId, string userId, CloudStorageApi.ListProvidersOptions options=null)
	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. More...

Public Member Functions inherited from DocuSign.eSign.Api.ICloudStorageApi
CloudStorageProviders	GetProvider (string accountId, string userId, string serviceId, CloudStorageApi.GetProviderOptions options=null)
	Gets the specified Cloud Storage Provider configuration for the User. More...

ApiResponse< CloudStorageProviders >	GetProviderWithHttpInfo (string accountId, string userId, string serviceId, CloudStorageApi.GetProviderOptions options=null)
	Gets the specified Cloud Storage Provider configuration for the User. More...

ExternalFolder	List (string accountId, string userId, string serviceId, string folderId, CloudStorageApi.ListOptions options=null)
	Gets a list of all the items from the specified cloud storage provider. More...

ApiResponse< ExternalFolder >	ListWithHttpInfo (string accountId, string userId, string serviceId, string folderId, CloudStorageApi.ListOptions options=null)
	Gets a list of all the items from the specified cloud storage provider. More...

ExternalFolder	ListFolders (string accountId, string userId, string serviceId, CloudStorageApi.ListFoldersOptions options=null)
	Retrieves a list of all the items in a specified folder from the specified cloud storage provider. More...

ApiResponse< ExternalFolder >	ListFoldersWithHttpInfo (string accountId, string userId, string serviceId, CloudStorageApi.ListFoldersOptions options=null)
	Retrieves a list of all the items in a specified folder from the specified cloud storage provider. More...

CloudStorageProviders	ListProviders (string accountId, string userId, CloudStorageApi.ListProvidersOptions options=null)
	Get the Cloud Storage Provider configuration for the specified user. More...

ApiResponse< CloudStorageProviders >	ListProvidersWithHttpInfo (string accountId, string userId, CloudStorageApi.ListProvidersOptions options=null)
	Get the Cloud Storage Provider configuration for the specified user. More...

System.Threading.Tasks.Task< CloudStorageProviders >	GetProviderAsync (string accountId, string userId, string serviceId, CloudStorageApi.GetProviderOptions options=null)
	Gets the specified Cloud Storage Provider configuration for the User. More...

System.Threading.Tasks.Task< ApiResponse< CloudStorageProviders > >	GetProviderAsyncWithHttpInfo (string accountId, string userId, string serviceId, CloudStorageApi.GetProviderOptions options=null)
	Gets the specified Cloud Storage Provider configuration for the User. More...

System.Threading.Tasks.Task< ExternalFolder >	ListAsync (string accountId, string userId, string serviceId, string folderId, CloudStorageApi.ListOptions options=null)
	Gets a list of all the items from the specified cloud storage provider. More...

System.Threading.Tasks.Task< ApiResponse< ExternalFolder > >	ListAsyncWithHttpInfo (string accountId, string userId, string serviceId, string folderId, CloudStorageApi.ListOptions options=null)
	Gets a list of all the items from the specified cloud storage provider. More...

System.Threading.Tasks.Task< ExternalFolder >	ListFoldersAsync (string accountId, string userId, string serviceId, CloudStorageApi.ListFoldersOptions options=null)
	Retrieves a list of all the items in a specified folder from the specified cloud storage provider. More...

System.Threading.Tasks.Task< ApiResponse< ExternalFolder > >	ListFoldersAsyncWithHttpInfo (string accountId, string userId, string serviceId, CloudStorageApi.ListFoldersOptions options=null)
	Retrieves a list of all the items in a specified folder from the specified cloud storage provider. More...

System.Threading.Tasks.Task< CloudStorageProviders >	ListProvidersAsync (string accountId, string userId, CloudStorageApi.ListProvidersOptions options=null)
	Get the Cloud Storage Provider configuration for the specified user. More...

System.Threading.Tasks.Task< ApiResponse< CloudStorageProviders > >	ListProvidersAsyncWithHttpInfo (string accountId, string userId, CloudStorageApi.ListProvidersOptions options=null)
	Get the Cloud Storage Provider configuration for the specified user. More...

Properties
DocuSignClient	ApiClient `[get, set]`
	Gets or sets the ApiClient object More...

DocuSign.eSign.Client.ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Properties inherited from DocuSign.eSign.Client.IApiAccessor
DocuSignClient	ApiClient `[get, set]`
	Gets or sets the ApiClient object More...

ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

◆ CloudStorageApi()

DocuSign.eSign.Api.CloudStorageApi.CloudStorageApi ( DocuSignClient aplClient )

inline

Initializes a new instance of the CloudStorageApi class using AplClient object

Parameters

aplClient An instance of AplClient

Returns

Member Function Documentation

◆ CreateProvider()

CloudStorageProviders DocuSign.eSign.Api.CloudStorageApi.CreateProvider	(	string	accountId,
		string	userId,
		CloudStorageProviders	cloudStorageProviders = `null`
	)

inline

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
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.
cloudStorageProviders	(optional)

Returns: CloudStorageProviders

Implements DocuSign.eSign.Api.ICloudStorageApi.

◆ CreateProviderAsync()

async System.Threading.Tasks.Task<CloudStorageProviders> DocuSign.eSign.Api.CloudStorageApi.CreateProviderAsync	(	string	accountId,
		string	userId,
		CloudStorageProviders	cloudStorageProviders = `null`
	)

inline

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
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.
cloudStorageProviders	(optional)

Returns: Task of CloudStorageProviders

Implements DocuSign.eSign.Api.ICloudStorageApi.

◆ CreateProviderAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<CloudStorageProviders> > DocuSign.eSign.Api.CloudStorageApi.CreateProviderAsyncWithHttpInfo	(	string	accountId,
		string	userId,
		CloudStorageProviders	cloudStorageProviders = `null`
	)

inline

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
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.
cloudStorageProviders	(optional)

Returns: Task of ApiResponse (CloudStorageProviders)

Implements DocuSign.eSign.Api.ICloudStorageApi.

◆ CreateProviderWithHttpInfo()

ApiResponse<CloudStorageProviders> DocuSign.eSign.Api.CloudStorageApi.CreateProviderWithHttpInfo	(	string	accountId,
		string	userId,
		CloudStorageProviders	cloudStorageProviders = `null`
	)

inline

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
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.
cloudStorageProviders	(optional)

Returns: ApiResponse of CloudStorageProviders

Implements DocuSign.eSign.Api.ICloudStorageApi.

◆ DeleteProvider()

CloudStorageProviders DocuSign.eSign.Api.CloudStorageApi.DeleteProvider	(	string	accountId,
		string	userId,
		string	serviceId
	)

inline

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
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.
serviceId	The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").

Returns: CloudStorageProviders

Implements DocuSign.eSign.Api.ICloudStorageApi.

◆ DeleteProviderAsync()

async System.Threading.Tasks.Task<CloudStorageProviders> DocuSign.eSign.Api.CloudStorageApi.DeleteProviderAsync	(	string	accountId,
		string	userId,
		string	serviceId
	)

inline

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
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.
serviceId	The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").

Returns: Task of CloudStorageProviders

Implements DocuSign.eSign.Api.ICloudStorageApi.

◆ DeleteProviderAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<CloudStorageProviders> > DocuSign.eSign.Api.CloudStorageApi.DeleteProviderAsyncWithHttpInfo	(	string	accountId,
		string	userId,
		string	serviceId
	)

inline

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
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.
serviceId	The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").

Returns: Task of ApiResponse (CloudStorageProviders)

Implements DocuSign.eSign.Api.ICloudStorageApi.

◆ DeleteProviders()

CloudStorageProviders DocuSign.eSign.Api.CloudStorageApi.DeleteProviders	(	string	accountId,
		string	userId,
		CloudStorageProviders	cloudStorageProviders = `null`
	)

inline

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
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.
cloudStorageProviders	(optional)

Returns: CloudStorageProviders

Implements DocuSign.eSign.Api.ICloudStorageApi.

◆ DeleteProvidersAsync()

async System.Threading.Tasks.Task<CloudStorageProviders> DocuSign.eSign.Api.CloudStorageApi.DeleteProvidersAsync	(	string	accountId,
		string	userId,
		CloudStorageProviders	cloudStorageProviders = `null`
	)

inline

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
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.
cloudStorageProviders	(optional)

Returns: Task of CloudStorageProviders

Implements DocuSign.eSign.Api.ICloudStorageApi.

◆ DeleteProvidersAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<CloudStorageProviders> > DocuSign.eSign.Api.CloudStorageApi.DeleteProvidersAsyncWithHttpInfo	(	string	accountId,
		string	userId,
		CloudStorageProviders	cloudStorageProviders = `null`
	)

inline

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
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.
cloudStorageProviders	(optional)

Returns: Task of ApiResponse (CloudStorageProviders)

Implements DocuSign.eSign.Api.ICloudStorageApi.

◆ DeleteProvidersWithHttpInfo()

ApiResponse<CloudStorageProviders> DocuSign.eSign.Api.CloudStorageApi.DeleteProvidersWithHttpInfo	(	string	accountId,
		string	userId,
		CloudStorageProviders	cloudStorageProviders = `null`
	)

inline

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
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.
cloudStorageProviders	(optional)

Returns: ApiResponse of CloudStorageProviders

Implements DocuSign.eSign.Api.ICloudStorageApi.

◆ DeleteProviderWithHttpInfo()

ApiResponse<CloudStorageProviders> DocuSign.eSign.Api.CloudStorageApi.DeleteProviderWithHttpInfo	(	string	accountId,
		string	userId,
		string	serviceId
	)

inline

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
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.
serviceId	The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").

Returns: ApiResponse of CloudStorageProviders

Implements DocuSign.eSign.Api.ICloudStorageApi.

◆ GetBasePath()

String DocuSign.eSign.Api.CloudStorageApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

Implements DocuSign.eSign.Client.IApiAccessor.

◆ GetProvider()

CloudStorageProviders DocuSign.eSign.Api.CloudStorageApi.GetProvider	(	string	accountId,
		string	userId,
		string	serviceId,
		CloudStorageApi.GetProviderOptions	options = `null`
	)

inline

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
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.
serviceId	The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").
options	Options for modifying the behavior of the function.

Returns: CloudStorageProviders

◆ GetProviderAsync()

async System.Threading.Tasks.Task<CloudStorageProviders> DocuSign.eSign.Api.CloudStorageApi.GetProviderAsync	(	string	accountId,
		string	userId,
		string	serviceId,
		CloudStorageApi.GetProviderOptions	options = `null`
	)

inline

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
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.
serviceId	The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").
options	Options for modifying the behavior of the function.

Returns: Task of CloudStorageProviders

◆ GetProviderAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<CloudStorageProviders> > DocuSign.eSign.Api.CloudStorageApi.GetProviderAsyncWithHttpInfo	(	string	accountId,
		string	userId,
		string	serviceId,
		CloudStorageApi.GetProviderOptions	options = `null`
	)

inline

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
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.
serviceId	The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (CloudStorageProviders)

◆ GetProviderWithHttpInfo()

ApiResponse<CloudStorageProviders> DocuSign.eSign.Api.CloudStorageApi.GetProviderWithHttpInfo	(	string	accountId,
		string	userId,
		string	serviceId,
		CloudStorageApi.GetProviderOptions	options = `null`
	)

inline

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
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.
serviceId	The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").
options	Options for modifying the behavior of the function.

Returns: ApiResponse of CloudStorageProviders

◆ List()

ExternalFolder DocuSign.eSign.Api.CloudStorageApi.List	(	string	accountId,
		string	userId,
		string	serviceId,
		string	folderId,
		CloudStorageApi.ListOptions	options = `null`
	)

inline

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
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.
serviceId	The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").
folderId	The ID of the folder being accessed.
options	Options for modifying the behavior of the function.

Returns: ExternalFolder

◆ ListAsync()

async System.Threading.Tasks.Task<ExternalFolder> DocuSign.eSign.Api.CloudStorageApi.ListAsync	(	string	accountId,
		string	userId,
		string	serviceId,
		string	folderId,
		CloudStorageApi.ListOptions	options = `null`
	)

inline

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
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.
serviceId	The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").
folderId	The ID of the folder being accessed.
options	Options for modifying the behavior of the function.

Returns: Task of ExternalFolder

◆ ListAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<ExternalFolder> > DocuSign.eSign.Api.CloudStorageApi.ListAsyncWithHttpInfo	(	string	accountId,
		string	userId,
		string	serviceId,
		string	folderId,
		CloudStorageApi.ListOptions	options = `null`
	)

inline

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
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.
serviceId	The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").
folderId	The ID of the folder being accessed.
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (ExternalFolder)

◆ ListFolders()

ExternalFolder DocuSign.eSign.Api.CloudStorageApi.ListFolders	(	string	accountId,
		string	userId,
		string	serviceId,
		CloudStorageApi.ListFoldersOptions	options = `null`
	)

inline

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
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.
serviceId	The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").
options	Options for modifying the behavior of the function.

Returns: ExternalFolder

◆ ListFoldersAsync()

async System.Threading.Tasks.Task<ExternalFolder> DocuSign.eSign.Api.CloudStorageApi.ListFoldersAsync	(	string	accountId,
		string	userId,
		string	serviceId,
		CloudStorageApi.ListFoldersOptions	options = `null`
	)

inline

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
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.
serviceId	The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").
options	Options for modifying the behavior of the function.

Returns: Task of ExternalFolder

◆ ListFoldersAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<ExternalFolder> > DocuSign.eSign.Api.CloudStorageApi.ListFoldersAsyncWithHttpInfo	(	string	accountId,
		string	userId,
		string	serviceId,
		CloudStorageApi.ListFoldersOptions	options = `null`
	)

inline

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
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.
serviceId	The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (ExternalFolder)

◆ ListFoldersWithHttpInfo()

ApiResponse<ExternalFolder> DocuSign.eSign.Api.CloudStorageApi.ListFoldersWithHttpInfo	(	string	accountId,
		string	userId,
		string	serviceId,
		CloudStorageApi.ListFoldersOptions	options = `null`
	)

inline

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
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.
serviceId	The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").
options	Options for modifying the behavior of the function.

Returns: ApiResponse of ExternalFolder

◆ ListProviders()

CloudStorageProviders DocuSign.eSign.Api.CloudStorageApi.ListProviders	(	string	accountId,
		string	userId,
		CloudStorageApi.ListProvidersOptions	options = `null`
	)

inline

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
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.
options	Options for modifying the behavior of the function.

Returns: CloudStorageProviders

◆ ListProvidersAsync()

async System.Threading.Tasks.Task<CloudStorageProviders> DocuSign.eSign.Api.CloudStorageApi.ListProvidersAsync	(	string	accountId,
		string	userId,
		CloudStorageApi.ListProvidersOptions	options = `null`
	)

inline

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
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.
options	Options for modifying the behavior of the function.

Returns: Task of CloudStorageProviders

◆ ListProvidersAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<CloudStorageProviders> > DocuSign.eSign.Api.CloudStorageApi.ListProvidersAsyncWithHttpInfo	(	string	accountId,
		string	userId,
		CloudStorageApi.ListProvidersOptions	options = `null`
	)

inline

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
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.
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (CloudStorageProviders)

◆ ListProvidersWithHttpInfo()

ApiResponse<CloudStorageProviders> DocuSign.eSign.Api.CloudStorageApi.ListProvidersWithHttpInfo	(	string	accountId,
		string	userId,
		CloudStorageApi.ListProvidersOptions	options = `null`
	)

inline

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
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.
options	Options for modifying the behavior of the function.

Returns: ApiResponse of CloudStorageProviders

◆ ListWithHttpInfo()

ApiResponse<ExternalFolder> DocuSign.eSign.Api.CloudStorageApi.ListWithHttpInfo	(	string	accountId,
		string	userId,
		string	serviceId,
		string	folderId,
		CloudStorageApi.ListOptions	options = `null`
	)

inline

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
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.
serviceId	The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").
folderId	The ID of the folder being accessed.
options	Options for modifying the behavior of the function.

Returns: ApiResponse of ExternalFolder

Property Documentation

◆ ApiClient

DocuSignClient DocuSign.eSign.Api.CloudStorageApi.ApiClient

getset

Gets or sets the ApiClient object

An instance of the ApiClient

◆ ExceptionFactory

DocuSign.eSign.Client.ExceptionFactory DocuSign.eSign.Api.CloudStorageApi.ExceptionFactory

getset

Provides a factory method hook for the creation of exceptions.

The documentation for this class was generated from the following file:

sdk/src/DocuSign.eSign/Api/CloudStorageApi.cs

Classes

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ CloudStorageApi()

Member Function Documentation

◆ CreateProvider()

◆ CreateProviderAsync()

◆ CreateProviderAsyncWithHttpInfo()

◆ CreateProviderWithHttpInfo()

◆ DeleteProvider()

◆ DeleteProviderAsync()

◆ DeleteProviderAsyncWithHttpInfo()

◆ DeleteProviders()

◆ DeleteProvidersAsync()

◆ DeleteProvidersAsyncWithHttpInfo()

◆ DeleteProvidersWithHttpInfo()

◆ DeleteProviderWithHttpInfo()

◆ GetBasePath()

◆ GetProvider()

◆ GetProviderAsync()

◆ GetProviderAsyncWithHttpInfo()

◆ GetProviderWithHttpInfo()

◆ List()

◆ ListAsync()

◆ ListAsyncWithHttpInfo()

◆ ListFolders()

◆ ListFoldersAsync()

◆ ListFoldersAsyncWithHttpInfo()

◆ ListFoldersWithHttpInfo()

◆ ListProviders()

◆ ListProvidersAsync()

◆ ListProvidersAsyncWithHttpInfo()

◆ ListProvidersWithHttpInfo()

◆ ListWithHttpInfo()

Property Documentation

◆ ApiClient

◆ ExceptionFactory