io.gate.gateapi.api

Class RebateApi.APIagencyCommissionsHistoryRequest

java.lang.Object

io.gate.gateapi.api.RebateApi.APIagencyCommissionsHistoryRequest

Enclosing class:

RebateApi

public class RebateApi.APIagencyCommissionsHistoryRequest
extends Object

Method Summary

Modifier and Type	Method and Description
okhttp3.Call	buildCall(ApiCallback _callback) Build call for agencyCommissionsHistory
RebateApi.APIagencyCommissionsHistoryRequest	currency(String currency) Set currency
List<AgencyCommissionHistory>	execute() Execute agencyCommissionsHistory request
okhttp3.Call	executeAsync(ApiCallback<List<AgencyCommissionHistory>> _callback) Execute agencyCommissionsHistory request (asynchronously)
ApiResponse<List<AgencyCommissionHistory>>	executeWithHttpInfo() Execute agencyCommissionsHistory request with HTTP info returned
RebateApi.APIagencyCommissionsHistoryRequest	from(Long from) Set from
RebateApi.APIagencyCommissionsHistoryRequest	limit(Integer limit) Set limit
RebateApi.APIagencyCommissionsHistoryRequest	offset(Integer offset) Set offset
RebateApi.APIagencyCommissionsHistoryRequest	to(Long to) Set to
RebateApi.APIagencyCommissionsHistoryRequest	userId(String userId) Set userId

Methods inherited from class java.lang.Object

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

Method Detail

currency

public RebateApi.APIagencyCommissionsHistoryRequest currency(String currency)

Set currency

Parameters:

currency - Filter by currency. Return all currency records if not specified (optional)

Returns:

APIagencyCommissionsHistoryRequest

userId

public RebateApi.APIagencyCommissionsHistoryRequest userId(String userId)

Set userId

Parameters:

userId - User ID. If not specified, all user records will be returned (optional)

Returns:

APIagencyCommissionsHistoryRequest

from

public RebateApi.APIagencyCommissionsHistoryRequest from(Long from)

Set from

Parameters:

from - Time range beginning, default to 7 days before current time (optional)

Returns:

APIagencyCommissionsHistoryRequest

to

public RebateApi.APIagencyCommissionsHistoryRequest to(Long to)

Set to

Parameters:

to - Time range ending, default to current time (optional)

Returns:

APIagencyCommissionsHistoryRequest

limit

public RebateApi.APIagencyCommissionsHistoryRequest limit(Integer limit)

Set limit

Parameters:

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

Returns:

APIagencyCommissionsHistoryRequest

offset

public RebateApi.APIagencyCommissionsHistoryRequest offset(Integer offset)

Set offset

Parameters:

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

Returns:

APIagencyCommissionsHistoryRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for agencyCommissionsHistory

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

Execute agencyCommissionsHistory request

Returns:

List<AgencyCommissionHistory>

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

Execute agencyCommissionsHistory request with HTTP info returned

Returns:

ApiResponse<List<AgencyCommissionHistory>>

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

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