Package com.stackone.stackone_client_java

Class Documents

java.lang.Object

com.stackone.stackone_client_java.Documents

public class Documents
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
AsyncDocuments	async()	Switches to the async SDK.
DocumentsDownloadFileRequestBuilder	downloadFile()	Download File
DocumentsDownloadFileResponse	downloadFile(DocumentsDownloadFileRequest request)	Download File
DocumentsDownloadFileResponse	downloadFile(DocumentsDownloadFileRequest request, java.util.Optional<Options> options)	Download File
DocumentsGetDriveRequestBuilder	getDrive()	Get Drive
DocumentsGetDriveResponse	getDrive(DocumentsGetDriveRequest request)	Get Drive
DocumentsGetDriveResponse	getDrive(DocumentsGetDriveRequest request, java.util.Optional<Options> options)	Get Drive
DocumentsGetFileRequestBuilder	getFile()	Get File
DocumentsGetFileResponse	getFile(DocumentsGetFileRequest request)	Get File
DocumentsGetFileResponse	getFile(DocumentsGetFileRequest request, java.util.Optional<Options> options)	Get File
DocumentsGetFolderRequestBuilder	getFolder()	Get Folder
DocumentsGetFolderResponse	getFolder(DocumentsGetFolderRequest request)	Get Folder
DocumentsGetFolderResponse	getFolder(DocumentsGetFolderRequest request, java.util.Optional<Options> options)	Get Folder
DocumentsListDrivesRequestBuilder	listDrives()	List Drives
DocumentsListDrivesResponse	listDrives(DocumentsListDrivesRequest request)	List Drives
DocumentsListDrivesResponse	listDrives(DocumentsListDrivesRequest request, java.util.Optional<Options> options)	List Drives
DocumentsListFilesRequestBuilder	listFiles()	List Files
DocumentsListFilesResponse	listFiles(DocumentsListFilesRequest request)	List Files
DocumentsListFilesResponse	listFiles(DocumentsListFilesRequest request, java.util.Optional<Options> options)	List Files
DocumentsListFoldersRequestBuilder	listFolders()	List Folders
DocumentsListFoldersResponse	listFolders(DocumentsListFoldersRequest request)	List Folders
DocumentsListFoldersResponse	listFolders(DocumentsListFoldersRequest request, java.util.Optional<Options> options)	List Folders
DocumentsUploadFileRequestBuilder	uploadFile()	Upload File
DocumentsUploadFileResponse	uploadFile(java.lang.String xAccountId, UnifiedUploadRequestDto unifiedUploadRequestDto)	Upload File
DocumentsUploadFileResponse	uploadFile(java.lang.String xAccountId, java.util.Optional<java.lang.String> xStackoneApiSessionToken, UnifiedUploadRequestDto unifiedUploadRequestDto, java.util.Optional<Options> options)	Upload File

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

async

public AsyncDocuments async()

Switches to the async SDK.

Returns:

The async SDK

downloadFile

public DocumentsDownloadFileRequestBuilder downloadFile()

Download File

Returns:

The call builder

downloadFile

public DocumentsDownloadFileResponse downloadFile(DocumentsDownloadFileRequest request)
                                           throws java.lang.Exception

Download File

Parameters:

request - The request object containing all the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

downloadFile

public DocumentsDownloadFileResponse downloadFile(DocumentsDownloadFileRequest request,
                                                  java.util.Optional<Options> options)
                                           throws java.lang.Exception

Download File

Parameters:

request - The request object containing all the parameters for the API call.

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

uploadFile

public DocumentsUploadFileRequestBuilder uploadFile()

Upload File

Returns:

The call builder

uploadFile

public DocumentsUploadFileResponse uploadFile(java.lang.String xAccountId,
                                              UnifiedUploadRequestDto unifiedUploadRequestDto)
                                       throws java.lang.Exception

Upload File

Parameters:

xAccountId - The account identifier

unifiedUploadRequestDto -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

uploadFile

public DocumentsUploadFileResponse uploadFile(java.lang.String xAccountId,
                                              java.util.Optional<java.lang.String> xStackoneApiSessionToken,
                                              UnifiedUploadRequestDto unifiedUploadRequestDto,
                                              java.util.Optional<Options> options)
                                       throws java.lang.Exception

Upload File

Parameters:

xAccountId - The account identifier

xStackoneApiSessionToken - The session token

unifiedUploadRequestDto -

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

listFiles

public DocumentsListFilesRequestBuilder listFiles()

List Files

Returns:

The call builder

listFiles

public DocumentsListFilesResponse listFiles(DocumentsListFilesRequest request)
                                     throws java.lang.Exception

List Files

Parameters:

request - The request object containing all the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

listFiles

public DocumentsListFilesResponse listFiles(DocumentsListFilesRequest request,
                                            java.util.Optional<Options> options)
                                     throws java.lang.Exception

List Files

Parameters:

request - The request object containing all the parameters for the API call.

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getFile

public DocumentsGetFileRequestBuilder getFile()

Get File

Returns:

The call builder

getFile

public DocumentsGetFileResponse getFile(DocumentsGetFileRequest request)
                                 throws java.lang.Exception

Get File

Parameters:

request - The request object containing all the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getFile

public DocumentsGetFileResponse getFile(DocumentsGetFileRequest request,
                                        java.util.Optional<Options> options)
                                 throws java.lang.Exception

Get File

Parameters:

request - The request object containing all the parameters for the API call.

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

listFolders

public DocumentsListFoldersRequestBuilder listFolders()

List Folders

Returns:

The call builder

listFolders

public DocumentsListFoldersResponse listFolders(DocumentsListFoldersRequest request)
                                         throws java.lang.Exception

List Folders

Parameters:

request - The request object containing all the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

listFolders

public DocumentsListFoldersResponse listFolders(DocumentsListFoldersRequest request,
                                                java.util.Optional<Options> options)
                                         throws java.lang.Exception

List Folders

Parameters:

request - The request object containing all the parameters for the API call.

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getFolder

public DocumentsGetFolderRequestBuilder getFolder()

Get Folder

Returns:

The call builder

getFolder

public DocumentsGetFolderResponse getFolder(DocumentsGetFolderRequest request)
                                     throws java.lang.Exception

Get Folder

Parameters:

request - The request object containing all the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getFolder

public DocumentsGetFolderResponse getFolder(DocumentsGetFolderRequest request,
                                            java.util.Optional<Options> options)
                                     throws java.lang.Exception

Get Folder

Parameters:

request - The request object containing all the parameters for the API call.

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

listDrives

public DocumentsListDrivesRequestBuilder listDrives()

List Drives

Returns:

The call builder

listDrives

public DocumentsListDrivesResponse listDrives(DocumentsListDrivesRequest request)
                                       throws java.lang.Exception

List Drives

Parameters:

request - The request object containing all the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

listDrives

public DocumentsListDrivesResponse listDrives(DocumentsListDrivesRequest request,
                                              java.util.Optional<Options> options)
                                       throws java.lang.Exception

List Drives

Parameters:

request - The request object containing all the parameters for the API call.

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getDrive

public DocumentsGetDriveRequestBuilder getDrive()

Get Drive

Returns:

The call builder

getDrive

public DocumentsGetDriveResponse getDrive(DocumentsGetDriveRequest request)
                                   throws java.lang.Exception

Get Drive

Parameters:

request - The request object containing all the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getDrive

public DocumentsGetDriveResponse getDrive(DocumentsGetDriveRequest request,
                                          java.util.Optional<Options> options)
                                   throws java.lang.Exception

Get Drive

Parameters:

request - The request object containing all the parameters for the API call.

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails