co.dapi

Class DapiApp

java.lang.Object

co.dapi.DapiApp

public class DapiApp
extends Object

DapiApp represents a client app that's using one or more of the Dapi products.

Constructor Summary

Constructors

Constructor and Description
DapiApp(Config config)

Method Summary

Modifier and Type	Method and Description
CreateBeneficiaryResponse	createBeneficiary(Payment.BeneficiaryInfo beneficiary, String accessToken, String userSecret) createBeneficiary talks to the CreateBeneficiary endpoint of Dapi, with this DapiApp's appSecret.
CreateBeneficiaryResponse	createBeneficiary(Payment.BeneficiaryInfo beneficiary, String accessToken, String userSecret, String operationID, UserInput[] userInputs) createBeneficiary talks to the CreateBeneficiary endpoint of Dapi, with this DapiApp's appSecret, to continue a previous operation that required to provide some userInputs.
CreateTransferResponse	createTransfer(Payment.Transfer transfer, String accessToken, String userSecret) createTransfer talks to the CreateTransfer endpoint of Dapi, with this DapiApp's appSecret.
CreateTransferResponse	createTransfer(Payment.Transfer transfer, String accessToken, String userSecret, String operationID, UserInput[] userInputs) createTransfer talks to the CreateTransfer endpoint of Dapi, with this DapiApp's appSecret, to continue a previous operation that required to provide some userInputs.
ExchangeTokenResponse	exchangeToken(String accessCode, String connectionID) exchangeToken talks to the ExchangeToken endpoint of Dapi, with this DapiApp's appSecret.
GetAccountsResponse	getAccounts(String accessToken, String userSecret) getAccounts talks to the GetAccounts endpoint of Dapi, with this DapiApp's appSecret.
GetAccountsResponse	getAccounts(String accessToken, String userSecret, String operationID, UserInput[] userInputs) getAccounts talks to the GetAccounts endpoint of Dapi, with this DapiApp's appSecret, to continue a previous operation that required to provide some userInputs.
GetAccountsMetadataResponse	getAccountsMetadata(String accessToken, String userSecret) getAccountsMetadata talks to the GetAccountsMetadata endpoint of Dapi, with this DapiApp's appSecret.
GetAccountsMetadataResponse	getAccountsMetadata(String accessToken, String userSecret, String operationID, UserInput[] userInputs) getAccountsMetadata talks to the GetAccountsMetadata endpoint of Dapi, with this DapiApp's appSecret, to continue a previous operation that required to provide some userInputs.
GetBalanceResponse	getBalance(String accountID, String accessToken, String userSecret) getBalance talks to the GetBalance endpoint of Dapi, with this DapiApp's appSecret.
GetBalanceResponse	getBalance(String accountID, String accessToken, String userSecret, String operationID, UserInput[] userInputs) getBalance talks to the GetBalance endpoint of Dapi, with this DapiApp's appSecret, to continue a previous operation that required to provide some userInputs.
GetBeneficiariesResponse	getBeneficiaries(String accessToken, String userSecret) getBeneficiaries talks to the GetBeneficiaries endpoint of Dapi, with this DapiApp's appSecret.
GetBeneficiariesResponse	getBeneficiaries(String accessToken, String userSecret, String operationID, UserInput[] userInputs) getBeneficiaries talks to the GetBeneficiaries endpoint of Dapi, with this DapiApp's appSecret, to continue a previous operation that required to provide some userInputs.
GetIdentityResponse	getIdentity(String accessToken, String userSecret) getIdentity talks to the GetIdentity endpoint of Dapi, with this DapiApp's appSecret.
GetIdentityResponse	getIdentity(String accessToken, String userSecret, String operationID, UserInput[] userInputs) getIdentity talks to the GetIdentity endpoint of Dapi, with this DapiApp's appSecret, to continue a previous operation that required to provide some userInputs.
GetTransactionsResponse	getTransactions(String accountID, LocalDate fromDate, LocalDate toDate, String accessToken, String userSecret) getTransactions talks to the GetTransactions endpoint of Dapi, with this DapiApp's appSecret, to continue a previous operation that required to provide some userInputs.
GetTransactionsResponse	getTransactions(String accountID, LocalDate fromDate, LocalDate toDate, String accessToken, String userSecret, String operationID, UserInput[] userInputs) getTransactions talks to the GetTransactions endpoint of Dapi, with this DapiApp's appSecret, to continue a previous operation that required to provide some userInputs.
okhttp3.Response	handleSDKRequest(String bodyJson) handleSDKRequest injects this DapiApp's appSecret in the passed request body, bodyJson, and then forwards the request to Dapi, and returns the RAW response got.
okhttp3.Response	handleSDKRequest(String bodyJson, HashMap<String,String> headersMap) handleSDKRequest injects this DapiApp's appSecret in the passed request body, bodyJson, and then forwards the request to Dapi, with the passed headers, headersMap, and returns the RAW response got.
TransferAutoflowResponse	transferAutoflow(Payment.TransferAutoflow transferAutoflow, String accessToken, String userSecret) transferAutoflow talks to the TransferAutoflow endpoint of Dapi, with this DapiApp's appSecret.
TransferAutoflowResponse	transferAutoflow(Payment.TransferAutoflow transferAutoflow, String accessToken, String userSecret, String operationID, UserInput[] userInputs) transferAutoflow talks to the TransferAutoflow endpoint of Dapi, with this DapiApp's appSecret, to continue a previous operation that required to provide some userInputs.

