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)
Files	createFile(File body) upload an File Adds an File to the Xero
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)
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 ByteArrayInputStream	FILE(String url, String body, Map<String,String> params, String method, String accept)
ApiClient	getApiClient()
ByteArrayInputStream	getFileContent(UUID fileId) searches files By passing in the appropriate options,
Files	getFiles(Integer pagesize, Integer page, String sort) searches files By passing in the appropriate options, you can search for available inventory in the system
List<Folder>	getFolders(String sort) searches folder By passing in the appropriate options, you can search for available folders
void	setApiClient(ApiClient apiClient)
void	setOAuthToken(String token, String tokenSecret)

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

createFile

public Files createFile(File body)
                 throws IOException

upload an File Adds an File to the Xero

200 - A successful request

400 - invalid input, object invalid

409 - an existing item already exists

Parameters:

body - File to add

Returns:

Files

Throws:

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

getFileContent

public ByteArrayInputStream getFileContent(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:

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 By passing in the appropriate options, you can search for available inventory in the system

200 - search results matching criteria

400 - bad input parameter

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

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

Parameters:

sort - values to sort by

Returns:

List<Folder>

Throws:

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

addToMapIfNotNull

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