com.bitpay.sdk.model.invoice.InvoiceEventToken Maven / Gradle / Ivy

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

Full implementation of the BitPay Payment Gateway. This library implements BitPay's Cryptographically Secure RESTful API.

The newest version!

/*
 * Copyright (c) 2019 BitPay.
 * All rights reserved.
 */

package com.bitpay.sdk.model.invoice;

import com.bitpay.sdk.model.ModelConfiguration;
import java.util.List;
import java.util.Objects;

/**
 * The type Invoice event token.
 *
 * @see REST API Invoices
 */
public class InvoiceEventToken {

    protected String token = ModelConfiguration.DEFAULT_NON_SENT_VALUE;
    protected List events;
    protected List actions;

    /**
     * Instantiates a new Invoice event token.
     */
    protected InvoiceEventToken() {
    }

    /**
     * Instantiates a new Invoice event token.
     *
     * @param token   the token
     * @param events  the events
     * @param actions the actions
     */
    public InvoiceEventToken(
        String token,
        List events,
        List actions
    ) {
        Objects.requireNonNull(token, "missing token");
        this.token = token;
        this.events = events;
        this.actions = actions;
    }

    /**
     * Gets token.
     *
     * @return the token
     */
    public String getToken() {
        return this.token;
    }

    /**
     * Get events. The possible values are:
     * 
     *     payment - This allows you to be informed when the BitPay invoice reaches the status "paid",
     *     meaning the transaction has been applied to the invoice, but has not been confirmed yet.
     *     When listening to the websocket, this will be logged under the event: statechange.
     *     The invoice payload will contain the additional fields related to the merchant facade.
     *     
     *     confirmation - This allows you to track the number of block confirmations for the transaction made
     *     to an invoice.
     *     When listening to the websocket, this will be logged under the event: statechange.
     *     The invoice payload will contain the additional fields related to the merchant facade.
     *     
     * 
     *
     * @return the events
     */
    public List getEvents() {
        return this.events;
    }

    /**
     * Gets actions. Can be subscribe, unsubscribe or both.
     *
     * @return the actions
     */
    public List getActions() {
        return this.actions;
    }
}