Methods inherited from class java.lang.Object

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

Constructor Detail

DapiApp

public DapiApp(Config config)

Method Detail

exchangeToken

public ExchangeTokenResponse exchangeToken(String accessCode,
                                           String connectionID)
                                    throws IOException

exchangeToken talks to the ExchangeToken endpoint of Dapi, with this DapiApp's appSecret.

Parameters:

accessCode - retrieved from user login.

connectionID - retrieved from user login.

Returns:

an ExchangeTokenResponse.

Throws:

IOException - in case of trouble happened while executing the request or reading the response.

getIdentity

public GetIdentityResponse getIdentity(String accessToken,
                                       String userSecret)
                                throws IOException

getIdentity talks to the GetIdentity endpoint of Dapi, with this DapiApp's appSecret.

Parameters:

accessToken - retrieved from the ExchangeToken process.

userSecret - retrieved from the user login.

Returns:

a GetIdentityResponse.

Throws:

IOException - in case of trouble happened while executing the request or reading the response.

getIdentity

public GetIdentityResponse getIdentity(String accessToken,
                                       String userSecret,
                                       String operationID,
                                       UserInput[] userInputs)
                                throws IOException

getIdentity talks to the GetIdentity endpoint of Dapi, with this DapiApp's appSecret, to continue a previous operation that required to provide some userInputs.

Parameters:

accessToken - retrieved from the ExchangeToken process.

userSecret - retrieved from the user login.

operationID - retrieved from the previous call's response.

userInputs - built from the previous call's response, and the required user input.

Returns:

a GetIdentityResponse.

Throws:

IOException - in case of trouble happened while executing the request or reading the response.

getAccounts

public GetAccountsResponse getAccounts(String accessToken,
                                       String userSecret)
                                throws IOException

getAccounts talks to the GetAccounts endpoint of Dapi, with this DapiApp's appSecret.

Parameters:

accessToken - retrieved from the ExchangeToken process.

userSecret - retrieved from the user login.

Returns:

an GetAccountsResponse.

Throws:

IOException - in case of trouble happened while executing the request or reading the response.

getAccounts

public GetAccountsResponse getAccounts(String accessToken,
                                       String userSecret,
                                       String operationID,
                                       UserInput[] userInputs)
                                throws IOException

getAccounts talks to the GetAccounts endpoint of Dapi, with this DapiApp's appSecret, to continue a previous operation that required to provide some userInputs.

Parameters:

accessToken - retrieved from the ExchangeToken process.

userSecret - retrieved from the user login.

operationID - retrieved from the previous call's response.

userInputs - built from the previous call's response, and the required user input.

Returns:

an GetAccountsResponse.

Throws:

IOException - in case of trouble happened while executing the request or reading the response.

getBalance

public GetBalanceResponse getBalance(String accountID,
                                     String accessToken,
                                     String userSecret)
                              throws IOException

getBalance talks to the GetBalance endpoint of Dapi, with this DapiApp's appSecret.

Parameters:

accountID - the id of the account which this operation is about.

accessToken - retrieved from the ExchangeToken process.

userSecret - retrieved from the user login.

Returns:

an GetBalanceResponse.

Throws:

IOException - in case of trouble happened while executing the request or reading the response.

getBalance

public GetBalanceResponse getBalance(String accountID,
                                     String accessToken,
                                     String userSecret,
                                     String operationID,
                                     UserInput[] userInputs)
                              throws IOException

getBalance talks to the GetBalance endpoint of Dapi, with this DapiApp's appSecret, to continue a previous operation that required to provide some userInputs.

Parameters:

accountID - the id of the account which this operation is about.

accessToken - retrieved from the ExchangeToken process.

userSecret - retrieved from the user login.

operationID - retrieved from the previous call's response.

userInputs - built from the previous call's response, and the required user input.

Returns:

