com.fintecsystems.xs2a.java.services.ApiBankAccountService.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xs2a-java Show documentation
Java SDK for XS2A API
The newest version!
package com.fintecsystems.xs2a.java.services

import com.fintecsystems.xs2a.java.helper.JsonSerializer
import com.fintecsystems.xs2a.java.helper.OffsetDateTimeAdapter
import com.fintecsystems.xs2a.java.models.api.accounts.BankAccount
import com.fintecsystems.xs2a.java.models.api.accounts.BankAccountBalance
import com.fintecsystems.xs2a.java.models.api.accounts.BankAccountList
import com.fintecsystems.xs2a.java.models.api.accounts.BankAccountTurnovers
import com.fintecsystems.xs2a.java.models.common.ReportFormat
import com.fintecsystems.xs2a.java.models.common.ReportLocale
import okhttp3.OkHttpClient
import java.time.OffsetDateTime

@Suppress("unused")
class ApiBankAccountService(
    apiKey: String,
    client: OkHttpClient = defaultClient,
    backendUrl: String = defaultBackendUrl
) : ServiceBase(
    apiKey,
    client = client,
    backendUrl = backendUrl
) {

    constructor(apiKey: String) : this(apiKey, defaultClient)

    constructor(apiKey: String, backendUrl: String) : this(apiKey, defaultClient, backendUrl)

    constructor(apiKey: String, client: OkHttpClient) : this(apiKey, client, defaultBackendUrl)

    /**
     * Get a list of all accounts for a xs2a.bank user
     *
     * @param per_page Items per page (optional)
     * @param page Which page to display (optional)
     */
    fun list(
        per_page: Int = 15,
        page: Int = 1,
    ): BankAccountList {
        val response = apiService.get(
            "api/accounts",
            mutableMapOf(
                "per_page" to per_page.toString(),
                "page" to page.toString(),
            )
        )

        return JsonSerializer.parseJson(response)
    }

    /**
     * Get a list of all accounts for a xs2a.bank user connection
     * @param connectionId the id of the bank connection
     * @param per_page Items per page (optional)
     * @param page Which page to display (optional)
     */
    fun listForBankConnection(
        connectionId: String,
        per_page: Int = 15,
        page: Int = 1,
    ): BankAccountList {
        val response = apiService.get(
            "api/connections/$connectionId/accounts",
            mutableMapOf(
                "per_page" to per_page.toString(),
                "page" to page.toString(),
            )
        )

        return JsonSerializer.parseJson(response)
    }

    /**
     * Get a specific Bank Account
     * @param bankAccountId The bank-account-id for the account to be retrieved.
     * @return BankAccount
     */
    fun get(bankAccountId: String): BankAccount {
        val response = apiService.get("api/accounts/$bankAccountId")

        return JsonSerializer.parseJson(response)
    }

    /**
     * Delete a xs2a.api bank account
     * @param bankAccountId bankAccountId id of user to delete
     * @return String
     */
    fun delete(bankAccountId: String): String {
        return apiService.delete("api/accounts/$bankAccountId").use { it.readUtf8() }
    }

    /**
     * Retrieve the balance for a specific bank account
     * @param bankAccountId The bank-account-id for the account to be retrieved.
     * @return BankAccountBalance
     */
    fun getBalance(bankAccountId: String): BankAccountBalance {
        val response = apiService.get("api/accounts/$bankAccountId/balance")

        return JsonSerializer.parseJson(response)
    }

    /**
     * Retrieve the turnovers for a specific bank account
     * @param bankAccountId The bank-account-id for the account to be retrieved.
     * @param from Filter turnovers by `booking_date`
     * @param to Filter turnovers by `booking_date`
     * @param onlyNew Filter turnovers by new flag
     * @return BankAccountTurnovers
     */
    fun getTurnovers(
        bankAccountId: String,
        from: OffsetDateTime? = null,
        to: OffsetDateTime? = null,
        onlyNew: Boolean = false
    ): BankAccountTurnovers {
        val response = apiService.get(
            "api/accounts/$bankAccountId/turnovers", mutableMapOf(
                "from" to from?.let { OffsetDateTimeAdapter.offsetDateToJson(from) },
                "to" to to?.let { OffsetDateTimeAdapter.offsetDateToJson(to) },
                "onlyNew" to onlyNew
            )
        )

        return JsonSerializer.parseJson(response)
    }

    /**
     * Mark turnovers as seen
     * @param bankAccountId The bankAccountId for the account for which the turnovers are to be marked as seen.
     * @param upTo Once you set a date, attribute new of all turnovers is set to false until the given date.
     */
    fun markAsSeen(bankAccountId: String, upTo: OffsetDateTime? = null): Any {
        var uri = "api/accounts/$bankAccountId/markAsSeen"

        if (upTo !== null) {
            uri = "$uri/${OffsetDateTimeAdapter.offsetDateToJson(upTo)}"
        }

        val response = apiService.post(uri)

        return JsonSerializer.parseJson(response)
    }

    /**
     * Retrieve a Report for a specific bank account
     * @param bankAccountId The bank-account-id for the account to be retrieved.
     * @param reportId ID of the report to be retrieved.
     * @param format The format parameter is optional. The report is available in the following formats:
     * html, pdf and json. This call defaults to html if the format parameter is omitted.
     * @param locale Locale in which the report will be rendered. This has no effect when using json format.
     */
    fun getReport(
        bankAccountId: String,
        reportId: String,
        format: ReportFormat = ReportFormat.JSON,
        locale: ReportLocale = ReportLocale.EN
    ): Any {
        val response = apiService.get(
            "api/accounts/$bankAccountId/report/$reportId",
            mutableMapOf(
                "format" to format.value,
                "locale" to locale.value,
            )
        )

        return if (format == ReportFormat.JSON)
            JsonSerializer.parseJson(response)
        else
            response
    }
}