au.org.consumerdatastandards.client.api

Class BankingPayeesAPI

java.lang.Object

au.org.consumerdatastandards.client.api.BankingPayeesAPI

public class BankingPayeesAPI
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BankingPayeesAPI.ParamType

Constructor Summary

Constructors

Constructor and Description
BankingPayeesAPI()
BankingPayeesAPI(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
ResponseBankingPayeeById	getPayeeDetail(String payeeId) Get Payee Detail Obtain detailed information on a single payee
okhttp3.Call	getPayeeDetailAsync(String payeeId, ApiCallback<ResponseBankingPayeeById> _callback) Get Payee Detail (asynchronously) Obtain detailed information on a single payee
okhttp3.Call	getPayeeDetailCall(String payeeId, ApiCallback _callback) Build call for getPayeeDetail
ApiResponse<ResponseBankingPayeeById>	getPayeeDetailWithHttpInfo(String payeeId) Get Payee Detail Obtain detailed information on a single payee
ResponseBankingPayeeList	listPayees(Integer page, Integer pageSize, BankingPayeesAPI.ParamType type) Get Payees Obtain a list of pre-registered payees
okhttp3.Call	listPayeesAsync(Integer page, Integer pageSize, BankingPayeesAPI.ParamType type, ApiCallback<ResponseBankingPayeeList> _callback) Get Payees (asynchronously) Obtain a list of pre-registered payees
okhttp3.Call	listPayeesCall(Integer page, Integer pageSize, BankingPayeesAPI.ParamType type, ApiCallback _callback) Build call for listPayees
ApiResponse<ResponseBankingPayeeList>	listPayeesWithHttpInfo(Integer page, Integer pageSize, BankingPayeesAPI.ParamType type) Get Payees Obtain a list of pre-registered payees
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

BankingPayeesAPI

public BankingPayeesAPI()

BankingPayeesAPI

public BankingPayeesAPI(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getPayeeDetailCall

public okhttp3.Call getPayeeDetailCall(String payeeId,
                                       ApiCallback _callback)
                                throws ApiException

Build call for getPayeeDetail

Parameters:

payeeId - The ID used to locate the details of a particular payee (required)

_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	-

getPayeeDetail

public ResponseBankingPayeeById getPayeeDetail(String payeeId)
                                        throws ApiException

Get Payee Detail Obtain detailed information on a single payee

Parameters:

payeeId - The ID used to locate the details of a particular payee (required)

Returns:

ResponseBankingPayeeById

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	-

getPayeeDetailWithHttpInfo

public ApiResponse<ResponseBankingPayeeById> getPayeeDetailWithHttpInfo(String payeeId)
                                                                 throws ApiException

Get Payee Detail Obtain detailed information on a single payee

Parameters:

payeeId - The ID used to locate the details of a particular payee (required)

Returns:

ApiResponse<ResponseBankingPayeeById>

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	-

getPayeeDetailAsync

public okhttp3.Call getPayeeDetailAsync(String payeeId,
                                        ApiCallback<ResponseBankingPayeeById> _callback)
                                 throws ApiException

Get Payee Detail (asynchronously) Obtain detailed information on a single payee

Parameters:

payeeId - The ID used to locate the details of a particular payee (required)

_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	-

listPayeesCall

public okhttp3.Call listPayeesCall(Integer page,
                                   Integer pageSize,
                                   BankingPayeesAPI.ParamType type,
                                   ApiCallback _callback)
                            throws ApiException

Build call for listPayees

Parameters:

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)

type - Filter on the payee type field. In addition to normal type field values, ALL can be specified to retrieve all payees. If absent the assumed value is ALL (optional, default to ALL)

_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	-

listPayees

public ResponseBankingPayeeList listPayees(Integer page,
                                           Integer pageSize,
                                           BankingPayeesAPI.ParamType type)
                                    throws ApiException

Get Payees Obtain a list of pre-registered payees

Parameters:

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)

type - Filter on the payee type field. In addition to normal type field values, ALL can be specified to retrieve all payees. If absent the assumed value is ALL (optional, default to ALL)

Returns:

ResponseBankingPayeeList

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	-

listPayeesWithHttpInfo

public ApiResponse<ResponseBankingPayeeList> listPayeesWithHttpInfo(Integer page,
                                                                    Integer pageSize,
                                                                    BankingPayeesAPI.ParamType type)
                                                             throws ApiException

Get Payees Obtain a list of pre-registered payees

Parameters:

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)

type - Filter on the payee type field. In addition to normal type field values, ALL can be specified to retrieve all payees. If absent the assumed value is ALL (optional, default to ALL)

Returns:

ApiResponse<ResponseBankingPayeeList>

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	-

listPayeesAsync

public okhttp3.Call listPayeesAsync(Integer page,
                                    Integer pageSize,
                                    BankingPayeesAPI.ParamType type,
                                    ApiCallback<ResponseBankingPayeeList> _callback)
                             throws ApiException

Get Payees (asynchronously) Obtain a list of pre-registered payees

Parameters:

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)

type - Filter on the payee type field. In addition to normal type field values, ALL can be specified to retrieve all payees. If absent the assumed value is ALL (optional, default to ALL)

_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	-