io.gate.gateapi.api

Class OptionsApi.APIlistOptionsSettlementsRequest

java.lang.Object

io.gate.gateapi.api.OptionsApi.APIlistOptionsSettlementsRequest

Enclosing class:

OptionsApi

public class OptionsApi.APIlistOptionsSettlementsRequest
extends Object

Method Summary

Modifier and Type	Method and Description
okhttp3.Call	buildCall(ApiCallback _callback) Build call for listOptionsSettlements
List<OptionsSettlement>	execute() Execute listOptionsSettlements request
okhttp3.Call	executeAsync(ApiCallback<List<OptionsSettlement>> _callback) Execute listOptionsSettlements request (asynchronously)
ApiResponse<List<OptionsSettlement>>	executeWithHttpInfo() Execute listOptionsSettlements request with HTTP info returned
OptionsApi.APIlistOptionsSettlementsRequest	from(Long from) Set from
OptionsApi.APIlistOptionsSettlementsRequest	limit(Integer limit) Set limit
OptionsApi.APIlistOptionsSettlementsRequest	offset(Integer offset) Set offset
OptionsApi.APIlistOptionsSettlementsRequest	to(Long to) Set to

Methods inherited from class java.lang.Object

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

Method Detail

limit

public OptionsApi.APIlistOptionsSettlementsRequest limit(Integer limit)

Set limit

Parameters:

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

Returns:

APIlistOptionsSettlementsRequest

offset

public OptionsApi.APIlistOptionsSettlementsRequest offset(Integer offset)

Set offset

Parameters:

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

Returns:

APIlistOptionsSettlementsRequest

from

public OptionsApi.APIlistOptionsSettlementsRequest from(Long from)

Set from

Parameters:

from - Start timestamp (optional)

Returns:

APIlistOptionsSettlementsRequest

to

public OptionsApi.APIlistOptionsSettlementsRequest to(Long to)

Set to

Parameters:

to - End timestamp (optional)

Returns:

APIlistOptionsSettlementsRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for listOptionsSettlements

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

Execute listOptionsSettlements request

Returns:

List<OptionsSettlement>

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

Execute listOptionsSettlements request with HTTP info returned

Returns:

ApiResponse<List<OptionsSettlement>>

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

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