io.gate.gateapi.api

Class OptionsApi.APIlistOptionsOrdersRequest

java.lang.Object

io.gate.gateapi.api.OptionsApi.APIlistOptionsOrdersRequest

Enclosing class:

OptionsApi

public class OptionsApi.APIlistOptionsOrdersRequest
extends Object

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

contract

public OptionsApi.APIlistOptionsOrdersRequest contract(String contract)

Set contract

Parameters:

contract - Options contract name (optional)

Returns:

APIlistOptionsOrdersRequest

underlying

public OptionsApi.APIlistOptionsOrdersRequest underlying(String underlying)

Set underlying

Parameters:

underlying - Underlying (optional)

Returns:

APIlistOptionsOrdersRequest

limit

public OptionsApi.APIlistOptionsOrdersRequest limit(Integer limit)

Set limit

Parameters:

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

Returns:

APIlistOptionsOrdersRequest

offset

public OptionsApi.APIlistOptionsOrdersRequest offset(Integer offset)

Set offset

Parameters:

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

Returns:

APIlistOptionsOrdersRequest

from

public OptionsApi.APIlistOptionsOrdersRequest from(Long from)

Set from

Parameters:

from - Start timestamp (optional)

Returns:

APIlistOptionsOrdersRequest

to

public OptionsApi.APIlistOptionsOrdersRequest to(Long to)

Set to

Parameters:

to - End timestamp (optional)

Returns:

APIlistOptionsOrdersRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for listOptionsOrders

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

Execute listOptionsOrders request

Returns:

List<OptionsOrder>

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

Execute listOptionsOrders request with HTTP info returned

Returns:

ApiResponse<List<OptionsOrder>>

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

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