Package com.xero.api.client

Class FilesApi

java.lang.Object

com.xero.api.client.FilesApi

public class FilesApi
extends Object

FilesApi has methods for interacting with all endpoints in the API set

Constructor Summary

Constructors

Constructor	Description
FilesApi()	FilesApi
FilesApi(ApiClient apiClient)	FilesApi

Method Summary

Modifier and Type	Method	Description
ByteArrayInputStream	convertInputToByteArray(InputStream is)	convert intput to byte array
Association	createFileAssociation(String accessToken, String xeroTenantId, UUID fileId, Association association, String idempotencyKey)	Creates a new file association By passing in the appropriate options, you can create a new folder
com.google.api.client.http.HttpResponse	createFileAssociationForHttpResponse(String accessToken, String xeroTenantId, UUID fileId, Association association, String idempotencyKey)	Creates a new file association By passing in the appropriate options, you can create a new folder
Folder	createFolder(String accessToken, String xeroTenantId, Folder folder, String idempotencyKey)	Creates a new folder By passing in the appropriate properties, you can create a new folder
com.google.api.client.http.HttpResponse	createFolderForHttpResponse(String accessToken, String xeroTenantId, Folder folder, String idempotencyKey)	Creates a new folder By passing in the appropriate properties, you can create a new folder
void	deleteFile(String accessToken, String xeroTenantId, UUID fileId)	Deletes a specific file Delete a specific file
void	deleteFileAssociation(String accessToken, String xeroTenantId, UUID fileId, UUID objectId)	Deletes an existing file association By passing in the appropriate options, you can create a new folder
com.google.api.client.http.HttpResponse	deleteFileAssociationForHttpResponse(String accessToken, String xeroTenantId, UUID fileId, UUID objectId)	Deletes an existing file association By passing in the appropriate options, you can create a new folder
com.google.api.client.http.HttpResponse	deleteFileForHttpResponse(String accessToken, String xeroTenantId, UUID fileId)	Deletes a specific file Delete a specific file
void	deleteFolder(String accessToken, String xeroTenantId, UUID folderId)	Deletes a folder By passing in the appropriate ID, you can delete a folder
com.google.api.client.http.HttpResponse	deleteFolderForHttpResponse(String accessToken, String xeroTenantId, UUID folderId)	Deletes a folder By passing in the appropriate ID, you can delete a folder
ApiClient	getApiClient()	get ApiClient
List<Association>	getAssociationsByObject(String accessToken, String xeroTenantId, UUID objectId, Integer pagesize, Integer page, String sort, String direction)	Retrieves an association object using a unique object ID By passing in the appropriate options, you can retrieve an association
com.google.api.client.http.HttpResponse	getAssociationsByObjectForHttpResponse(String accessToken, String xeroTenantId, UUID objectId, Integer pagesize, Integer page, String sort, String direction)	Retrieves an association object using a unique object ID By passing in the appropriate options, you can retrieve an association
Object	getAssociationsCount(String accessToken, String xeroTenantId, List<UUID> objectIds)	Retrieves a count of associations for a list of objects.
com.google.api.client.http.HttpResponse	getAssociationsCountForHttpResponse(String accessToken, String xeroTenantId, List<UUID> objectIds)	Retrieves a count of associations for a list of objects.
FileObject	getFile(String accessToken, String xeroTenantId, UUID fileId)	Retrieves a file by a unique file ID
List<Association>	getFileAssociations(String accessToken, String xeroTenantId, UUID fileId)	Retrieves a specific file associations By passing in the appropriate options,
com.google.api.client.http.HttpResponse	getFileAssociationsForHttpResponse(String accessToken, String xeroTenantId, UUID fileId)	Retrieves a specific file associations By passing in the appropriate options,
ByteArrayInputStream	getFileContent(String accessToken, String xeroTenantId, UUID fileId)	Retrieves the content of a specific file By passing in the appropriate options, retrieve data for specific file
com.google.api.client.http.HttpResponse	getFileContentForHttpResponse(String accessToken, String xeroTenantId, UUID fileId)	Retrieves the content of a specific file By passing in the appropriate options, retrieve data for specific file
com.google.api.client.http.HttpResponse	getFileForHttpResponse(String accessToken, String xeroTenantId, UUID fileId)	Retrieves a file by a unique file ID
Files	getFiles(String accessToken, String xeroTenantId, Integer pagesize, Integer page, String sort)	Retrieves files
com.google.api.client.http.HttpResponse	getFilesForHttpResponse(String accessToken, String xeroTenantId, Integer pagesize, Integer page, String sort)	Retrieves files
Folder	getFolder(String accessToken, String xeroTenantId, UUID folderId)	Retrieves specific folder by using a unique folder ID By passing in the appropriate ID, you can search for specific folder
com.google.api.client.http.HttpResponse	getFolderForHttpResponse(String accessToken, String xeroTenantId, UUID folderId)	Retrieves specific folder by using a unique folder ID By passing in the appropriate ID, you can search for specific folder
List<Folder>	getFolders(String accessToken, String xeroTenantId, String sort)	Retrieves folders By passing in the appropriate options, you can search for available folders
com.google.api.client.http.HttpResponse	getFoldersForHttpResponse(String accessToken, String xeroTenantId, String sort)	Retrieves folders By passing in the appropriate options, you can search for available folders
Folder	getInbox(String accessToken, String xeroTenantId)	Retrieves inbox folder Search for the user inbox
com.google.api.client.http.HttpResponse	getInboxForHttpResponse(String accessToken, String xeroTenantId)	Retrieves inbox folder Search for the user inbox
static FilesApi	getInstance(ApiClient apiClient)	FilesApi getInstance
String	getUserAgent()	get user agent
void	setApiClient(ApiClient apiClient)	set ApiClient
void	setUserAgent(String userAgent)	set user agent
FileObject	updateFile(String accessToken, String xeroTenantId, UUID fileId, FileObject fileObject, String idempotencyKey)	Update a file Updates file properties of a single file
com.google.api.client.http.HttpResponse	updateFileForHttpResponse(String accessToken, String xeroTenantId, UUID fileId, FileObject fileObject, String idempotencyKey)	Update a file Updates file properties of a single file
Folder	updateFolder(String accessToken, String xeroTenantId, UUID folderId, Folder folder, String idempotencyKey)	Updates an existing folder By passing in the appropriate ID and properties, you can update a folder
com.google.api.client.http.HttpResponse	updateFolderForHttpResponse(String accessToken, String xeroTenantId, UUID folderId, Folder folder, String idempotencyKey)	Updates an existing folder By passing in the appropriate ID and properties, you can update a folder
FileObject	uploadFile(String accessToken, String xeroTenantId, File body, String name, String filename, String idempotencyKey, String mimeType)	Uploads a File to the inbox
com.google.api.client.http.HttpResponse	uploadFileForHttpResponse(String accessToken, String xeroTenantId, File body, String name, String filename, String idempotencyKey, String mimeType)	Uploads a File to the inbox
FileObject	uploadFileToFolder(String accessToken, String xeroTenantId, UUID folderId, File body, String name, String filename, String idempotencyKey, String mimeType)	Uploads a File to a specific folder
com.google.api.client.http.HttpResponse	uploadFileToFolderForHttpResponse(String accessToken, String xeroTenantId, UUID folderId, File body, String name, String filename, String idempotencyKey, String mimeType)	Uploads a File to a specific folder

