me.figo.models.Notification Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sdk Show documentation

This SDK eases the development of Java applications and web services consuming the figo connect API. Figo connect allows developers simple access to users bank data on a trustworthy basis. Users can grant your application access to certain parts of their bank accounts and you can access them without worrying about the inner workings of online banking.

The newest version!

//
// Copyright (c) 2013 figo GmbH
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//

package me.figo.models;

import java.util.List;

import com.google.gson.annotations.Expose;

/**
 * Object representing a configured notification, e.g a webhook or email hook
 * 
 * @author Stefan Richter
 */
public class Notification {

    /**
     * Internal figo Connect notification ID from the notification registration response
     */
    @Expose(serialize = false)
    private String notification_id;

    /**
     * Notification key: see http://developer.figo.me/#notification_keys
     */
    @Expose
    private String observe_key;

    /**
     * Notification messages will be sent to this URL
     */
    @Expose
    private String notify_uri;

    /**
     * State similar to sync and login process. It will passed as POST payload for webhooks
     */
    @Expose
    private String state;

    public Notification() {
    }

    public Notification(String observe_key, String notify_uri, String state) {
        this.observe_key = observe_key;
        this.notify_uri = notify_uri;
        this.state = state;
    }

    /**
     * @return the internal figo Connect notification ID from the notification registration response
     */
    public String getNotificationId() {
        return notification_id;
    }

    /**
     * @return the notification key
     */
    public String getObserveKey() {
        return observe_key;
    }

    /**
     * @param key
     *            the notification key to set
     */
    public void setObserveKey(String key) {
        observe_key = key;
    }

    /**
     * @return the notification messages will be sent to this URL
     */
    public String getNotifyURI() {
        return notify_uri;
    }

    /**
     * @param uri
     *            the notified URI to set
     */
    public void setNotifyURI(String uri) {
        notify_uri = uri;
    }

    /**
     * @return the state (similar to sync and login process). It will passed as POST payload for webhooks
     */
    public String getState() {
        return state;
    }

    /**
     * @param state
     *            the state to set
     */
    public void setState(String state) {
        this.state = state;
    }

    /**
     * Helper type to match actual response from figo API
     */
    public static class NotificationsResponse {
        /**
         * List of notifications asked for
         */
        @Expose
        private List notifications;

        public NotificationsResponse() {
        }

        /**
         * List of notifications asked for
         * @return List of notifications
         */
        public List getNotifications() {
            return notifications;
        }
    }
}