au.org.consumerdatastandards.client.api

Class BankingDirectDebitsAPI

java.lang.Object

au.org.consumerdatastandards.client.api.BankingDirectDebitsAPI

public class BankingDirectDebitsAPI
extends Object

Constructor Summary

Constructors

Constructor and Description
BankingDirectDebitsAPI()
BankingDirectDebitsAPI(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
ResponseBankingDirectDebitAuthorisationList	listDirectDebits(String accountId, Integer page, Integer pageSize) Get Direct Debits For Account Obtain direct debit authorisations for a specific account
okhttp3.Call	listDirectDebitsAsync(String accountId, Integer page, Integer pageSize, ApiCallback<ResponseBankingDirectDebitAuthorisationList> _callback) Get Direct Debits For Account (asynchronously) Obtain direct debit authorisations for a specific account
okhttp3.Call	listDirectDebitsCall(String accountId, Integer page, Integer pageSize, ApiCallback _callback) Build call for listDirectDebits
ResponseBankingDirectDebitAuthorisationList	listDirectDebitsSpecificAccounts(RequestAccountIds accountIds, Integer page, Integer pageSize) Get Direct Debits For Specific Accounts Obtain direct debit authorisations for a specified list of accounts
okhttp3.Call	listDirectDebitsSpecificAccountsAsync(RequestAccountIds accountIds, Integer page, Integer pageSize, ApiCallback<ResponseBankingDirectDebitAuthorisationList> _callback) Get Direct Debits For Specific Accounts (asynchronously) Obtain direct debit authorisations for a specified list of accounts
okhttp3.Call	listDirectDebitsSpecificAccountsCall(RequestAccountIds accountIds, Integer page, Integer pageSize, ApiCallback _callback) Build call for listDirectDebitsSpecificAccounts
ApiResponse<ResponseBankingDirectDebitAuthorisationList>	listDirectDebitsSpecificAccountsWithHttpInfo(RequestAccountIds accountIds, Integer page, Integer pageSize) Get Direct Debits For Specific Accounts Obtain direct debit authorisations for a specified list of accounts
ApiResponse<ResponseBankingDirectDebitAuthorisationList>	listDirectDebitsWithHttpInfo(String accountId, Integer page, Integer pageSize) Get Direct Debits For Account Obtain direct debit authorisations for a specific account
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

BankingDirectDebitsAPI

public BankingDirectDebitsAPI()

BankingDirectDebitsAPI

public BankingDirectDebitsAPI(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

listDirectDebitsCall

public okhttp3.Call listDirectDebitsCall(String accountId,
                                         Integer page,
                                         Integer pageSize,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for listDirectDebits

Parameters:

accountId - ID of the account to get direct debit authorisations for. Must have previously been returned by one of the account list end points. (required)

page - Page of results to request (standard pagination) (optional, default to 1)

pageSize - Page size to request. Default is 25 (standard pagination) (optional, default to 25)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object http.response.details

Status Code	Description	Response Headers
ResponseCode.OK	Success	-

listDirectDebits

public ResponseBankingDirectDebitAuthorisationList listDirectDebits(String accountId,
                                                                    Integer page,
                                                                    Integer pageSize)
                                                             throws ApiException

Get Direct Debits For Account Obtain direct debit authorisations for a specific account

Parameters:

accountId - ID of the account to get direct debit authorisations for. Must have previously been returned by one of the account list end points. (required)

page - Page of results to request (standard pagination) (optional, default to 1)

pageSize - Page size to request. Default is 25 (standard pagination) (optional, default to 25)

Returns:

ResponseBankingDirectDebitAuthorisationList

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details

Status Code	Description	Response Headers
ResponseCode.OK	Success	-

listDirectDebitsWithHttpInfo

public ApiResponse<ResponseBankingDirectDebitAuthorisationList> listDirectDebitsWithHttpInfo(String accountId,
                                                                                             Integer page,
                                                                                             Integer pageSize)
                                                                                      throws ApiException

Get Direct Debits For Account Obtain direct debit authorisations for a specific account

Parameters:

accountId - ID of the account to get direct debit authorisations for. Must have previously been returned by one of the account list end points. (required)

page - Page of results to request (standard pagination) (optional, default to 1)

pageSize - Page size to request. Default is 25 (standard pagination) (optional, default to 25)

Returns:

ApiResponse<ResponseBankingDirectDebitAuthorisationList>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details

Status Code	Description	Response Headers
ResponseCode.OK	Success	-

listDirectDebitsAsync

public okhttp3.Call listDirectDebitsAsync(String accountId,
                                          Integer page,
                                          Integer pageSize,
                                          ApiCallback<ResponseBankingDirectDebitAuthorisationList> _callback)
                                   throws ApiException

Get Direct Debits For Account (asynchronously) Obtain direct debit authorisations for a specific account

Parameters:

accountId - ID of the account to get direct debit authorisations for. Must have previously been returned by one of the account list end points. (required)

page - Page of results to request (standard pagination) (optional, default to 1)

pageSize - Page size to request. Default is 25 (standard pagination) (optional, default to 25)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object http.response.details

Status Code	Description	Response Headers
ResponseCode.OK	Success	-

listDirectDebitsSpecificAccountsCall

public okhttp3.Call listDirectDebitsSpecificAccountsCall(RequestAccountIds accountIds,
                                                         Integer page,
                                                         Integer pageSize,
                                                         ApiCallback _callback)
                                                  throws ApiException

Build call for listDirectDebitsSpecificAccounts

Parameters:

accountIds - Array of specific accountIds to obtain authorisations for (optional)

page - Page of results to request (standard pagination) (optional, default to 1)

pageSize - Page size to request. Default is 25 (standard pagination) (optional, default to 25)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object http.response.details

Status Code	Description	Response Headers
ResponseCode.OK	Success	-
ResponseCode.UNPROCESSABLE_ENTITY	The request was well formed but was unable to be processed due to business logic specific to the request	-

listDirectDebitsSpecificAccounts

public ResponseBankingDirectDebitAuthorisationList listDirectDebitsSpecificAccounts(RequestAccountIds accountIds,
                                                                                    Integer page,
                                                                                    Integer pageSize)
                                                                             throws ApiException

Get Direct Debits For Specific Accounts Obtain direct debit authorisations for a specified list of accounts

Parameters:

accountIds - Array of specific accountIds to obtain authorisations for (optional)

page - Page of results to request (standard pagination) (optional, default to 1)

pageSize - Page size to request. Default is 25 (standard pagination) (optional, default to 25)

Returns:

ResponseBankingDirectDebitAuthorisationList

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details

Status Code	Description	Response Headers
ResponseCode.OK	Success	-
ResponseCode.UNPROCESSABLE_ENTITY	The request was well formed but was unable to be processed due to business logic specific to the request	-

listDirectDebitsSpecificAccountsWithHttpInfo

public ApiResponse<ResponseBankingDirectDebitAuthorisationList> listDirectDebitsSpecificAccountsWithHttpInfo(RequestAccountIds accountIds,
                                                                                                             Integer page,
                                                                                                             Integer pageSize)
                                                                                                      throws ApiException

Get Direct Debits For Specific Accounts Obtain direct debit authorisations for a specified list of accounts

Parameters:

accountIds - Array of specific accountIds to obtain authorisations for (optional)

page - Page of results to request (standard pagination) (optional, default to 1)

pageSize - Page size to request. Default is 25 (standard pagination) (optional, default to 25)

Returns:

ApiResponse<ResponseBankingDirectDebitAuthorisationList>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details

Status Code	Description	Response Headers
ResponseCode.OK	Success	-
ResponseCode.UNPROCESSABLE_ENTITY	The request was well formed but was unable to be processed due to business logic specific to the request	-

listDirectDebitsSpecificAccountsAsync

public okhttp3.Call listDirectDebitsSpecificAccountsAsync(RequestAccountIds accountIds,
                                                          Integer page,
                                                          Integer pageSize,
                                                          ApiCallback<ResponseBankingDirectDebitAuthorisationList> _callback)
                                                   throws ApiException

Get Direct Debits For Specific Accounts (asynchronously) Obtain direct debit authorisations for a specified list of accounts

Parameters:

accountIds - Array of specific accountIds to obtain authorisations for (optional)

page - Page of results to request (standard pagination) (optional, default to 1)

pageSize - Page size to request. Default is 25 (standard pagination) (optional, default to 25)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object http.response.details

Status Code	Description	Response Headers
ResponseCode.OK	Success	-
ResponseCode.UNPROCESSABLE_ENTITY	The request was well formed but was unable to be processed due to business logic specific to the request	-