Methods inherited from class java.lang.Object

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

Constructor Details

FilesApi

public FilesApi()

FilesApi

FilesApi

public FilesApi(ApiClient apiClient)

FilesApi

Parameters:

apiClient - ApiClient pass into the new instance of this class

Method Details

getInstance

public static FilesApi getInstance(ApiClient apiClient)

FilesApi getInstance

Parameters:

apiClient - ApiClient pass into the new instance of this class

Returns:

instance of this class

getApiClient

public ApiClient getApiClient()

get ApiClient

Returns:

apiClient the current ApiClient

setApiClient

public void setApiClient(ApiClient apiClient)

set ApiClient

Parameters:

apiClient - ApiClient pass into the new instance of this class

setUserAgent

public void setUserAgent(String userAgent)

set user agent

Parameters:

userAgent - string to override the user agent

getUserAgent

public String getUserAgent()

get user agent

Returns:

String of user agent

createFileAssociation

public Association createFileAssociation(String accessToken,
 String xeroTenantId,
 UUID fileId,
 Association association,
 String idempotencyKey)
                                  throws IOException

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

201 - A successful request

400 - invalid input, object invalid

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

fileId - File id for single object

association - The association parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Association

Throws:

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

createFileAssociationForHttpResponse

public com.google.api.client.http.HttpResponse createFileAssociationForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID fileId,
 Association association,
 String idempotencyKey)
                                                                             throws IOException

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

