WorkspacesApi
in package
WorkspacesApi Class Doc Comment
Tags
Table of Contents
- $apiClient : ApiClient
- API Client
- __construct() : void
- Constructor
- createWorkspace() : Workspace
- Operation createWorkspace
- createWorkspaceFile() : WorkspaceItem
- Operation createWorkspaceFile
- createWorkspaceFileWithHttpInfo() : array<string|int, mixed>
- Operation createWorkspaceFileWithHttpInfo
- createWorkspaceWithHttpInfo() : array<string|int, mixed>
- Operation createWorkspaceWithHttpInfo
- deleteWorkspace() : Workspace
- Operation deleteWorkspace
- deleteWorkspaceFolderItems() : mixed
- Operation deleteWorkspaceFolderItems
- deleteWorkspaceFolderItemsWithHttpInfo() : array<string|int, mixed>
- Operation deleteWorkspaceFolderItemsWithHttpInfo
- deleteWorkspaceWithHttpInfo() : array<string|int, mixed>
- Operation deleteWorkspaceWithHttpInfo
- getApiClient() : ApiClient
- Get API client
- getWorkspace() : Workspace
- Operation getWorkspace
- getWorkspaceFile() : mixed
- Operation getWorkspaceFile
- getWorkspaceFileWithHttpInfo() : array<string|int, mixed>
- Operation getWorkspaceFileWithHttpInfo
- getWorkspaceWithHttpInfo() : array<string|int, mixed>
- Operation getWorkspaceWithHttpInfo
- listWorkspaceFilePages() : PageImages
- Operation listWorkspaceFilePages
- listWorkspaceFilePagesWithHttpInfo() : array<string|int, mixed>
- Operation listWorkspaceFilePagesWithHttpInfo
- listWorkspaceFolderItems() : WorkspaceFolderContents
- Operation listWorkspaceFolderItems
- listWorkspaceFolderItemsWithHttpInfo() : array<string|int, mixed>
- Operation listWorkspaceFolderItemsWithHttpInfo
- listWorkspaces() : WorkspaceList
- Operation listWorkspaces
- listWorkspacesWithHttpInfo() : array<string|int, mixed>
- Operation listWorkspacesWithHttpInfo
- setApiClient() : self
- Set the API client
- updateResourcePath() : string
- Update $resourcePath with $
- updateWorkspace() : Workspace
- Operation updateWorkspace
- updateWorkspaceFile() : WorkspaceItem
- Operation updateWorkspaceFile
- updateWorkspaceFileWithHttpInfo() : array<string|int, mixed>
- Operation updateWorkspaceFileWithHttpInfo
- updateWorkspaceWithHttpInfo() : array<string|int, mixed>
- Operation updateWorkspaceWithHttpInfo
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 —createWorkspace()
Operation createWorkspace
public
createWorkspace(string|null $account_id[, Workspace $workspace = null ]) : Workspace
Create a Workspace
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $workspace : Workspace = null
-
(optional)
Tags
Return values
Workspace —createWorkspaceFile()
Operation createWorkspaceFile
public
createWorkspaceFile(string|null $account_id, string|null $folder_id, string|null $workspace_id) : WorkspaceItem
Creates a workspace file.
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.
- $workspace_id : string|null
-
Specifies the workspace ID GUID.
Tags
Return values
WorkspaceItem —createWorkspaceFileWithHttpInfo()
Operation createWorkspaceFileWithHttpInfo
public
createWorkspaceFileWithHttpInfo(string|null $account_id, string|null $folder_id, string|null $workspace_id) : array<string|int, mixed>
Creates a workspace file.
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.
- $workspace_id : string|null
-
Specifies the workspace ID GUID.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\WorkspaceItem, HTTP status code, HTTP response headers (array of strings)
createWorkspaceWithHttpInfo()
Operation createWorkspaceWithHttpInfo
public
createWorkspaceWithHttpInfo(string|null $account_id[, Workspace $workspace = null ]) : array<string|int, mixed>
Create a Workspace
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $workspace : Workspace = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\Workspace, HTTP status code, HTTP response headers (array of strings)
deleteWorkspace()
Operation deleteWorkspace
public
deleteWorkspace(string|null $account_id, string|null $workspace_id) : Workspace
Delete Workspace
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $workspace_id : string|null
-
Specifies the workspace ID GUID.
Tags
Return values
Workspace —deleteWorkspaceFolderItems()
Operation deleteWorkspaceFolderItems
public
deleteWorkspaceFolderItems(string|null $account_id, string|null $folder_id, string|null $workspace_id[, WorkspaceItemList $workspace_item_list = null ]) : mixed
Deletes workspace one or more specific files/folders from the given folder or root.
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.
- $workspace_id : string|null
-
Specifies the workspace ID GUID.
- $workspace_item_list : WorkspaceItemList = null
-
(optional)
Tags
Return values
mixed —deleteWorkspaceFolderItemsWithHttpInfo()
Operation deleteWorkspaceFolderItemsWithHttpInfo
public
deleteWorkspaceFolderItemsWithHttpInfo(string|null $account_id, string|null $folder_id, string|null $workspace_id[, WorkspaceItemList $workspace_item_list = null ]) : array<string|int, mixed>
Deletes workspace one or more specific files/folders from the given folder or root.
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.
- $workspace_id : string|null
-
Specifies the workspace ID GUID.
- $workspace_item_list : WorkspaceItemList = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
deleteWorkspaceWithHttpInfo()
Operation deleteWorkspaceWithHttpInfo
public
deleteWorkspaceWithHttpInfo(string|null $account_id, string|null $workspace_id) : array<string|int, mixed>
Delete Workspace
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $workspace_id : string|null
-
Specifies the workspace ID GUID.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\Workspace, HTTP status code, HTTP response headers (array of strings)
getApiClient()
Get API client
public
getApiClient() : ApiClient
Return values
ApiClient —get the API client
getWorkspace()
Operation getWorkspace
public
getWorkspace(string|null $account_id, string|null $workspace_id) : Workspace
Get Workspace
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $workspace_id : string|null
-
Specifies the workspace ID GUID.
Tags
Return values
Workspace —getWorkspaceFile()
Operation getWorkspaceFile
public
getWorkspaceFile(string|null $account_id, string|null $file_id, string|null $folder_id, string|null $workspace_id[, GetWorkspaceFileOptions $options = null ]) : mixed
Get Workspace File
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $file_id : string|null
-
Specifies the room file ID GUID.
- $folder_id : string|null
-
The ID of the folder being accessed.
- $workspace_id : string|null
-
Specifies the workspace ID GUID.
- $options : GetWorkspaceFileOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
mixed —getWorkspaceFileWithHttpInfo()
Operation getWorkspaceFileWithHttpInfo
public
getWorkspaceFileWithHttpInfo(string|null $account_id, string|null $file_id, string|null $folder_id, string|null $workspace_id[, GetWorkspaceFileOptions $options = null ]) : array<string|int, mixed>
Get Workspace File
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $file_id : string|null
-
Specifies the room file ID GUID.
- $folder_id : string|null
-
The ID of the folder being accessed.
- $workspace_id : string|null
-
Specifies the workspace ID GUID.
- $options : GetWorkspaceFileOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
getWorkspaceWithHttpInfo()
Operation getWorkspaceWithHttpInfo
public
getWorkspaceWithHttpInfo(string|null $account_id, string|null $workspace_id) : array<string|int, mixed>
Get Workspace
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $workspace_id : string|null
-
Specifies the workspace ID GUID.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\Workspace, HTTP status code, HTTP response headers (array of strings)
listWorkspaceFilePages()
Operation listWorkspaceFilePages
public
listWorkspaceFilePages(string|null $account_id, string|null $file_id, string|null $folder_id, string|null $workspace_id[, ListWorkspaceFilePagesOptions $options = null ]) : PageImages
List File Pages
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $file_id : string|null
-
Specifies the room file ID GUID.
- $folder_id : string|null
-
The ID of the folder being accessed.
- $workspace_id : string|null
-
Specifies the workspace ID GUID.
- $options : ListWorkspaceFilePagesOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
PageImages —listWorkspaceFilePagesWithHttpInfo()
Operation listWorkspaceFilePagesWithHttpInfo
public
listWorkspaceFilePagesWithHttpInfo(string|null $account_id, string|null $file_id, string|null $folder_id, string|null $workspace_id[, ListWorkspaceFilePagesOptions $options = null ]) : array<string|int, mixed>
List File Pages
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $file_id : string|null
-
Specifies the room file ID GUID.
- $folder_id : string|null
-
The ID of the folder being accessed.
- $workspace_id : string|null
-
Specifies the workspace ID GUID.
- $options : ListWorkspaceFilePagesOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\PageImages, HTTP status code, HTTP response headers (array of strings)
listWorkspaceFolderItems()
Operation listWorkspaceFolderItems
public
listWorkspaceFolderItems(string|null $account_id, string|null $folder_id, string|null $workspace_id[, ListWorkspaceFolderItemsOptions $options = null ]) : WorkspaceFolderContents
List Workspace Folder Contents
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.
- $workspace_id : string|null
-
Specifies the workspace ID GUID.
- $options : ListWorkspaceFolderItemsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
WorkspaceFolderContents —listWorkspaceFolderItemsWithHttpInfo()
Operation listWorkspaceFolderItemsWithHttpInfo
public
listWorkspaceFolderItemsWithHttpInfo(string|null $account_id, string|null $folder_id, string|null $workspace_id[, ListWorkspaceFolderItemsOptions $options = null ]) : array<string|int, mixed>
List Workspace Folder Contents
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.
- $workspace_id : string|null
-
Specifies the workspace ID GUID.
- $options : ListWorkspaceFolderItemsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\WorkspaceFolderContents, HTTP status code, HTTP response headers (array of strings)
listWorkspaces()
Operation listWorkspaces
public
listWorkspaces(string|null $account_id) : WorkspaceList
List Workspaces
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
WorkspaceList —listWorkspacesWithHttpInfo()
Operation listWorkspacesWithHttpInfo
public
listWorkspacesWithHttpInfo(string|null $account_id) : array<string|int, mixed>
List Workspaces
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\WorkspaceList, 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
Return values
string —updateWorkspace()
Operation updateWorkspace
public
updateWorkspace(string|null $account_id, string|null $workspace_id[, Workspace $workspace = null ]) : Workspace
Update Workspace
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $workspace_id : string|null
-
Specifies the workspace ID GUID.
- $workspace : Workspace = null
-
(optional)
Tags
Return values
Workspace —updateWorkspaceFile()
Operation updateWorkspaceFile
public
updateWorkspaceFile(string|null $account_id, string|null $file_id, string|null $folder_id, string|null $workspace_id) : WorkspaceItem
Update Workspace File Metadata
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $file_id : string|null
-
Specifies the room file ID GUID.
- $folder_id : string|null
-
The ID of the folder being accessed.
- $workspace_id : string|null
-
Specifies the workspace ID GUID.
Tags
Return values
WorkspaceItem —updateWorkspaceFileWithHttpInfo()
Operation updateWorkspaceFileWithHttpInfo
public
updateWorkspaceFileWithHttpInfo(string|null $account_id, string|null $file_id, string|null $folder_id, string|null $workspace_id) : array<string|int, mixed>
Update Workspace File Metadata
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $file_id : string|null
-
Specifies the room file ID GUID.
- $folder_id : string|null
-
The ID of the folder being accessed.
- $workspace_id : string|null
-
Specifies the workspace ID GUID.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\WorkspaceItem, HTTP status code, HTTP response headers (array of strings)
updateWorkspaceWithHttpInfo()
Operation updateWorkspaceWithHttpInfo
public
updateWorkspaceWithHttpInfo(string|null $account_id, string|null $workspace_id[, Workspace $workspace = null ]) : array<string|int, mixed>
Update Workspace
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $workspace_id : string|null
-
Specifies the workspace ID GUID.
- $workspace : Workspace = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\Workspace, HTTP status code, HTTP response headers (array of strings)