io.swagger.client.api

Class MocksAndTestsApi

java.lang.Object

io.swagger.client.api.MocksAndTestsApi

public class MocksAndTestsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
MocksAndTestsApi()
MocksAndTestsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
CategorizationCheckResults	checkCategorization(TransactionsData body) Check categorization This service can be used to check the categorization for a given set of transactions, without the need of having the transactions actually imported in finAPI.
com.squareup.okhttp.Call	checkCategorizationAsync(TransactionsData body, ApiCallback<CategorizationCheckResults> callback) Check categorization (asynchronously) This service can be used to check the categorization for a given set of transactions, without the need of having the transactions actually imported in finAPI.
com.squareup.okhttp.Call	checkCategorizationCall(TransactionsData body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for checkCategorization
ApiResponse<CategorizationCheckResults>	checkCategorizationWithHttpInfo(TransactionsData body) Check categorization This service can be used to check the categorization for a given set of transactions, without the need of having the transactions actually imported in finAPI.
ApiClient	getApiClient()
void	mockBatchUpdate(MockBatchUpdateParams body) Mock batch update This service can be used to mock an update of one or several bank connections by letting you simulate finAPI's communication with a bank server.
com.squareup.okhttp.Call	mockBatchUpdateAsync(MockBatchUpdateParams body, ApiCallback<Void> callback) Mock batch update (asynchronously) This service can be used to mock an update of one or several bank connections by letting you simulate finAPI's communication with a bank server.
com.squareup.okhttp.Call	mockBatchUpdateCall(MockBatchUpdateParams body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for mockBatchUpdate
ApiResponse<Void>	mockBatchUpdateWithHttpInfo(MockBatchUpdateParams body) Mock batch update This service can be used to mock an update of one or several bank connections by letting you simulate finAPI's communication with a bank server.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

MocksAndTestsApi

public MocksAndTestsApi()

MocksAndTestsApi

public MocksAndTestsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

checkCategorizationCall

public com.squareup.okhttp.Call checkCategorizationCall(TransactionsData body,
                                                        ProgressResponseBody.ProgressListener progressListener,
                                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                 throws ApiException

Build call for checkCategorization

Parameters:

body - Transactions data (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

checkCategorization

public CategorizationCheckResults checkCategorization(TransactionsData body)
                                               throws ApiException

Check categorization This service can be used to check the categorization for a given set of transactions, without the need of having the transactions actually imported in finAPI. The result of the categorization is the same as if the transactions were actually imported (the service regards the user-specific categorization rules of the user that is authorized by the access_token). Must pass the user's access_token.

Parameters:

body - Transactions data (required)

Returns:

CategorizationCheckResults

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

checkCategorizationWithHttpInfo

public ApiResponse<CategorizationCheckResults> checkCategorizationWithHttpInfo(TransactionsData body)
                                                                        throws ApiException

Check categorization This service can be used to check the categorization for a given set of transactions, without the need of having the transactions actually imported in finAPI. The result of the categorization is the same as if the transactions were actually imported (the service regards the user-specific categorization rules of the user that is authorized by the access_token). Must pass the user's access_token.

Parameters:

body - Transactions data (required)

Returns:

ApiResponse<CategorizationCheckResults>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

checkCategorizationAsync

public com.squareup.okhttp.Call checkCategorizationAsync(TransactionsData body,
                                                         ApiCallback<CategorizationCheckResults> callback)
                                                  throws ApiException

Check categorization (asynchronously) This service can be used to check the categorization for a given set of transactions, without the need of having the transactions actually imported in finAPI. The result of the categorization is the same as if the transactions were actually imported (the service regards the user-specific categorization rules of the user that is authorized by the access_token). Must pass the user's access_token.

Parameters:

body - Transactions data (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

mockBatchUpdateCall

public com.squareup.okhttp.Call mockBatchUpdateCall(MockBatchUpdateParams body,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException

Build call for mockBatchUpdate

Parameters:

body - Data for mock bank connection updates (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

mockBatchUpdate

public void mockBatchUpdate(MockBatchUpdateParams body)
                     throws ApiException

Mock batch update This service can be used to mock an update of one or several bank connections by letting you simulate finAPI's communication with a bank server. More specifically, you can provide custom balances and transactions for existing accounts and finAPI will import that data into the accounts as if the data had been delivered by a real bank server during a real update. The idea of this service is to allow you to create accounts with specific data in them so that you can test your application in different scenarios.<br/><br/>You can also test your application's reception and processing of push notifications with this service, by enabling the 'triggerNotifications' flag in your request. When this flag is enabled, finAPI will send notifications to your application based on the notification rules that are set up for the user and on the data you provided in the request, the same way as it works with finAPI's real automatic batch update process.<br/><br/>Note that this service behaves mostly like calling the bank connection update service, meaning that it returns immediately after having asynchronously started the update process, and also meaning that you have to check the status of the updated bank connections and accounts to find out when the update has finished and what the result is. As you can update several bank connections at once, this service is closer to how finAPI's automatic batch updates work as it is to the manual update service though. Because of this, the result of the mocked bank connection updates will be stored in the 'lastAutoUpdate' field of the bank connections and not in the 'lastManualUpdate' field. Also, just like with the real batch update, any bank connection that you use with this service must have a PIN stored (even though it is not actually forwarded to any bank server).<br/><br/>Also note that this service may be called only when the user's automatic bank connection updates are disabled, to make sure that the mock updates cannot intervene with a real update (please see the User field 'isAutoUpdateEnabled'). Also, it is not possible to use the demo bank connection in this service, so you need to have at least one real online bank connection. At last, it is currently not possible to mock data for security accounts with this service, as you can only pass transactions, but not security positions.<br/><br/>Please be aware that you will 'mess up' the accounts when using this service, meaning that when you perform a real update of accounts that you have previously updated with this service, finAPI might detect inconsistencies in the data that exists in its database and the data that is reported by the bank server, and try to fix this with the insertion of an adjusting entry ('Zwischensaldo' transaction). Also, new real transactions might not get imported as finAPI could match them to mocked transactions. <b>THIS SERVICE IS MEANT FOR TESTING PURPOSES DURING DEVELOPMENT OF YOUR APPLICATION ONLY!</b> This is why it will work only on the sandbox or alpha environments. Calling it on the live environment will result in <b>403 Forbidden</b>.

Parameters:

body - Data for mock bank connection updates (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

mockBatchUpdateWithHttpInfo

public ApiResponse<Void> mockBatchUpdateWithHttpInfo(MockBatchUpdateParams body)
                                              throws ApiException

Mock batch update This service can be used to mock an update of one or several bank connections by letting you simulate finAPI's communication with a bank server. More specifically, you can provide custom balances and transactions for existing accounts and finAPI will import that data into the accounts as if the data had been delivered by a real bank server during a real update. The idea of this service is to allow you to create accounts with specific data in them so that you can test your application in different scenarios.<br/><br/>You can also test your application's reception and processing of push notifications with this service, by enabling the 'triggerNotifications' flag in your request. When this flag is enabled, finAPI will send notifications to your application based on the notification rules that are set up for the user and on the data you provided in the request, the same way as it works with finAPI's real automatic batch update process.<br/><br/>Note that this service behaves mostly like calling the bank connection update service, meaning that it returns immediately after having asynchronously started the update process, and also meaning that you have to check the status of the updated bank connections and accounts to find out when the update has finished and what the result is. As you can update several bank connections at once, this service is closer to how finAPI's automatic batch updates work as it is to the manual update service though. Because of this, the result of the mocked bank connection updates will be stored in the 'lastAutoUpdate' field of the bank connections and not in the 'lastManualUpdate' field. Also, just like with the real batch update, any bank connection that you use with this service must have a PIN stored (even though it is not actually forwarded to any bank server).<br/><br/>Also note that this service may be called only when the user's automatic bank connection updates are disabled, to make sure that the mock updates cannot intervene with a real update (please see the User field 'isAutoUpdateEnabled'). Also, it is not possible to use the demo bank connection in this service, so you need to have at least one real online bank connection. At last, it is currently not possible to mock data for security accounts with this service, as you can only pass transactions, but not security positions.<br/><br/>Please be aware that you will 'mess up' the accounts when using this service, meaning that when you perform a real update of accounts that you have previously updated with this service, finAPI might detect inconsistencies in the data that exists in its database and the data that is reported by the bank server, and try to fix this with the insertion of an adjusting entry ('Zwischensaldo' transaction). Also, new real transactions might not get imported as finAPI could match them to mocked transactions. <b>THIS SERVICE IS MEANT FOR TESTING PURPOSES DURING DEVELOPMENT OF YOUR APPLICATION ONLY!</b> This is why it will work only on the sandbox or alpha environments. Calling it on the live environment will result in <b>403 Forbidden</b>.

Parameters:

body - Data for mock bank connection updates (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

mockBatchUpdateAsync

public com.squareup.okhttp.Call mockBatchUpdateAsync(MockBatchUpdateParams body,
                                                     ApiCallback<Void> callback)
                                              throws ApiException

Mock batch update (asynchronously) This service can be used to mock an update of one or several bank connections by letting you simulate finAPI's communication with a bank server. More specifically, you can provide custom balances and transactions for existing accounts and finAPI will import that data into the accounts as if the data had been delivered by a real bank server during a real update. The idea of this service is to allow you to create accounts with specific data in them so that you can test your application in different scenarios.<br/><br/>You can also test your application's reception and processing of push notifications with this service, by enabling the 'triggerNotifications' flag in your request. When this flag is enabled, finAPI will send notifications to your application based on the notification rules that are set up for the user and on the data you provided in the request, the same way as it works with finAPI's real automatic batch update process.<br/><br/>Note that this service behaves mostly like calling the bank connection update service, meaning that it returns immediately after having asynchronously started the update process, and also meaning that you have to check the status of the updated bank connections and accounts to find out when the update has finished and what the result is. As you can update several bank connections at once, this service is closer to how finAPI's automatic batch updates work as it is to the manual update service though. Because of this, the result of the mocked bank connection updates will be stored in the 'lastAutoUpdate' field of the bank connections and not in the 'lastManualUpdate' field. Also, just like with the real batch update, any bank connection that you use with this service must have a PIN stored (even though it is not actually forwarded to any bank server).<br/><br/>Also note that this service may be called only when the user's automatic bank connection updates are disabled, to make sure that the mock updates cannot intervene with a real update (please see the User field 'isAutoUpdateEnabled'). Also, it is not possible to use the demo bank connection in this service, so you need to have at least one real online bank connection. At last, it is currently not possible to mock data for security accounts with this service, as you can only pass transactions, but not security positions.<br/><br/>Please be aware that you will 'mess up' the accounts when using this service, meaning that when you perform a real update of accounts that you have previously updated with this service, finAPI might detect inconsistencies in the data that exists in its database and the data that is reported by the bank server, and try to fix this with the insertion of an adjusting entry ('Zwischensaldo' transaction). Also, new real transactions might not get imported as finAPI could match them to mocked transactions. <b>THIS SERVICE IS MEANT FOR TESTING PURPOSES DURING DEVELOPMENT OF YOUR APPLICATION ONLY!</b> This is why it will work only on the sandbox or alpha environments. Calling it on the live environment will result in <b>403 Forbidden</b>.

Parameters:

body - Data for mock bank connection updates (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object