an GetBalanceResponse.

Throws:

IOException - in case of trouble happened while executing the request or reading the response.

getTransactions

public GetTransactionsResponse getTransactions(String accountID,
                                               LocalDate fromDate,
                                               LocalDate toDate,
                                               String accessToken,
                                               String userSecret)
                                        throws IOException

getTransactions talks to the GetTransactions endpoint of Dapi, with this DapiApp's appSecret, to continue a previous operation that required to provide some userInputs.

Parameters:

accountID - the id of the account which this operation is about.

fromDate - the start date of the transactions we want.

toDate - the end date of the transactions we want.

accessToken - retrieved from the ExchangeToken process.

userSecret - retrieved from the user login.

Returns:

an GetTransactionsResponse.

Throws:

IOException - in case of trouble happened while executing the request or reading the response.

getTransactions

public GetTransactionsResponse getTransactions(String accountID,
                                               LocalDate fromDate,
                                               LocalDate toDate,
                                               String accessToken,
                                               String userSecret,
                                               String operationID,
                                               UserInput[] userInputs)
                                        throws IOException

getTransactions talks to the GetTransactions endpoint of Dapi, with this DapiApp's appSecret, to continue a previous operation that required to provide some userInputs.

Parameters:

accountID - the id of the account which this operation is about.

fromDate - the start date of the transactions we want.

toDate - the end date of the transactions we want.

accessToken - retrieved from the ExchangeToken process.

userSecret - retrieved from the user login.

operationID - retrieved from the previous call's response.

userInputs - built from the previous call's response, and the required user input.

Returns:

an GetTransactionsResponse.

Throws:

IOException - in case of trouble happened while executing the request or reading the response.

createBeneficiary

public CreateBeneficiaryResponse createBeneficiary(Payment.BeneficiaryInfo beneficiary,
                                                   String accessToken,
                                                   String userSecret)
                                            throws IOException

createBeneficiary talks to the CreateBeneficiary endpoint of Dapi, with this DapiApp's appSecret.

Parameters:

accessToken - retrieved from the ExchangeToken process.

userSecret - retrieved from the user login.

Returns:

an CreateBeneficiaryResponse.

Throws:

IOException - in case of trouble happened while executing the request or reading the response.

createBeneficiary

public CreateBeneficiaryResponse createBeneficiary(Payment.BeneficiaryInfo beneficiary,
                                                   String accessToken,
                                                   String userSecret,
                                                   String operationID,
                                                   UserInput[] userInputs)
                                            throws IOException

createBeneficiary talks to the CreateBeneficiary endpoint of Dapi, with this DapiApp's appSecret, to continue a previous operation that required to provide some userInputs.

Parameters:

accessToken - retrieved from the ExchangeToken process.

userSecret - retrieved from the user login.

operationID - retrieved from the previous call's response.

userInputs - built from the previous call's response, and the required user input.

Returns:

an CreateBeneficiaryResponse.

Throws:

IOException - in case of trouble happened while executing the request or reading the response.

getBeneficiaries

public GetBeneficiariesResponse getBeneficiaries(String accessToken,
                                                 String userSecret)
                                          throws IOException

getBeneficiaries talks to the GetBeneficiaries endpoint of Dapi, with this DapiApp's appSecret.

Parameters:

accessToken - retrieved from the ExchangeToken process.

userSecret - retrieved from the user login.

Returns:

an GetBeneficiariesResponse.

Throws:

IOException - in case of trouble happened while executing the request or reading the response.

getBeneficiaries

public GetBeneficiariesResponse getBeneficiaries(String accessToken,
                                                 String userSecret,
                                                 String operationID,
                                                 UserInput[] userInputs)
                                          throws IOException

getBeneficiaries talks to the GetBeneficiaries endpoint of Dapi, with this DapiApp's appSecret, to continue a previous operation that required to provide some userInputs.

Parameters:

accessToken - retrieved from the ExchangeToken process.

userSecret - retrieved from the user login.

operationID - retrieved from the previous call's response.

userInputs - built from the previous call's response, and the required user input.

Returns:

an GetBeneficiariesResponse.

Throws:

IOException - in case of trouble happened while executing the request or reading the response.

createTransfer

public CreateTransferResponse createTransfer(Payment.Transfer transfer,
                                             String accessToken,
                                             String userSecret)
                                      throws IOException

createTransfer talks to the CreateTransfer endpoint of Dapi, with this DapiApp's appSecret.

Parameters:

transfer - the transfer details that we want to initiate.

accessToken - retrieved from the ExchangeToken process.

userSecret - retrieved from the user login.

Returns:

an CreateTransferResponse.

Throws:

