io.swagger.client.api

Class NotificationRulesApi

java.lang.Object

io.swagger.client.api.NotificationRulesApi

public class NotificationRulesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
NotificationRulesApi()
NotificationRulesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
NotificationRule	createNotificationRule(NotificationRuleParams body) Create a new notification rule Create a new notification rule for a specific user.
com.squareup.okhttp.Call	createNotificationRuleAsync(NotificationRuleParams body, ApiCallback<NotificationRule> callback) Create a new notification rule (asynchronously) Create a new notification rule for a specific user.
com.squareup.okhttp.Call	createNotificationRuleCall(NotificationRuleParams body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for createNotificationRule
ApiResponse<NotificationRule>	createNotificationRuleWithHttpInfo(NotificationRuleParams body) Create a new notification rule Create a new notification rule for a specific user.
IdentifierList	deleteAllNotificationRules() Delete all notification rules Delete all notification rules of the user that is authorized by the access_token.
com.squareup.okhttp.Call	deleteAllNotificationRulesAsync(ApiCallback<IdentifierList> callback) Delete all notification rules (asynchronously) Delete all notification rules of the user that is authorized by the access_token.
com.squareup.okhttp.Call	deleteAllNotificationRulesCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for deleteAllNotificationRules
ApiResponse<IdentifierList>	deleteAllNotificationRulesWithHttpInfo() Delete all notification rules Delete all notification rules of the user that is authorized by the access_token.
void	deleteNotificationRule(Long id) Delete a notification rule Delete a single notification rule of the user that is authorized by the access_token.
com.squareup.okhttp.Call	deleteNotificationRuleAsync(Long id, ApiCallback<Void> callback) Delete a notification rule (asynchronously) Delete a single notification rule of the user that is authorized by the access_token.
com.squareup.okhttp.Call	deleteNotificationRuleCall(Long id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for deleteNotificationRule
ApiResponse<Void>	deleteNotificationRuleWithHttpInfo(Long id) Delete a notification rule Delete a single notification rule of the user that is authorized by the access_token.
NotificationRuleList	getAndSearchAllNotificationRules(List<Long> ids, String triggerEvent, Boolean includeDetails) Get and search all notification rules Get notification rules of the user that is authorized by the access_token.
com.squareup.okhttp.Call	getAndSearchAllNotificationRulesAsync(List<Long> ids, String triggerEvent, Boolean includeDetails, ApiCallback<NotificationRuleList> callback) Get and search all notification rules (asynchronously) Get notification rules of the user that is authorized by the access_token.
com.squareup.okhttp.Call	getAndSearchAllNotificationRulesCall(List<Long> ids, String triggerEvent, Boolean includeDetails, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getAndSearchAllNotificationRules
ApiResponse<NotificationRuleList>	getAndSearchAllNotificationRulesWithHttpInfo(List<Long> ids, String triggerEvent, Boolean includeDetails) Get and search all notification rules Get notification rules of the user that is authorized by the access_token.
ApiClient	getApiClient()
NotificationRule	getNotificationRule(Long id) Get a notification rule Get a single notification rule of the user that is authorized by the access_token.
com.squareup.okhttp.Call	getNotificationRuleAsync(Long id, ApiCallback<NotificationRule> callback) Get a notification rule (asynchronously) Get a single notification rule of the user that is authorized by the access_token.
com.squareup.okhttp.Call	getNotificationRuleCall(Long id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getNotificationRule
ApiResponse<NotificationRule>	getNotificationRuleWithHttpInfo(Long id) Get a notification rule Get a single notification rule of the user that is authorized by the access_token.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationRulesApi

public NotificationRulesApi()

NotificationRulesApi

public NotificationRulesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createNotificationRuleCall

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

Build call for createNotificationRule

Parameters:

body - Notification rule parameters (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createNotificationRule

public NotificationRule createNotificationRule(NotificationRuleParams body)
                                        throws ApiException

Create a new notification rule Create a new notification rule for a specific user. Must pass the user's access_token.<br/><br/>Setting up notification rules for a user allows your client application to get notified about changes in the user's data, e.g. when new transactions were downloaded, an account's balance has changed, or the user's banking credentials are no longer correct. Note that currently, this feature is implemented only for finAPI's automatic batch update, i.e. notification rules are only relevant when the user has activated the automatic updates (and when the automatic batch update is activated in general for your client).<br/><br/>There are different kinds of notification rules. The kind of a rule is depicted by the 'triggerEvent'. The trigger event specifies what data you have to pass when creating a rule (specifically, the contents of the 'params' field), on which events finAPI will send notifications to your client application, as well as what data is contained in those notifications. The specifics of the different trigger events are documented in the following article on our Dev Portal: <a href='https://finapi.zendesk.com/hc/en-us/articles/232324608-How-to-create-notification-rules-and-receive-notifications'>How to create notification rules and receive notifications</a>

Parameters:

body - Notification rule parameters (required)

Returns:

NotificationRule

Throws:

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

createNotificationRuleWithHttpInfo

public ApiResponse<NotificationRule> createNotificationRuleWithHttpInfo(NotificationRuleParams body)
                                                                 throws ApiException

Create a new notification rule Create a new notification rule for a specific user. Must pass the user's access_token.<br/><br/>Setting up notification rules for a user allows your client application to get notified about changes in the user's data, e.g. when new transactions were downloaded, an account's balance has changed, or the user's banking credentials are no longer correct. Note that currently, this feature is implemented only for finAPI's automatic batch update, i.e. notification rules are only relevant when the user has activated the automatic updates (and when the automatic batch update is activated in general for your client).<br/><br/>There are different kinds of notification rules. The kind of a rule is depicted by the 'triggerEvent'. The trigger event specifies what data you have to pass when creating a rule (specifically, the contents of the 'params' field), on which events finAPI will send notifications to your client application, as well as what data is contained in those notifications. The specifics of the different trigger events are documented in the following article on our Dev Portal: <a href='https://finapi.zendesk.com/hc/en-us/articles/232324608-How-to-create-notification-rules-and-receive-notifications'>How to create notification rules and receive notifications</a>

Parameters:

body - Notification rule parameters (required)

Returns:

ApiResponse<NotificationRule>

Throws:

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

createNotificationRuleAsync

public com.squareup.okhttp.Call createNotificationRuleAsync(NotificationRuleParams body,
                                                            ApiCallback<NotificationRule> callback)
                                                     throws ApiException

Create a new notification rule (asynchronously) Create a new notification rule for a specific user. Must pass the user's access_token.<br/><br/>Setting up notification rules for a user allows your client application to get notified about changes in the user's data, e.g. when new transactions were downloaded, an account's balance has changed, or the user's banking credentials are no longer correct. Note that currently, this feature is implemented only for finAPI's automatic batch update, i.e. notification rules are only relevant when the user has activated the automatic updates (and when the automatic batch update is activated in general for your client).<br/><br/>There are different kinds of notification rules. The kind of a rule is depicted by the 'triggerEvent'. The trigger event specifies what data you have to pass when creating a rule (specifically, the contents of the 'params' field), on which events finAPI will send notifications to your client application, as well as what data is contained in those notifications. The specifics of the different trigger events are documented in the following article on our Dev Portal: <a href='https://finapi.zendesk.com/hc/en-us/articles/232324608-How-to-create-notification-rules-and-receive-notifications'>How to create notification rules and receive notifications</a>

Parameters:

body - Notification rule parameters (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

deleteAllNotificationRulesCall

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

Build call for deleteAllNotificationRules

Parameters:

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteAllNotificationRules

public IdentifierList deleteAllNotificationRules()
                                          throws ApiException

Delete all notification rules Delete all notification rules of the user that is authorized by the access_token. Must pass the user's access_token.

Returns:

IdentifierList

Throws:

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

deleteAllNotificationRulesWithHttpInfo

public ApiResponse<IdentifierList> deleteAllNotificationRulesWithHttpInfo()
                                                                   throws ApiException

Delete all notification rules Delete all notification rules of the user that is authorized by the access_token. Must pass the user's access_token.

Returns:

ApiResponse<IdentifierList>

Throws:

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

deleteAllNotificationRulesAsync

public com.squareup.okhttp.Call deleteAllNotificationRulesAsync(ApiCallback<IdentifierList> callback)
                                                         throws ApiException

Delete all notification rules (asynchronously) Delete all notification rules of the user that is authorized by the access_token. Must pass the user's access_token.

Parameters:

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

deleteNotificationRuleCall

public com.squareup.okhttp.Call deleteNotificationRuleCall(Long id,
                                                           ProgressResponseBody.ProgressListener progressListener,
                                                           ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                    throws ApiException

Build call for deleteNotificationRule

Parameters:

id - Identifier of the notification rule to delete (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteNotificationRule

public void deleteNotificationRule(Long id)
                            throws ApiException

Delete a notification rule Delete a single notification rule of the user that is authorized by the access_token. Must pass the notification rule's identifier and the user's access_token.

Parameters:

id - Identifier of the notification rule to delete (required)

Throws:

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

deleteNotificationRuleWithHttpInfo

public ApiResponse<Void> deleteNotificationRuleWithHttpInfo(Long id)
                                                     throws ApiException

Delete a notification rule Delete a single notification rule of the user that is authorized by the access_token. Must pass the notification rule's identifier and the user's access_token.

Parameters:

id - Identifier of the notification rule to delete (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteNotificationRuleAsync

public com.squareup.okhttp.Call deleteNotificationRuleAsync(Long id,
                                                            ApiCallback<Void> callback)
                                                     throws ApiException

Delete a notification rule (asynchronously) Delete a single notification rule of the user that is authorized by the access_token. Must pass the notification rule's identifier and the user's access_token.

Parameters:

id - Identifier of the notification rule to delete (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

getAndSearchAllNotificationRulesCall

public com.squareup.okhttp.Call getAndSearchAllNotificationRulesCall(List<Long> ids,
                                                                     String triggerEvent,
                                                                     Boolean includeDetails,
                                                                     ProgressResponseBody.ProgressListener progressListener,
                                                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                              throws ApiException

Build call for getAndSearchAllNotificationRules

Parameters:

ids - A comma-separated list of notification rule identifiers. If specified, then only notification rules whose identifier match any of the given identifiers will be regarded. The maximum number of identifiers is 1000. (optional)

triggerEvent - If specified, then only notification rules with given trigger event will be regarded. (optional)

includeDetails - If specified, then only notification rules that include or not include details will be regarded. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getAndSearchAllNotificationRules

public NotificationRuleList getAndSearchAllNotificationRules(List<Long> ids,
                                                             String triggerEvent,
                                                             Boolean includeDetails)
                                                      throws ApiException

Get and search all notification rules Get notification rules of the user that is authorized by the access_token. Must pass the user's access_token. You can set optional search criteria to get only those notification rules that you are interested in. If you do not specify any search criteria, then this service functions as a 'get all' service.

Parameters:

ids - A comma-separated list of notification rule identifiers. If specified, then only notification rules whose identifier match any of the given identifiers will be regarded. The maximum number of identifiers is 1000. (optional)

triggerEvent - If specified, then only notification rules with given trigger event will be regarded. (optional)

includeDetails - If specified, then only notification rules that include or not include details will be regarded. (optional)

Returns:

NotificationRuleList

Throws:

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

getAndSearchAllNotificationRulesWithHttpInfo

public ApiResponse<NotificationRuleList> getAndSearchAllNotificationRulesWithHttpInfo(List<Long> ids,
                                                                                      String triggerEvent,
                                                                                      Boolean includeDetails)
                                                                               throws ApiException

Get and search all notification rules Get notification rules of the user that is authorized by the access_token. Must pass the user's access_token. You can set optional search criteria to get only those notification rules that you are interested in. If you do not specify any search criteria, then this service functions as a 'get all' service.

Parameters:

ids - A comma-separated list of notification rule identifiers. If specified, then only notification rules whose identifier match any of the given identifiers will be regarded. The maximum number of identifiers is 1000. (optional)

triggerEvent - If specified, then only notification rules with given trigger event will be regarded. (optional)

includeDetails - If specified, then only notification rules that include or not include details will be regarded. (optional)

Returns:

ApiResponse<NotificationRuleList>

Throws:

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

getAndSearchAllNotificationRulesAsync

public com.squareup.okhttp.Call getAndSearchAllNotificationRulesAsync(List<Long> ids,
                                                                      String triggerEvent,
                                                                      Boolean includeDetails,
                                                                      ApiCallback<NotificationRuleList> callback)
                                                               throws ApiException

Get and search all notification rules (asynchronously) Get notification rules of the user that is authorized by the access_token. Must pass the user's access_token. You can set optional search criteria to get only those notification rules that you are interested in. If you do not specify any search criteria, then this service functions as a 'get all' service.

Parameters:

ids - A comma-separated list of notification rule identifiers. If specified, then only notification rules whose identifier match any of the given identifiers will be regarded. The maximum number of identifiers is 1000. (optional)

triggerEvent - If specified, then only notification rules with given trigger event will be regarded. (optional)

includeDetails - If specified, then only notification rules that include or not include details will be regarded. (optional)

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

getNotificationRuleCall

public com.squareup.okhttp.Call getNotificationRuleCall(Long id,
                                                        ProgressResponseBody.ProgressListener progressListener,
                                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                 throws ApiException

Build call for getNotificationRule

Parameters:

id - Identifier of requested notification rule (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getNotificationRule

public NotificationRule getNotificationRule(Long id)
                                     throws ApiException

Get a notification rule Get a single notification rule of the user that is authorized by the access_token. Must pass the notification rule's identifier and the user's access_token.

Parameters:

id - Identifier of requested notification rule (required)

Returns:

NotificationRule

Throws:

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

getNotificationRuleWithHttpInfo

public ApiResponse<NotificationRule> getNotificationRuleWithHttpInfo(Long id)
                                                              throws ApiException

Get a notification rule Get a single notification rule of the user that is authorized by the access_token. Must pass the notification rule's identifier and the user's access_token.

Parameters:

id - Identifier of requested notification rule (required)

Returns:

ApiResponse<NotificationRule>

Throws:

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

getNotificationRuleAsync

public com.squareup.okhttp.Call getNotificationRuleAsync(Long id,
                                                         ApiCallback<NotificationRule> callback)
                                                  throws ApiException

Get a notification rule (asynchronously) Get a single notification rule of the user that is authorized by the access_token. Must pass the notification rule's identifier and the user's access_token.

Parameters:

id - Identifier of requested notification rule (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