201 - A successful request

400 - invalid input, object invalid

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

fileId - File id for single object

association - The association parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

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

createFolder

public Folder createFolder(String accessToken,
 String xeroTenantId,
 Folder folder,
 String idempotencyKey)
                    throws IOException

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

200 - search results matching criteria

400 - invalid input, object invalid

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

folder - The folder parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Folder

Throws:

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

createFolderForHttpResponse

public com.google.api.client.http.HttpResponse createFolderForHttpResponse(String accessToken,
 String xeroTenantId,
 Folder folder,
 String idempotencyKey)
                                                                    throws IOException

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

200 - search results matching criteria

400 - invalid input, object invalid

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

folder - The folder parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

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

deleteFile

public void deleteFile(String accessToken,
 String xeroTenantId,
 UUID fileId)
                throws IOException

Deletes a specific file Delete a specific file

204 - Successful deletion - return response 204 no content

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

fileId - File id for single object

Throws:

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

deleteFileForHttpResponse

public com.google.api.client.http.HttpResponse deleteFileForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID fileId)
                                                                  throws IOException

Deletes a specific file Delete a specific file

204 - Successful deletion - return response 204 no content

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

fileId - File id for single object

Returns:

HttpResponse

Throws:

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

deleteFileAssociation

public void deleteFileAssociation(String accessToken,
 String xeroTenantId,
 UUID fileId,
 UUID objectId)
                           throws IOException

Deletes an existing file association By passing in the appropriate options, you can create a new folder

204 - Successful deletion - return response 204 no content

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

fileId - File id for single object

objectId - Object id for single object

Throws:

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

deleteFileAssociationForHttpResponse

public com.google.api.client.http.HttpResponse deleteFileAssociationForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID fileId,
 UUID objectId)
                                                                             throws IOException

Deletes an existing file association By passing in the appropriate options, you can create a new folder

204 - Successful deletion - return response 204 no content

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

fileId - File id for single object

objectId - Object id for single object

Returns:

HttpResponse

Throws:

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

deleteFolder

public void deleteFolder(String accessToken,
 String xeroTenantId,
 UUID folderId)
                  throws IOException

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

204 - Successful deletion - return response 204 no content

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

folderId - Folder id for single object

Throws:

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

deleteFolderForHttpResponse

public com.google.api.client.http.HttpResponse deleteFolderForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID folderId)
                                                                    throws IOException

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

204 - Successful deletion - return response 204 no content

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

folderId - Folder id for single object

Returns:

HttpResponse

Throws:

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

getAssociationsByObject

public List<Association> getAssociationsByObject(String accessToken,
 String xeroTenantId,
 UUID objectId,
 Integer pagesize,
 Integer page,
 String sort,
 String direction)
                                          throws IOException

Retrieves an association object using a unique object ID By passing in the appropriate options, you can retrieve an association

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

objectId - Object id for single object

pagesize - pass an optional page size value

page - number of records to skip for pagination

sort - values to sort by

direction - direction to sort by

Returns:

List<Association>

Throws:

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

getAssociationsByObjectForHttpResponse

public com.google.api.client.http.HttpResponse getAssociationsByObjectForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID objectId,
 Integer pagesize,
 Integer page,
 String sort,
 String direction)
                                                                               throws IOException

Retrieves an association object using a unique object ID By passing in the appropriate options, you can retrieve an association

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

objectId - Object id for single object

pagesize - pass an optional page size value

page - number of records to skip for pagination

sort - values to sort by

direction - direction to sort by

Returns:

HttpResponse

Throws:

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

getAssociationsCount

