io.gate.gateapi.api

Class MarginApi.APIlistCrossMarginLoansRequest

java.lang.Object

io.gate.gateapi.api.MarginApi.APIlistCrossMarginLoansRequest

Enclosing class:

MarginApi

public class MarginApi.APIlistCrossMarginLoansRequest
extends Object

Method Summary

Modifier and Type	Method and Description
okhttp3.Call	buildCall(ApiCallback _callback) Build call for listCrossMarginLoans
MarginApi.APIlistCrossMarginLoansRequest	currency(String currency) Set currency
List<CrossMarginLoan>	execute() Execute listCrossMarginLoans request
okhttp3.Call	executeAsync(ApiCallback<List<CrossMarginLoan>> _callback) Execute listCrossMarginLoans request (asynchronously)
ApiResponse<List<CrossMarginLoan>>	executeWithHttpInfo() Execute listCrossMarginLoans request with HTTP info returned
MarginApi.APIlistCrossMarginLoansRequest	limit(Integer limit) Set limit
MarginApi.APIlistCrossMarginLoansRequest	offset(Integer offset) Set offset
MarginApi.APIlistCrossMarginLoansRequest	reverse(Boolean reverse) Set reverse

Methods inherited from class java.lang.Object

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

Method Detail

currency

public MarginApi.APIlistCrossMarginLoansRequest currency(String currency)

Set currency

Parameters:

currency - Filter by currency (optional)

Returns:

APIlistCrossMarginLoansRequest

limit

public MarginApi.APIlistCrossMarginLoansRequest limit(Integer limit)

Set limit

Parameters:

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

Returns:

APIlistCrossMarginLoansRequest

offset

public MarginApi.APIlistCrossMarginLoansRequest offset(Integer offset)

Set offset

Parameters:

offset - List offset, starting from 0 (optional, default to 0)

Returns:

APIlistCrossMarginLoansRequest

reverse

public MarginApi.APIlistCrossMarginLoansRequest reverse(Boolean reverse)

Set reverse

Parameters:

reverse - Whether to sort in descending order, which is the default. Set `reverse=false` to return ascending results (optional, default to true)

Returns:

APIlistCrossMarginLoansRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for listCrossMarginLoans

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	Successfully retrieved	-

execute

public List<CrossMarginLoan> execute()
                              throws ApiException

Execute listCrossMarginLoans request

Returns:

List<CrossMarginLoan>

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	Successfully retrieved	-

executeWithHttpInfo

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

Execute listCrossMarginLoans request with HTTP info returned

Returns:

ApiResponse<List<CrossMarginLoan>>

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	Successfully retrieved	-

executeAsync

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

Execute listCrossMarginLoans 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	Successfully retrieved	-