com.starkinfra.PixBalance Maven / Gradle / Ivy

Go to download

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

Welcome to the Stark Infra Java SDK! This tool is made for Java developers who want to easily integrate with our API. This SDK version is compatible with the Stark Infra API v2.

There is a newer version: 0.11.2

Show newest version

package com.starkinfra;

import com.starkinfra.utils.Rest;
import com.starkinfra.utils.Resource;
import com.starkinfra.utils.Generator;

import java.util.List;
import java.util.HashMap;
import java.util.ArrayList;


public final class PixBalance extends Resource {
    /**
     * PixBalance object
     * 
     * The PixBalance object displays the current balance of the workspace,
     * which is the result of the sum of all transactions within this
     * workspace. The balance is never generated by the user, but it
     * can be retrieved to see the information available.
     * 

     * Parameters:
     * id [string]: unique id returned when PixBalance is created. ex: "5656565656565656"
     * amount [Long]: current balance amount of the workspace in cents. ex: 200 (= R$ 2.00)
     * currency [string]: currency of the current workspace. Expect others to be added eventually. ex: "BRL"
     * updated [string]: update datetime for the balance. ex: "2020-03-10 10:30:00.000000+00:00"
     *
     */
    static ClassData data = new ClassData(PixBalance.class, "PixBalance");

    public Long amount;
    public String currency;
    public String updated;

    /**
     * PixBalance object
     * 

     * The PixBalance object displays the current balance of the workspace,
     * which is the result of the sum of all transactions within this
     * workspace. The balance is never generated by the user, but it
     * can be retrieved to see the information available.
     * 

     * Parameters:
     * @param id [string]: unique id returned when PixBalance is created. ex: "5656565656565656"
     * @param amount [Long]: current balance amount of the workspace in cents. ex: 200 (= R$ 2.00)
     * @param currency [string]: currency of the current workspace. Expect others to be added eventually. ex: "BRL"
     * @param updated [string]: update datetime for the balance. ex: "2020-03-10 10:30:00.000000+00:00"
     */
    public PixBalance(Long amount, String currency, String updated, String id) {
        super(id);
        this.amount = amount;
        this.currency = currency;
        this.updated = updated;
    }

    /**
     * Retrieve the PixBalance object
     * 

     * Receive the PixBalance object linked to your workspace in the Stark Infra API
     * 

     * Parameters:
     * @param user [Organization/Project object, default null]: Organization or Project object. Not necessary if starkinfra.Settings.user was set before function call
     * 

     * Return:
     * @return PixBalance object with updated attributes
     * @throws Exception error in the request
     */
    public static PixBalance get(User user) throws Exception {
        List balanceList = new ArrayList<>();
        Generator balances = Rest.getStream(data, new HashMap(), user);
        for (PixBalance balance : balances) {
            balanceList.add(balance);
        }
        return balanceList.get(0);
    }

     /**
     * Retrieve the PixBalance object
     * 

     * Receive the PixBalance object linked to your workspace in the Stark Infra API
     * 
     * Return:
     * @return PixBalance object with updated attributes
     * @throws Exception error in the request
     */
    public static PixBalance get() throws Exception {
        return PixBalance.get(null);
    }
}