com.xero.api.client

Class BankFeedsApi

java.lang.Object

com.xero.api.client.BankFeedsApi

public class BankFeedsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
BankFeedsApi()
BankFeedsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ByteArrayInputStream	convertInputToByteArray(InputStream is)
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
com.google.api.client.http.HttpResponse	createFeedConnectionsForHttpResponse(FeedConnections feedConnections)
Statements	createStatements(Statements statements) 202 - Success
com.google.api.client.http.HttpResponse	createStatementsForHttpResponse(Statements statements)
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
com.google.api.client.http.HttpResponse	deleteFeedConnectionsForHttpResponse(FeedConnections feedConnections)
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
com.google.api.client.http.HttpResponse	getFeedConnectionForHttpResponse(String id)
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
com.google.api.client.http.HttpResponse	getFeedConnectionsForHttpResponse(Integer page, Integer pageSize)
Statement	getStatement(String statementId) 200 - search results matching id for single statement
com.google.api.client.http.HttpResponse	getStatementForHttpResponse(String statementId)
Statements	getStatements(Integer page, Integer pageSize, String xeroApplicationId, String xeroTenantId, String xeroUserId) 200 - search results matching criteria
com.google.api.client.http.HttpResponse	getStatementsForHttpResponse(Integer page, Integer pageSize, String xeroApplicationId, String xeroTenantId, String xeroUserId)
String	getUserAgent()
String	getXeroTenantId()
void	setApiClient(ApiClient apiClient)
void	setUserAgent(String userAgent)
void	setXeroTenantId(String xeroTenantId)

Methods inherited from class java.lang.Object

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

Constructor Detail

BankFeedsApi

public BankFeedsApi()

BankFeedsApi

public BankFeedsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getXeroTenantId

public String getXeroTenantId()

setXeroTenantId

public void setXeroTenantId(String xeroTenantId)

setUserAgent

public void setUserAgent(String userAgent)

getUserAgent

public String getUserAgent()

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

createFeedConnectionsForHttpResponse

public com.google.api.client.http.HttpResponse createFeedConnectionsForHttpResponse(FeedConnections feedConnections)
                                                                             throws IOException

Throws:

IOException

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

createStatementsForHttpResponse

public com.google.api.client.http.HttpResponse createStatementsForHttpResponse(Statements statements)
                                                                        throws IOException

Throws:

IOException

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

deleteFeedConnectionsForHttpResponse

public com.google.api.client.http.HttpResponse deleteFeedConnectionsForHttpResponse(FeedConnections feedConnections)
                                                                             throws IOException

Throws:

IOException

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

getFeedConnectionForHttpResponse

public com.google.api.client.http.HttpResponse getFeedConnectionForHttpResponse(String id)
                                                                         throws IOException

Throws:

IOException

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

getFeedConnectionsForHttpResponse

public com.google.api.client.http.HttpResponse getFeedConnectionsForHttpResponse(Integer page,
                                                                                 Integer pageSize)
                                                                          throws IOException

Throws:

IOException

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

getStatementForHttpResponse

public com.google.api.client.http.HttpResponse getStatementForHttpResponse(String statementId)
                                                                    throws IOException

Throws:

IOException

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

getStatementsForHttpResponse

public com.google.api.client.http.HttpResponse getStatementsForHttpResponse(Integer page,
                                                                            Integer pageSize,
                                                                            String xeroApplicationId,
                                                                            String xeroTenantId,
                                                                            String xeroUserId)
                                                                     throws IOException

Throws:

IOException

convertInputToByteArray

public ByteArrayInputStream convertInputToByteArray(InputStream is)
                                             throws IOException

Throws:

IOException