IOException - in case of trouble happened while executing the request or reading the response.

createTransfer

public CreateTransferResponse createTransfer(Payment.Transfer transfer,
                                             String accessToken,
                                             String userSecret,
                                             String operationID,
                                             UserInput[] userInputs)
                                      throws IOException

createTransfer talks to the CreateTransfer endpoint of Dapi, with this DapiApp's appSecret, to continue a previous operation that required to provide some userInputs.

Parameters:

transfer - the transfer details that we want to initiate.

accessToken - retrieved from the ExchangeToken process.

userSecret - retrieved from the user login.

operationID - retrieved from the previous call's response.

userInputs - built from the previous call's response, and the required user input.

Returns:

an CreateTransferResponse.

Throws:

IOException - in case of trouble happened while executing the request or reading the response.

transferAutoflow

public TransferAutoflowResponse transferAutoflow(Payment.TransferAutoflow transferAutoflow,
                                                 String accessToken,
                                                 String userSecret)
                                          throws IOException

transferAutoflow talks to the TransferAutoflow endpoint of Dapi, with this DapiApp's appSecret.

Parameters:

transferAutoflow - the details required to create a TransferAutoflow operation.

accessToken - retrieved from the ExchangeToken process.

userSecret - retrieved from the user login.

Returns:

an TransferAutoflowResponse.

Throws:

IOException - in case of trouble happened while executing the request or reading the response.

transferAutoflow

public TransferAutoflowResponse transferAutoflow(Payment.TransferAutoflow transferAutoflow,
                                                 String accessToken,
                                                 String userSecret,
                                                 String operationID,
                                                 UserInput[] userInputs)
                                          throws IOException

transferAutoflow talks to the TransferAutoflow endpoint of Dapi, with this DapiApp's appSecret, to continue a previous operation that required to provide some userInputs.

Parameters:

transferAutoflow - the details required to create a TransferAutoflow operation.

accessToken - retrieved from the ExchangeToken process.

userSecret - retrieved from the user login.

operationID - retrieved from the previous call's response.

userInputs - built from the previous call's response, and the required user input.

Returns:

an TransferAutoflowResponse.

Throws:

IOException - in case of trouble happened while executing the request or reading the response.

getAccountsMetadata

public GetAccountsMetadataResponse getAccountsMetadata(String accessToken,
                                                       String userSecret)
                                                throws IOException

getAccountsMetadata talks to the GetAccountsMetadata endpoint of Dapi, with this DapiApp's appSecret.

Parameters:

accessToken - retrieved from the ExchangeToken process.

userSecret - retrieved from the user login.

Returns:

an GetAccountsMetadataResponse.

Throws:

IOException - in case of trouble happened while executing the request or reading the response.

getAccountsMetadata

public GetAccountsMetadataResponse getAccountsMetadata(String accessToken,
                                                       String userSecret,
                                                       String operationID,
                                                       UserInput[] userInputs)
                                                throws IOException

getAccountsMetadata talks to the GetAccountsMetadata endpoint of Dapi, with this DapiApp's appSecret, to continue a previous operation that required to provide some userInputs.

Parameters:

accessToken - retrieved from the ExchangeToken process.

userSecret - retrieved from the user login.

operationID - retrieved from the previous call's response.

userInputs - built from the previous call's response, and the required user input.

Returns:

an GetAccountsMetadataResponse.

Throws:

IOException - in case of trouble happened while executing the request or reading the response.

handleSDKRequest

public okhttp3.Response handleSDKRequest(String bodyJson,
                                         HashMap<String,String> headersMap)
                                  throws IOException,
                                         com.google.gson.JsonSyntaxException

handleSDKRequest injects this DapiApp's appSecret in the passed request body, bodyJson, and then forwards the request to Dapi, with the passed headers, headersMap, and returns the RAW response got.

Parameters:

bodyJson - the body of the request, in JSON format.

headersMap - any headers that needs to be passed with the request.

Returns:

an Response representing the HTTP response of this operation.

Throws:

IOException - in case of trouble happened while executing the request.

com.google.gson.JsonSyntaxException - in case of trouble happened while reading the request body.

handleSDKRequest

public okhttp3.Response handleSDKRequest(String bodyJson)
                                  throws IOException,
                                         com.google.gson.JsonSyntaxException

handleSDKRequest injects this DapiApp's appSecret in the passed request body, bodyJson, and then forwards the request to Dapi, and returns the RAW response got.

Parameters:

bodyJson - the body of the request, in JSON format.

Returns:

an Response representing the HTTP response of this operation.

Throws:

IOException - in case of trouble happened while executing the request.

com.google.gson.JsonSyntaxException - in case of trouble happened while reading the request body.