io.gate.gateapi.api

Class DeliveryApi.APIlistDeliverySettlementsRequest

java.lang.Object

io.gate.gateapi.api.DeliveryApi.APIlistDeliverySettlementsRequest

Enclosing class:

DeliveryApi

public class DeliveryApi.APIlistDeliverySettlementsRequest
extends Object

Method Summary

Modifier and Type	Method and Description
DeliveryApi.APIlistDeliverySettlementsRequest	at(Integer at) Set at
okhttp3.Call	buildCall(ApiCallback _callback) Build call for listDeliverySettlements
DeliveryApi.APIlistDeliverySettlementsRequest	contract(String contract) Set contract
List<DeliverySettlement>	execute() Execute listDeliverySettlements request
okhttp3.Call	executeAsync(ApiCallback<List<DeliverySettlement>> _callback) Execute listDeliverySettlements request (asynchronously)
ApiResponse<List<DeliverySettlement>>	executeWithHttpInfo() Execute listDeliverySettlements request with HTTP info returned
DeliveryApi.APIlistDeliverySettlementsRequest	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.APIlistDeliverySettlementsRequest contract(String contract)

Set contract

Parameters:

contract - Futures contract (optional)

Returns:

APIlistDeliverySettlementsRequest

limit

public DeliveryApi.APIlistDeliverySettlementsRequest limit(Integer limit)

Set limit

Parameters:

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

Returns:

APIlistDeliverySettlementsRequest

at

public DeliveryApi.APIlistDeliverySettlementsRequest at(Integer at)

Set at

Parameters:

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

Returns:

APIlistDeliverySettlementsRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for listDeliverySettlements

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

Execute listDeliverySettlements request

Returns:

List<DeliverySettlement>

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

Execute listDeliverySettlements request with HTTP info returned

Returns:

ApiResponse<List<DeliverySettlement>>

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

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