FoldersApi
in package
FoldersApi Class Doc Comment
Tags
Table of Contents
- $apiClient : ApiClient
- API Client
- __construct() : void
- Constructor
- callList() : FoldersResponse
- Operation callList
- callListWithHttpInfo() : array<string|int, mixed>
- Operation callListWithHttpInfo
- getApiClient() : ApiClient
- Get API client
- listItems() : FolderItemsResponse
- Operation listItems
- listItemsWithHttpInfo() : array<string|int, mixed>
- Operation listItemsWithHttpInfo
- moveEnvelopes() : FoldersResponse
- Operation moveEnvelopes
- moveEnvelopesWithHttpInfo() : array<string|int, mixed>
- Operation moveEnvelopesWithHttpInfo
- search() : FolderItemResponse
- Operation search
- searchWithHttpInfo() : array<string|int, mixed>
- Operation searchWithHttpInfo
- 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[, ListOptions $options = null ]) : FoldersResponse
Gets a list of the folders for the account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : ListOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
FoldersResponse —callListWithHttpInfo()
Operation callListWithHttpInfo
public
callListWithHttpInfo(string|null $account_id[, ListOptions $options = null ]) : array<string|int, mixed>
Gets a list of the folders for the account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : ListOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\FoldersResponse, HTTP status code, HTTP response headers (array of strings)
getApiClient()
Get API client
public
getApiClient() : ApiClient
Return values
ApiClient —get the API client
listItems()
Operation listItems
public
listItems(string|null $account_id, string|null $folder_id[, ListItemsOptions $options = null ]) : FolderItemsResponse
Gets a list of the envelopes in the specified folder.
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.
- $options : ListItemsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
FolderItemsResponse —listItemsWithHttpInfo()
Operation listItemsWithHttpInfo
public
listItemsWithHttpInfo(string|null $account_id, string|null $folder_id[, ListItemsOptions $options = null ]) : array<string|int, mixed>
Gets a list of the envelopes in the specified folder.
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.
- $options : ListItemsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\FolderItemsResponse, HTTP status code, HTTP response headers (array of strings)
moveEnvelopes()
Operation moveEnvelopes
public
moveEnvelopes(string|null $account_id, string|null $folder_id[, FoldersRequest $folders_request = null ]) : FoldersResponse
Moves an envelope from its current folder to the specified folder.
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.
- $folders_request : FoldersRequest = null
-
(optional)
Tags
Return values
FoldersResponse —moveEnvelopesWithHttpInfo()
Operation moveEnvelopesWithHttpInfo
public
moveEnvelopesWithHttpInfo(string|null $account_id, string|null $folder_id[, FoldersRequest $folders_request = null ]) : array<string|int, mixed>
Moves an envelope from its current folder to the specified folder.
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.
- $folders_request : FoldersRequest = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\FoldersResponse, HTTP status code, HTTP response headers (array of strings)
search()
Operation search
public
search(string|null $account_id, string|null $search_folder_id[, SearchOptions $options = null ]) : FolderItemResponse
Gets a list of envelopes in folders matching the specified criteria.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $search_folder_id : string|null
-
Specifies the envelope group that is searched by the request. These are logical groupings, not actual folder names. Valid values are: drafts, awaiting_my_signature, completed, out_for_signature.
- $options : SearchOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
FolderItemResponse —searchWithHttpInfo()
Operation searchWithHttpInfo
public
searchWithHttpInfo(string|null $account_id, string|null $search_folder_id[, SearchOptions $options = null ]) : array<string|int, mixed>
Gets a list of envelopes in folders matching the specified criteria.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $search_folder_id : string|null
-
Specifies the envelope group that is searched by the request. These are logical groupings, not actual folder names. Valid values are: drafts, awaiting_my_signature, completed, out_for_signature.
- $options : SearchOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\FolderItemResponse, 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