public Object getAssociationsCount(String accessToken,
 String xeroTenantId,
 List<UUID> objectIds)
                            throws IOException

Retrieves a count of associations for a list of objects. By passing in the appropriate options, you can retrieve the association count for objects

200 - A dictionary of the object Ids and associations count

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

objectIds - A comma-separated list of object ids

Returns:

Object

Throws:

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

getAssociationsCountForHttpResponse

public com.google.api.client.http.HttpResponse getAssociationsCountForHttpResponse(String accessToken,
 String xeroTenantId,
 List<UUID> objectIds)
                                                                            throws IOException

Retrieves a count of associations for a list of objects. By passing in the appropriate options, you can retrieve the association count for objects

200 - A dictionary of the object Ids and associations count

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

objectIds - A comma-separated list of object ids

Returns:

HttpResponse

Throws:

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

getFile

public FileObject getFile(String accessToken,
 String xeroTenantId,
 UUID fileId)
                   throws IOException

Retrieves a file by a unique file ID

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

fileId - File id for single object

Returns:

FileObject

Throws:

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

getFileForHttpResponse

public com.google.api.client.http.HttpResponse getFileForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID fileId)
                                                               throws IOException

Retrieves a file by a unique file ID

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

fileId - File id for single object

Returns:

HttpResponse

Throws:

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

getFileAssociations

public List<Association> getFileAssociations(String accessToken,
 String xeroTenantId,
 UUID fileId)
                                      throws IOException

Retrieves a specific file associations By passing in the appropriate options,

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

fileId - File id for single object

Returns:

List<Association>

Throws:

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

getFileAssociationsForHttpResponse

public com.google.api.client.http.HttpResponse getFileAssociationsForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID fileId)
                                                                           throws IOException

Retrieves a specific file associations By passing in the appropriate options,

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

fileId - File id for single object

Returns:

HttpResponse

Throws:

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

getFileContent

public ByteArrayInputStream getFileContent(String accessToken,
 String xeroTenantId,
 UUID fileId)
                                    throws IOException

Retrieves the content of a specific file By passing in the appropriate options, retrieve data for specific file

200 - returns the byte array of the specific file based on id

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

fileId - File id for single object

Returns:

ByteArrayInputStream

Throws:

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

getFileContentForHttpResponse

public com.google.api.client.http.HttpResponse getFileContentForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID fileId)
                                                                      throws IOException

Retrieves the content of a specific file By passing in the appropriate options, retrieve data for specific file

200 - returns the byte array of the specific file based on id

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

fileId - File id for single object

Returns:

HttpResponse

Throws:

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

getFiles

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

Retrieves files

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

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 *

getFilesForHttpResponse

public com.google.api.client.http.HttpResponse getFilesForHttpResponse(String accessToken,
 String xeroTenantId,
 Integer pagesize,
 Integer page,
 String sort)
                                                                throws IOException

Retrieves files

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

pagesize - pass an optional page size value

page - number of records to skip for pagination

sort - values to sort by

Returns:

HttpResponse

Throws:

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

getFolder

public Folder getFolder(String accessToken,
 String xeroTenantId,
 UUID folderId)
                 throws IOException

Retrieves specific folder by using a unique folder ID By passing in the appropriate ID, you can search for specific folder

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

folderId - Folder id for single object

Returns:

Folder

Throws:

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

getFolderForHttpResponse

public com.google.api.client.http.HttpResponse getFolderForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID folderId)
                                                                 throws IOException

Retrieves specific folder by using a unique folder ID By passing in the appropriate ID, you can search for specific folder

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

folderId - Folder id for single object

Returns:

HttpResponse

Throws:

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

getFolders

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

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

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

sort - values to sort by

Returns:

List<Folder>

Throws:

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

getFoldersForHttpResponse

public com.google.api.client.http.HttpResponse getFoldersForHttpResponse(String accessToken,
 String xeroTenantId,
 String sort)
                                                                  throws IOException

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

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

sort - values to sort by

Returns:

HttpResponse

Throws:

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

getInbox

public Folder getInbox(String accessToken,
 String xeroTenantId)
                throws IOException

Retrieves inbox folder Search for the user inbox

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

Returns:

Folder

Throws:

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

getInboxForHttpResponse

