com.xero.api.client

Class AssetApi

java.lang.Object

com.xero.api.client.AssetApi

public class AssetApi
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
AssetApi(ApiClient apiClient)
AssetApi(Config config)
AssetApi(Config config, SignerFactory signerFactory)

Method Summary

Modifier and Type	Method and Description
protected void	addToMapIfNotNull(Map<String,String> map, String key, Object value)
Asset	createAsset(Asset asset) adds a fixed asset Adds an asset to the system
AssetType	createAssetType(AssetType assetType) adds a fixed asset type Adds an fixed asset type to the system
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 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()
Asset	getAssetById(UUID id) retrieves fixed asset by id By passing in the appropriate asset id, you can search for a specific fixed asset in the system
Assets	getAssets(String status, Integer page, Integer pageSize, String orderBy, String sortDirection, String filterBy) searches fixed asset By passing in the appropriate options, you can search for available fixed asset in the system
Setting	getAssetSettings() searches fixed asset settings By passing in the appropriate options, you can search for available fixed asset types in the system
List<AssetType>	getAssetTypes() searches fixed asset types By passing in the appropriate options, you can search for available fixed asset types in the system
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

AssetApi

public AssetApi(Config config)

AssetApi

public AssetApi(Config config,
                SignerFactory signerFactory)

AssetApi

public AssetApi(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

createAsset

public Asset createAsset(Asset asset)
                  throws IOException

adds a fixed asset Adds an asset to the system

200 - return single object - create new asset

400 - invalid input, object invalid

Parameters:

asset - Fixed asset to add

Returns:

Asset

Throws:

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

createAssetType

public AssetType createAssetType(AssetType assetType)
                          throws IOException

adds a fixed asset type Adds an fixed asset type to the system

200 - results single object - created fixed type

400 - invalid input, object invalid

409 - a type already exists

Parameters:

assetType - Asset type to add

Returns:

AssetType

Throws:

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

getAssetById

public Asset getAssetById(UUID id)
                   throws IOException

retrieves fixed asset by id By passing in the appropriate asset id, you can search for a specific fixed asset in the system

200 - search results matching criteria

400 - bad input parameter

Parameters:

id - fixed asset id for single object

Returns:

Asset

Throws:

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

getAssetSettings

public Setting getAssetSettings()
                         throws IOException

searches fixed asset settings By passing in the appropriate options, you can search for available fixed asset types in the system

200 - search results matching criteria

400 - bad input parameter

Returns:

Setting

Throws:

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

getAssetTypes

public List<AssetType> getAssetTypes()
                              throws IOException

searches fixed asset types By passing in the appropriate options, you can search for available fixed asset types in the system

200 - search results matching criteria

400 - bad input parameter

Returns:

List<AssetType>

Throws:

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

getAssets

public Assets getAssets(String status,
                        Integer page,
                        Integer pageSize,
                        String orderBy,
                        String sortDirection,
                        String filterBy)
                 throws IOException

searches fixed asset By passing in the appropriate options, you can search for available fixed asset in the system

200 - search results matching criteria

400 - bad input parameter

Parameters:

status - Required when retrieving a collection of assets. See Asset Status Codes

page - Results are paged. This specifies which page of the results to return. The default page is 1.

pageSize - The number of records returned per page. By default the number of records returned is 10.

orderBy - Requests can be ordered by AssetType, AssetName, AssetNumber, PurchaseDate and PurchasePrice. If the asset status is DISPOSED it also allows DisposalDate and DisposalPrice.

sortDirection - ASC or DESC

filterBy - A string that can be used to filter the list to only return assets containing the text. Checks it against the AssetName, AssetNumber, Description and AssetTypeName fields.

Returns:

Assets

Throws:

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

addToMapIfNotNull

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