io.gate.gateapi.api

Class DeliveryApi.APIlistDeliveryLiquidatesRequest

java.lang.Object

io.gate.gateapi.api.DeliveryApi.APIlistDeliveryLiquidatesRequest

Enclosing class:

DeliveryApi

public class DeliveryApi.APIlistDeliveryLiquidatesRequest
extends Object

Method Summary

Modifier and Type	Method and Description
DeliveryApi.APIlistDeliveryLiquidatesRequest	at(Integer at) Set at
okhttp3.Call	buildCall(ApiCallback _callback) Build call for listDeliveryLiquidates
DeliveryApi.APIlistDeliveryLiquidatesRequest	contract(String contract) Set contract
List<FuturesLiquidate>	execute() Execute listDeliveryLiquidates request
okhttp3.Call	executeAsync(ApiCallback<List<FuturesLiquidate>> _callback) Execute listDeliveryLiquidates request (asynchronously)
ApiResponse<List<FuturesLiquidate>>	executeWithHttpInfo() Execute listDeliveryLiquidates request with HTTP info returned
DeliveryApi.APIlistDeliveryLiquidatesRequest	limit(Integer limit) Set limit

Methods inherited from class java.lang.Object

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

Method Detail

contract

public DeliveryApi.APIlistDeliveryLiquidatesRequest contract(String contract)

Set contract

Parameters:

contract - Futures contract (optional)

Returns:

APIlistDeliveryLiquidatesRequest

limit

public DeliveryApi.APIlistDeliveryLiquidatesRequest limit(Integer limit)

Set limit

Parameters:

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

Returns:

APIlistDeliveryLiquidatesRequest

at

public DeliveryApi.APIlistDeliveryLiquidatesRequest at(Integer at)

Set at

Parameters:

at - Specify a liquidation timestamp (optional, default to 0)

Returns:

APIlistDeliveryLiquidatesRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for listDeliveryLiquidates

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<FuturesLiquidate> execute()
                               throws ApiException

Execute listDeliveryLiquidates request

Returns:

List<FuturesLiquidate>

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<FuturesLiquidate>> executeWithHttpInfo()
                                                        throws ApiException

Execute listDeliveryLiquidates request with HTTP info returned

Returns:

ApiResponse<List<FuturesLiquidate>>

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<FuturesLiquidate>> _callback)
                          throws ApiException

Execute listDeliveryLiquidates 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	-