com.xero.api.client

Class FilesApi

java.lang.Object

com.xero.api.client.FilesApi

public class FilesApi
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected static Pattern	MESSAGE_PATTERN
protected com.xero.model.ObjectFactory	objFactory
protected static DateFormat	utcFormatter

Constructor Summary

Constructors

Constructor and Description
FilesApi(ApiClient apiClient)
FilesApi(Config config)
FilesApi(Config config, SignerFactory signerFactory)

Method Summary

Modifier and Type	Method and Description
protected void	addToMapIfNotNull(Map<String,String> map, String key, Object value)
Association	createFileAssociation(UUID fileId, Association association) create a new association By passing in the appropriate options, you can create a new folder
Folder	createFolder(Folder folder) create a new folder By passing in the appropriate properties, you can create a new folder
protected String	DATA(String url, String body, Map<String,String> params, String method)
protected String	DATA(String url, String body, Map<String,String> params, String method, org.threeten.bp.OffsetDateTime ifModifiedSince)
protected String	DATA(String url, String body, Map<String,String> params, String method, org.threeten.bp.OffsetDateTime ifModifiedSince, String contentType)
protected String	DATA(String url, String body, Map<String,String> params, String method, String contentType)
protected String	DATA(String url, String body, Map<String,String> params, String method, String xeroApplicationId, String xeroTenantId, String xeroUserId)
FileResponse204	deleteFile(UUID fileId) delete a file Delete a specific file
FileResponse204	deleteFileAssociation(UUID fileId, UUID objectId) create a new association By passing in the appropriate options, you can create a new folder
FileResponse204	deleteFolder(UUID folderId) delete a folder By passing in the appropriate ID, you can delete a folder
protected ByteArrayInputStream	FILE(String url, String body, Map<String,String> params, String method)
protected String	FILE(String url, String body, Map<String,String> params, String method, byte[] byteBody)
protected String	FILE(String url, String body, Map<String,String> params, String method, byte[] byteBody, String contentType)
protected ByteArrayInputStream	FILE(String url, String body, Map<String,String> params, String method, String accept)
ApiClient	getApiClient()
List<Association>	getAssociationsByObject(UUID objectId) searches files By passing in the appropriate options,
FileObject	getFile(UUID fileId) searches for file by unique id
List<Association>	getFileAssociations(UUID fileId) searches files By passing in the appropriate options,
ByteArrayInputStream	getFileContent(UUID fileId) searches files to retrieve the data By passing in the appropriate options, retrieve data for specific file
Files	getFiles(Integer pagesize, Integer page, String sort) searches files
Folder	getFolder(UUID folderId) searches specific folder by id By passing in the appropriate ID, you can search for specific folder
List<Folder>	getFolders(String sort) searches folder By passing in the appropriate options, you can search for available folders
Folder	getInbox() searches inbox folder Search for the user inbox
void	setApiClient(ApiClient apiClient)
void	setOAuthToken(String token, String tokenSecret)
FileObject	updateFile(UUID fileId, FileObject fileObject) Update a file Update properties on a single file
Folder	updateFolder(UUID folderId, Folder folder) update folder By passing in the appropriate ID and properties, you can update a folder
FileObject	uploadFile(UUID folderId, byte[] body, String name, String filename, String mimeType) upload an File

Methods inherited from class java.lang.Object

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

Field Detail

utcFormatter

protected static final DateFormat utcFormatter

MESSAGE_PATTERN

protected static final Pattern MESSAGE_PATTERN

objFactory

protected final com.xero.model.ObjectFactory objFactory

Constructor Detail

FilesApi

public FilesApi(Config config)

FilesApi

public FilesApi(Config config,
                SignerFactory signerFactory)

FilesApi

public FilesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

setOAuthToken

public void setOAuthToken(String token,
                          String tokenSecret)

DATA

protected String DATA(String url,
                      String body,
                      Map<String,String> params,
                      String method)
               throws IOException

Throws:

IOException

DATA

protected String DATA(String url,
                      String body,
                      Map<String,String> params,
                      String method,
                      org.threeten.bp.OffsetDateTime ifModifiedSince)
               throws IOException

Throws:

IOException

DATA

protected String DATA(String url,
                      String body,
                      Map<String,String> params,
                      String method,
                      String contentType)
               throws IOException

Throws:

IOException

DATA

protected String DATA(String url,
                      String body,
                      Map<String,String> params,
                      String method,
                      org.threeten.bp.OffsetDateTime ifModifiedSince,
                      String contentType)
               throws IOException

Throws:

IOException

DATA

protected String DATA(String url,
                      String body,
                      Map<String,String> params,
                      String method,
                      String xeroApplicationId,
                      String xeroTenantId,
                      String xeroUserId)
               throws IOException

Throws:

IOException

FILE

protected ByteArrayInputStream FILE(String url,
                                    String body,
                                    Map<String,String> params,
                                    String method)
                             throws IOException

Throws:

IOException

FILE

protected ByteArrayInputStream FILE(String url,
                                    String body,
                                    Map<String,String> params,
                                    String method,
                                    String accept)
                             throws IOException

Throws:

IOException

FILE

protected String FILE(String url,
                      String body,
                      Map<String,String> params,
                      String method,
                      byte[] byteBody)
               throws IOException

Throws:

IOException

FILE

protected String FILE(String url,
                      String body,
                      Map<String,String> params,
                      String method,
                      byte[] byteBody,
                      String contentType)
               throws IOException

Throws:

IOException

createFileAssociation

public Association createFileAssociation(UUID fileId,
                                         Association association)
                                  throws IOException

