Represents a collection of functions to interact with the API endpoints More...
Public Member Functions | |
| 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. 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. More... | |
| CloudStorageProviders | DeleteProvider (string accountId, string userId, string serviceId) |
| Deletes the user authentication information for the specified cloud storage provider. More... | |
| ApiResponse< CloudStorageProviders > | DeleteProviderWithHttpInfo (string accountId, string userId, string serviceId) |
| Deletes the user authentication information for the specified 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. More... | |
| ApiResponse< CloudStorageProviders > | DeleteProvidersWithHttpInfo (string accountId, string userId, CloudStorageProviders cloudStorageProviders=null) |
| Deletes the user authentication information for one or more cloud storage providers. More... | |
| 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 > | CreateProviderAsync (string accountId, string userId, CloudStorageProviders cloudStorageProviders=null) |
| Configures the redirect URL information for one or more cloud storage providers for the specified user. More... | |
| 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. More... | |
| System.Threading.Tasks.Task< CloudStorageProviders > | DeleteProviderAsync (string accountId, string userId, string serviceId) |
| Deletes the user authentication information for the specified cloud storage provider. More... | |
| System.Threading.Tasks.Task< ApiResponse< CloudStorageProviders > > | DeleteProviderAsyncWithHttpInfo (string accountId, string userId, string serviceId) |
| Deletes the user authentication information for the specified cloud storage provider. More... | |
| 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. More... | |
| 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. 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... | |
 Public Member Functions inherited from DocuSign.eSign.Client.IApiAccessor | |
| String | GetBasePath () |
| Gets the base path of the API client. More... | |
Additional Inherited Members | |
| 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
Member Function Documentation
◆ CreateProvider()
| CloudStorageProviders DocuSign.eSign.Api.ICloudStorageApi.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.
- 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
Implemented in DocuSign.eSign.Api.CloudStorageApi.
◆ CreateProviderAsync()
| System.Threading.Tasks.Task<CloudStorageProviders> DocuSign.eSign.Api.ICloudStorageApi.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.
- 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
Implemented in DocuSign.eSign.Api.CloudStorageApi.
◆ CreateProviderAsyncWithHttpInfo()
| System.Threading.Tasks.Task<ApiResponse<CloudStorageProviders> > DocuSign.eSign.Api.ICloudStorageApi.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.
- 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)
Implemented in DocuSign.eSign.Api.CloudStorageApi.
◆ CreateProviderWithHttpInfo()
| ApiResponse<CloudStorageProviders> DocuSign.eSign.Api.ICloudStorageApi.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.
- 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
Implemented in DocuSign.eSign.Api.CloudStorageApi.
◆ DeleteProvider()
| CloudStorageProviders DocuSign.eSign.Api.ICloudStorageApi.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.
- 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
Implemented in DocuSign.eSign.Api.CloudStorageApi.
◆ DeleteProviderAsync()
| System.Threading.Tasks.Task<CloudStorageProviders> DocuSign.eSign.Api.ICloudStorageApi.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.
- 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
Implemented in DocuSign.eSign.Api.CloudStorageApi.
◆ DeleteProviderAsyncWithHttpInfo()
| System.Threading.Tasks.Task<ApiResponse<CloudStorageProviders> > DocuSign.eSign.Api.ICloudStorageApi.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.
- 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)
Implemented in DocuSign.eSign.Api.CloudStorageApi.
◆ DeleteProviders()
| CloudStorageProviders DocuSign.eSign.Api.ICloudStorageApi.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.
- 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
Implemented in DocuSign.eSign.Api.CloudStorageApi.
◆ DeleteProvidersAsync()
| System.Threading.Tasks.Task<CloudStorageProviders> DocuSign.eSign.Api.ICloudStorageApi.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.
- 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
Implemented in DocuSign.eSign.Api.CloudStorageApi.
◆ DeleteProvidersAsyncWithHttpInfo()
| System.Threading.Tasks.Task<ApiResponse<CloudStorageProviders> > DocuSign.eSign.Api.ICloudStorageApi.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.
- 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)
Implemented in DocuSign.eSign.Api.CloudStorageApi.
◆ DeleteProvidersWithHttpInfo()
| ApiResponse<CloudStorageProviders> DocuSign.eSign.Api.ICloudStorageApi.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.
- 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
Implemented in DocuSign.eSign.Api.CloudStorageApi.
◆ DeleteProviderWithHttpInfo()
| ApiResponse<CloudStorageProviders> DocuSign.eSign.Api.ICloudStorageApi.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.
- 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
Implemented in DocuSign.eSign.Api.CloudStorageApi.
◆ GetProvider()
| CloudStorageProviders DocuSign.eSign.Api.ICloudStorageApi.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.
- 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
◆ GetProviderAsync()
| System.Threading.Tasks.Task<CloudStorageProviders> DocuSign.eSign.Api.ICloudStorageApi.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.
- 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()
| System.Threading.Tasks.Task<ApiResponse<CloudStorageProviders> > DocuSign.eSign.Api.ICloudStorageApi.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.
- 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.ICloudStorageApi.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.
- 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
◆ List()
| ExternalFolder DocuSign.eSign.Api.ICloudStorageApi.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.
- 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
◆ ListAsync()
| System.Threading.Tasks.Task<ExternalFolder> DocuSign.eSign.Api.ICloudStorageApi.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.
- 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()
| System.Threading.Tasks.Task<ApiResponse<ExternalFolder> > DocuSign.eSign.Api.ICloudStorageApi.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.
- 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.ICloudStorageApi.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.
- 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
◆ ListFoldersAsync()
| System.Threading.Tasks.Task<ExternalFolder> DocuSign.eSign.Api.ICloudStorageApi.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.
- 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()
| System.Threading.Tasks.Task<ApiResponse<ExternalFolder> > DocuSign.eSign.Api.ICloudStorageApi.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.
- 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.ICloudStorageApi.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.
- 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
◆ ListProviders()
| CloudStorageProviders DocuSign.eSign.Api.ICloudStorageApi.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.
- 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
◆ ListProvidersAsync()
| System.Threading.Tasks.Task<CloudStorageProviders> DocuSign.eSign.Api.ICloudStorageApi.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.
- 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()
| System.Threading.Tasks.Task<ApiResponse<CloudStorageProviders> > DocuSign.eSign.Api.ICloudStorageApi.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.
- 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.ICloudStorageApi.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.
- 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
◆ ListWithHttpInfo()
| ApiResponse<ExternalFolder> DocuSign.eSign.Api.ICloudStorageApi.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.
- 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
The documentation for this interface was generated from the following file:
- sdk/src/DocuSign.eSign/Api/CloudStorageApi.cs
