CloudStorageApi
in package
CloudStorageApi Class Doc Comment
Tags
Table of Contents
- $apiClient : ApiClient
- API Client
- __construct() : void
- Constructor
- callList() : ExternalFolder
- Operation callList
- callListWithHttpInfo() : array<string|int, mixed>
- Operation callListWithHttpInfo
- createProvider() : CloudStorageProviders
- Operation createProvider
- createProviderWithHttpInfo() : array<string|int, mixed>
- Operation createProviderWithHttpInfo
- deleteProvider() : CloudStorageProviders
- Operation deleteProvider
- deleteProviders() : CloudStorageProviders
- Operation deleteProviders
- deleteProvidersWithHttpInfo() : array<string|int, mixed>
- Operation deleteProvidersWithHttpInfo
- deleteProviderWithHttpInfo() : array<string|int, mixed>
- Operation deleteProviderWithHttpInfo
- getApiClient() : ApiClient
- Get API client
- getProvider() : CloudStorageProviders
- Operation getProvider
- getProviderWithHttpInfo() : array<string|int, mixed>
- Operation getProviderWithHttpInfo
- listFolders() : ExternalFolder
- Operation listFolders
- listFoldersWithHttpInfo() : array<string|int, mixed>
- Operation listFoldersWithHttpInfo
- listProviders() : CloudStorageProviders
- Operation listProviders
- listProvidersWithHttpInfo() : array<string|int, mixed>
- Operation listProvidersWithHttpInfo
- setApiClient() : self
- Set the API client
- updateResourcePath() : string
- Update $resourcePath with $
Properties
$apiClient
API Client
protected
ApiClient
$apiClient
instance of the ApiClient
Methods
__construct()
Constructor
public
__construct([ApiClient|null $apiClient = null ]) : void
Parameters
- $apiClient : ApiClient|null = null
-
The api client to use
Return values
void —callList()
Operation callList
public
callList(string|null $account_id, string|null $folder_id, string|null $service_id, string|null $user_id[, ListOptions $options = null ]) : ExternalFolder
Gets a list of all the items from the specified cloud storage provider.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $folder_id : string|null
-
The ID of the folder being accessed.
- $service_id : string|null
-
The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").
- $user_id : string|null
-
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 : ListOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
ExternalFolder —callListWithHttpInfo()
Operation callListWithHttpInfo
public
callListWithHttpInfo(string|null $account_id, string|null $folder_id, string|null $service_id, string|null $user_id[, ListOptions $options = null ]) : array<string|int, mixed>
Gets a list of all the items from the specified cloud storage provider.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $folder_id : string|null
-
The ID of the folder being accessed.
- $service_id : string|null
-
The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").
- $user_id : string|null
-
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 : ListOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\ExternalFolder, HTTP status code, HTTP response headers (array of strings)
createProvider()
Operation createProvider
public
createProvider(string|null $account_id, string|null $user_id[, CloudStorageProviders $cloud_storage_providers = null ]) : CloudStorageProviders
Configures the redirect URL information for one or more cloud storage providers for the specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $cloud_storage_providers : CloudStorageProviders = null
-
(optional)
Tags
Return values
CloudStorageProviders —createProviderWithHttpInfo()
Operation createProviderWithHttpInfo
public
createProviderWithHttpInfo(string|null $account_id, string|null $user_id[, CloudStorageProviders $cloud_storage_providers = null ]) : array<string|int, mixed>
Configures the redirect URL information for one or more cloud storage providers for the specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $cloud_storage_providers : CloudStorageProviders = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\CloudStorageProviders, HTTP status code, HTTP response headers (array of strings)
deleteProvider()
Operation deleteProvider
public
deleteProvider(string|null $account_id, string|null $service_id, string|null $user_id) : CloudStorageProviders
Deletes the user authentication information for the specified cloud storage provider.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $service_id : string|null
-
The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").
- $user_id : string|null
-
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.
Tags
Return values
CloudStorageProviders —deleteProviders()
Operation deleteProviders
public
deleteProviders(string|null $account_id, string|null $user_id[, CloudStorageProviders $cloud_storage_providers = null ]) : CloudStorageProviders
Deletes the user authentication information for one or more cloud storage providers.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $cloud_storage_providers : CloudStorageProviders = null
-
(optional)
Tags
Return values
CloudStorageProviders —deleteProvidersWithHttpInfo()
Operation deleteProvidersWithHttpInfo
public
deleteProvidersWithHttpInfo(string|null $account_id, string|null $user_id[, CloudStorageProviders $cloud_storage_providers = null ]) : array<string|int, mixed>
Deletes the user authentication information for one or more cloud storage providers.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $cloud_storage_providers : CloudStorageProviders = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\CloudStorageProviders, HTTP status code, HTTP response headers (array of strings)
deleteProviderWithHttpInfo()
Operation deleteProviderWithHttpInfo
public
deleteProviderWithHttpInfo(string|null $account_id, string|null $service_id, string|null $user_id) : array<string|int, mixed>
Deletes the user authentication information for the specified cloud storage provider.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $service_id : string|null
-
The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").
- $user_id : string|null
-
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.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\CloudStorageProviders, HTTP status code, HTTP response headers (array of strings)
getApiClient()
Get API client
public
getApiClient() : ApiClient
Return values
ApiClient —get the API client
getProvider()
Operation getProvider
public
getProvider(string|null $account_id, string|null $service_id, string|null $user_id[, GetProviderOptions $options = null ]) : CloudStorageProviders
Gets the specified Cloud Storage Provider configuration for the User.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $service_id : string|null
-
The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").
- $user_id : string|null
-
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 : GetProviderOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
CloudStorageProviders —getProviderWithHttpInfo()
Operation getProviderWithHttpInfo
public
getProviderWithHttpInfo(string|null $account_id, string|null $service_id, string|null $user_id[, GetProviderOptions $options = null ]) : array<string|int, mixed>
Gets the specified Cloud Storage Provider configuration for the User.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $service_id : string|null
-
The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").
- $user_id : string|null
-
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 : GetProviderOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\CloudStorageProviders, HTTP status code, HTTP response headers (array of strings)
listFolders()
Operation listFolders
public
listFolders(string|null $account_id, string|null $service_id, string|null $user_id[, ListFoldersOptions $options = null ]) : ExternalFolder
Retrieves a list of all the items in a specified folder from the specified cloud storage provider.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $service_id : string|null
-
The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").
- $user_id : string|null
-
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 : ListFoldersOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
ExternalFolder —listFoldersWithHttpInfo()
Operation listFoldersWithHttpInfo
public
listFoldersWithHttpInfo(string|null $account_id, string|null $service_id, string|null $user_id[, ListFoldersOptions $options = null ]) : array<string|int, mixed>
Retrieves a list of all the items in a specified folder from the specified cloud storage provider.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $service_id : string|null
-
The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").
- $user_id : string|null
-
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 : ListFoldersOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\ExternalFolder, HTTP status code, HTTP response headers (array of strings)
listProviders()
Operation listProviders
public
listProviders(string|null $account_id, string|null $user_id[, ListProvidersOptions $options = null ]) : CloudStorageProviders
Get the Cloud Storage Provider configuration for the specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
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 : ListProvidersOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
CloudStorageProviders —listProvidersWithHttpInfo()
Operation listProvidersWithHttpInfo
public
listProvidersWithHttpInfo(string|null $account_id, string|null $user_id[, ListProvidersOptions $options = null ]) : array<string|int, mixed>
Get the Cloud Storage Provider configuration for the specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
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 : ListProvidersOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\CloudStorageProviders, HTTP status code, HTTP response headers (array of strings)
setApiClient()
Set the API client
public
setApiClient(ApiClient $apiClient) : self
Parameters
- $apiClient : ApiClient
-
set the API client
Return values
self —updateResourcePath()
Update $resourcePath with $
public
updateResourcePath(string $resourcePath, string $baseName, string $paramName) : string
Parameters
- $resourcePath : string
-
the resource path to use
- $baseName : string
-
the base name param
- $paramName : string
-
the parameter name