com.xero.api.client

Class BankFeedsApi

java.lang.Object

com.xero.api.client.BankFeedsApi

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

Method Summary

Modifier and Type	Method and Description
protected void	addToMapIfNotNull(Map<String,String> map, String key, Object value)
FeedConnections	createFeedConnections(FeedConnections feedConnections) create one or more new feed connection By passing in the appropriate body, you can create one or more new feed connections in the system
Statements	createStatements(Statements statements) 202 - Success
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)
FeedConnections	deleteFeedConnections(FeedConnections feedConnections) delete an exsiting feed connection By passing in the appropriate body, you can create a new feed connections in the system
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()
FeedConnection	getFeedConnection(String id) get single feed connection by id By passing in a FeedConnection Id options, you can search for available feed connections in the system
FeedConnections	getFeedConnections(Integer page, Integer pageSize) searches feed connections By passing in the appropriate options, you can search for available feed connections in the system
Statement	getStatement(String statementId) 200 - search results matching id for single statement
Statements	getStatements(Integer page, Integer pageSize, String xeroApplicationId, String xeroTenantId, String xeroUserId) 200 - search results matching criteria
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

BankFeedsApi

public BankFeedsApi(Config config)

BankFeedsApi

public BankFeedsApi(Config config,
                    SignerFactory signerFactory)

BankFeedsApi

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

createFeedConnections

public FeedConnections createFeedConnections(FeedConnections feedConnections)
                                      throws IOException

create one or more new feed connection By passing in the appropriate body, you can create one or more new feed connections in the system

201 - feed connection created

400 - invalid input, object invalid

Parameters:

feedConnections - Feed Connection(s) to add

Returns:

FeedConnections

Throws:

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

createStatements

public Statements createStatements(Statements statements)
                            throws IOException

202 - Success

400 - Statement failed validation

403 - Invalid application or feed connection

409 - Duplicate statement received

413 - Statement exceeds size limit

422 - Unprocessable Entity

500 - Intermittent Xero Error

Parameters:

statements - Feed Connection(s) to add

Returns:

Statements

Throws:

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

deleteFeedConnections

public FeedConnections deleteFeedConnections(FeedConnections feedConnections)
                                      throws IOException

delete an exsiting feed connection By passing in the appropriate body, you can create a new feed connections in the system

202 - create results matching body content

400 - bad input parameter

Parameters:

feedConnections - Feed Connections to delete

Returns:

FeedConnections

Throws:

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

getFeedConnection

public FeedConnection getFeedConnection(String id)
                                 throws IOException

get single feed connection by id By passing in a FeedConnection Id options, you can search for available feed connections in the system

200 - search results matching criteria

400 - bad input parameter

Parameters:

id - feed connection id for single object

Returns:

FeedConnection

Throws:

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

getFeedConnections

public FeedConnections getFeedConnections(Integer page,
                                          Integer pageSize)
                                   throws IOException

searches feed connections By passing in the appropriate options, you can search for available feed connections in the system

201 - search results matching criteria

400 - bad input parameter

Parameters:

page - Page number which specifies the set of records to retrieve. By default the number of the records per set is 10. Example - https://api.xero.com/bankfeeds.xro/1.0/FeedConnections?page=1 to get the second set of the records. When page value is not a number or a negative number, by default, the first set of records is returned.

pageSize - Page size which specifies how many records per page will be returned (default 10). Example - https://api.xero.com/bankfeeds.xro/1.0/FeedConnections?pageSize=100 to specify page size of 100.

Returns:

FeedConnections

Throws:

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

getStatement

public Statement getStatement(String statementId)
                       throws IOException

200 - search results matching id for single statement

404 - Statement not found

Parameters:

statementId - The statementId parameter

Returns:

Statement

Throws:

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

getStatements

public Statements getStatements(Integer page,
                                Integer pageSize,
                                String xeroApplicationId,
                                String xeroTenantId,
                                String xeroUserId)
                         throws IOException

200 - search results matching criteria

400 - bad input parameter

Parameters:

page - The page parameter

pageSize - The pageSize parameter

xeroApplicationId - The xeroApplicationId parameter

xeroTenantId - The xeroTenantId parameter

xeroUserId - The xeroUserId parameter

Returns:

Statements

Throws:

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

addToMapIfNotNull

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