public com.google.api.client.http.HttpResponse getInboxForHttpResponse(String accessToken,
 String xeroTenantId)
                                                                throws IOException

Retrieves inbox folder Search for the user inbox

200 - search results matching criteria

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

Returns:

HttpResponse

Throws:

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

updateFile

public FileObject updateFile(String accessToken,
 String xeroTenantId,
 UUID fileId,
 FileObject fileObject,
 String idempotencyKey)
                      throws IOException

Update a file Updates file properties of a single file

200 - A successful request

400 - invalid input, object invalid

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

fileId - File id for single object

fileObject - The fileObject parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

FileObject

Throws:

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

updateFileForHttpResponse

public com.google.api.client.http.HttpResponse updateFileForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID fileId,
 FileObject fileObject,
 String idempotencyKey)
                                                                  throws IOException

Update a file Updates file properties of a single file

200 - A successful request

400 - invalid input, object invalid

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

fileId - File id for single object

fileObject - The fileObject parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

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

updateFolder

public Folder updateFolder(String accessToken,
 String xeroTenantId,
 UUID folderId,
 Folder folder,
 String idempotencyKey)
                    throws IOException

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

200 - return the updated object

400 - invalid input, object invalid

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

folderId - Folder id for single object

folder - The folder parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

Folder

Throws:

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

updateFolderForHttpResponse

public com.google.api.client.http.HttpResponse updateFolderForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID folderId,
 Folder folder,
 String idempotencyKey)
                                                                    throws IOException

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

200 - return the updated object

400 - invalid input, object invalid

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

folderId - Folder id for single object

folder - The folder parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Returns:

HttpResponse

Throws:

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

uploadFile

public FileObject uploadFile(String accessToken,
 String xeroTenantId,
 File body,
 String name,
 String filename,
 String idempotencyKey,
 String mimeType)
                      throws IOException

Uploads a File to the inbox

201 - A successful request

400 - invalid input, object invalid

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

body - The body parameter

name - exact name of the file you are uploading

filename - The filename parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The mimeType parameter

Returns:

FileObject

Throws:

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

uploadFileForHttpResponse

public com.google.api.client.http.HttpResponse uploadFileForHttpResponse(String accessToken,
 String xeroTenantId,
 File body,
 String name,
 String filename,
 String idempotencyKey,
 String mimeType)
                                                                  throws IOException

Uploads a File to the inbox

201 - A successful request

400 - invalid input, object invalid

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

body - The body parameter

name - exact name of the file you are uploading

filename - The filename parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The mimeType parameter

Returns:

HttpResponse

Throws:

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

uploadFileToFolder

public FileObject uploadFileToFolder(String accessToken,
 String xeroTenantId,
 UUID folderId,
 File body,
 String name,
 String filename,
 String idempotencyKey,
 String mimeType)
                              throws IOException

Uploads a File to a specific folder

201 - A successful request

400 - invalid input, object invalid

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

folderId - pass required folder id to save file to specific folder

body - The body parameter

name - exact name of the file you are uploading

filename - The filename parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The mimeType parameter

Returns:

FileObject

Throws:

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

uploadFileToFolderForHttpResponse

public com.google.api.client.http.HttpResponse uploadFileToFolderForHttpResponse(String accessToken,
 String xeroTenantId,
 UUID folderId,
 File body,
 String name,
 String filename,
 String idempotencyKey,
 String mimeType)
                                                                          throws IOException

Uploads a File to a specific folder

201 - A successful request

400 - invalid input, object invalid

Parameters:

accessToken - Authorization token for user set in header of each request

xeroTenantId - Xero identifier for Tenant

folderId - pass required folder id to save file to specific folder

body - The body parameter

name - exact name of the file you are uploading

filename - The filename parameter

idempotencyKey - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

mimeType - The mimeType parameter

Returns:

HttpResponse

Throws:

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

convertInputToByteArray

public ByteArrayInputStream convertInputToByteArray(InputStream is)
                                             throws IOException

convert intput to byte array

Parameters:

is - InputStream the server status code returned

Returns:

byteArrayInputStream a ByteArrayInputStream

Throws:

IOException - for failed or interrupted I/O operations