create a new association By passing in the appropriate options, you can create a new folder

200 - A successful request

400 - bad input parameter - TODO

Parameters:

fileId - File id for single object

association - The association parameter

Returns:

Association

Throws:

IOException - if an error occurs while attempting to invoke the API

createFolder

public Folder createFolder(Folder folder)
                    throws IOException

create a new folder By passing in the appropriate properties, you can create a new folder

200 - search results matching criteria

400 - bad input parameter - TODO

Parameters:

folder - The folder parameter

Returns:

Folder

Throws:

IOException - if an error occurs while attempting to invoke the API

deleteFile

public FileResponse204 deleteFile(UUID fileId)
                           throws IOException

delete a file Delete a specific file

204 - A successful request returns 204 empty response - populate with status property in SDK

Parameters:

fileId - File id for single object

Returns:

FileResponse204

Throws:

IOException - if an error occurs while attempting to invoke the API

deleteFileAssociation

public FileResponse204 deleteFileAssociation(UUID fileId,
                                             UUID objectId)
                                      throws IOException

create a new association By passing in the appropriate options, you can create a new folder

204 - A successful request

400 - bad input parameter - TODO

Parameters:

fileId - File id for single object

objectId - Object id for single object

Returns:

FileResponse204

Throws:

IOException - if an error occurs while attempting to invoke the API

deleteFolder

public FileResponse204 deleteFolder(UUID folderId)
                             throws IOException

delete a folder By passing in the appropriate ID, you can delete a folder

204 - A successful request

400 - bad input parameter - TODO

Parameters:

folderId - Folder id for single object

Returns:

FileResponse204

Throws:

IOException - if an error occurs while attempting to invoke the API

getAssociationsByObject

public List<Association> getAssociationsByObject(UUID objectId)
                                          throws IOException

searches files By passing in the appropriate options,

200 - search results matching criteria

Parameters:

objectId - Object id for single object

Returns:

List<Association>

Throws:

IOException - if an error occurs while attempting to invoke the API

getFile

public FileObject getFile(UUID fileId)
                   throws IOException

searches for file by unique id

200 - search results matching criteria

Parameters:

fileId - File id for single object

Returns:

FileObject

Throws:

IOException - if an error occurs while attempting to invoke the API

getFileAssociations

public List<Association> getFileAssociations(UUID fileId)
                                      throws IOException

searches files By passing in the appropriate options,

200 - search results matching criteria

Parameters:

fileId - File id for single object

Returns:

List<Association>

Throws:

IOException - if an error occurs while attempting to invoke the API

getFileContent

public ByteArrayInputStream getFileContent(UUID fileId)
                                    throws IOException

searches files to retrieve the data By passing in the appropriate options, retrieve data for specific file

200 - search results matching criteria

Parameters:

fileId - File id for single object

Returns:

File

Throws:

IOException - if an error occurs while attempting to invoke the API

getFiles

public Files getFiles(Integer pagesize,
                      Integer page,
                      String sort)
               throws IOException

searches files

200 - search results matching criteria

400 - bad input parameter - TODO

Parameters:

pagesize - pass an optional page size value

page - number of records to skip for pagination

sort - values to sort by

Returns:

Files

Throws:

IOException - if an error occurs while attempting to invoke the API

getFolder

public Folder getFolder(UUID folderId)
                 throws IOException

searches specific folder by id By passing in the appropriate ID, you can search for specific folder

200 - search results matching criteria

400 - bad input parameter - TODO

Parameters:

folderId - Folder id for single object

Returns:

Folder

Throws:

IOException - if an error occurs while attempting to invoke the API

getFolders

public List<Folder> getFolders(String sort)
                        throws IOException

searches folder By passing in the appropriate options, you can search for available folders

200 - search results matching criteria

400 - bad input parameter - TODO

Parameters:

sort - values to sort by

Returns:

List<Folder>

Throws:

IOException - if an error occurs while attempting to invoke the API

getInbox

public Folder getInbox()
                throws IOException

searches inbox folder Search for the user inbox

200 - search results matching criteria

400 - bad input parameter - TODO

Returns:

Folder

Throws:

IOException - if an error occurs while attempting to invoke the API

updateFile

public FileObject updateFile(UUID fileId,
                             FileObject fileObject)
                      throws IOException

Update a file Update properties on a single file

200 - A successful request

Parameters:

fileId - File id for single object

fileObject - The fileObject parameter

Returns:

FileObject

Throws:

IOException - if an error occurs while attempting to invoke the API

updateFolder

public Folder updateFolder(UUID folderId,
                           Folder folder)
                    throws IOException

update folder By passing in the appropriate ID and properties, you can update a folder

200 - return the updated object

400 - bad input parameter - TODO

Parameters:

folderId - Folder id for single object

folder - The folder parameter

Returns:

Folder

Throws:

IOException - if an error occurs while attempting to invoke the API

uploadFile

public FileObject uploadFile(UUID folderId,
                             byte[] body,
                             String name,
                             String filename,
                             String mimeType)
                      throws IOException

upload an File

200 - A successful request

400 - invalid input, object invalid - TODO

409 - an existing item already exists - TODO

Parameters:

folderId - pass an optional folder id to save file to specific folder

body - The body parameter

name - The name parameter

filename - The filename parameter

mimeType - The mimeType parameter

Returns:

FileObject

Throws:

IOException - if an error occurs while attempting to invoke the API

addToMapIfNotNull

protected void addToMapIfNotNull(Map<String,String> map,
                                 String key,
                                 Object value)