io.gate.gateapi.api

Class MarginApi.APIlistLoansRequest

java.lang.Object

io.gate.gateapi.api.MarginApi.APIlistLoansRequest

Enclosing class:

MarginApi

public class MarginApi.APIlistLoansRequest
extends Object

Method Summary

Modifier and Type	Method and Description
okhttp3.Call	buildCall(ApiCallback _callback) Build call for listLoans
MarginApi.APIlistLoansRequest	currency(String currency) Set currency
MarginApi.APIlistLoansRequest	currencyPair(String currencyPair) Set currencyPair
List<Loan>	execute() Execute listLoans request
okhttp3.Call	executeAsync(ApiCallback<List<Loan>> _callback) Execute listLoans request (asynchronously)
ApiResponse<List<Loan>>	executeWithHttpInfo() Execute listLoans request with HTTP info returned
MarginApi.APIlistLoansRequest	limit(Integer limit) Set limit
MarginApi.APIlistLoansRequest	page(Integer page) Set page
MarginApi.APIlistLoansRequest	reverseSort(Boolean reverseSort) Set reverseSort
MarginApi.APIlistLoansRequest	sortBy(String sortBy) Set sortBy

Methods inherited from class java.lang.Object

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

Method Detail

currency

public MarginApi.APIlistLoansRequest currency(String currency)

Set currency

Parameters:

currency - Retrieve data of the specified currency (optional)

Returns:

APIlistLoansRequest

currencyPair

public MarginApi.APIlistLoansRequest currencyPair(String currencyPair)

Set currencyPair

Parameters:

currencyPair - Currency pair (optional)

Returns:

APIlistLoansRequest

sortBy

public MarginApi.APIlistLoansRequest sortBy(String sortBy)

Set sortBy

Parameters:

sortBy - Specify which field is used to sort. `create_time` or `rate` is supported. Default to `create_time` (optional)

Returns:

APIlistLoansRequest

reverseSort

public MarginApi.APIlistLoansRequest reverseSort(Boolean reverseSort)

Set reverseSort

Parameters:

reverseSort - Whether to sort in descending order. Default to `true` (optional)

Returns:

APIlistLoansRequest

page

public MarginApi.APIlistLoansRequest page(Integer page)

Set page

Parameters:

page - Page number (optional, default to 1)

Returns:

APIlistLoansRequest

limit

public MarginApi.APIlistLoansRequest limit(Integer limit)

Set limit

Parameters:

limit - Maximum number of records to be returned in a single list (optional, default to 100)

Returns:

APIlistLoansRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for listLoans

Parameters:

_callback - ApiCallback API callback

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

execute

public List<Loan> execute()
                   throws ApiException

Execute listLoans request

Returns:

List<Loan>

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
200	List retrieved	-

executeWithHttpInfo

public ApiResponse<List<Loan>> executeWithHttpInfo()
                                            throws ApiException

Execute listLoans request with HTTP info returned

Returns:

ApiResponse<List<Loan>>

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
200	List retrieved	-

executeAsync

public okhttp3.Call executeAsync(ApiCallback<List<Loan>> _callback)
                          throws ApiException

Execute listLoans request (asynchronously)

Parameters:

_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
200	List retrieved	-