Package api

Class MerchantsApi.APIlistMerchantsRequest

java.lang.Object

api.MerchantsApi.APIlistMerchantsRequest

Enclosing class:

MerchantsApi

public class MerchantsApi.APIlistMerchantsRequest
extends Object

Method Summary

Modifier and Type	Method	Description
MerchantsApi.APIlistMerchantsRequest	afterCursor(String afterCursor)	Set afterCursor
MerchantsApi.APIlistMerchantsRequest	beforeCursor(String beforeCursor)	Set beforeCursor
okhttp3.Call	buildCall(ApiCallback _callback)	Build call for listMerchants
MerchantsApi.APIlistMerchantsRequest	createdAtGte(String createdAtGte)	Set createdAtGte
MerchantsApi.APIlistMerchantsRequest	createdAtLte(String createdAtLte)	Set createdAtLte
MerchantsList	execute()	Execute listMerchants request
okhttp3.Call	executeAsync(ApiCallback<MerchantsList> _callback)	Execute listMerchants request (asynchronously)
ApiResponse<MerchantsList>	executeWithHttpInfo()	Execute listMerchants request with HTTP info returned
MerchantsApi.APIlistMerchantsRequest	id(String id)	Set id
MerchantsApi.APIlistMerchantsRequest	limit(Long limit)	Set limit
MerchantsApi.APIlistMerchantsRequest	sort(String sort)	Set sort

Methods inherited from class java.lang.Object

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

Method Detail

id

public MerchantsApi.APIlistMerchantsRequest id(String id)

Set id

Parameters:

id - Filter by `id`. (optional)

Returns:

APIlistMerchantsRequest

createdAtGte

public MerchantsApi.APIlistMerchantsRequest createdAtGte(String createdAtGte)

Set createdAtGte

Parameters:

createdAtGte - Filter where `created_at` is after the given date. (optional)

Returns:

APIlistMerchantsRequest

createdAtLte

public MerchantsApi.APIlistMerchantsRequest createdAtLte(String createdAtLte)

Set createdAtLte

Parameters:

createdAtLte - Filter where `created_at` is before the given date. (optional)

Returns:

APIlistMerchantsRequest

afterCursor

public MerchantsApi.APIlistMerchantsRequest afterCursor(String afterCursor)

Set afterCursor

Parameters:

afterCursor - Return every resource created after the cursor value. (optional)

Returns:

APIlistMerchantsRequest

beforeCursor

public MerchantsApi.APIlistMerchantsRequest beforeCursor(String beforeCursor)

Set beforeCursor

Parameters:

beforeCursor - Return every resource created before the cursor value. (optional)

Returns:

APIlistMerchantsRequest

limit

public MerchantsApi.APIlistMerchantsRequest limit(Long limit)

Set limit

Parameters:

limit - The numbers of items to return. (optional)

Returns:

APIlistMerchantsRequest

sort

public MerchantsApi.APIlistMerchantsRequest sort(String sort)

Set sort

Parameters:

sort - Specify key to be used for sorting the collection. (optional)

Returns:

APIlistMerchantsRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for listMerchants

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 of Merchants objects	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

execute

public MerchantsList execute()
                      throws ApiException

Execute listMerchants request

Returns:

MerchantsList

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 of Merchants objects	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

executeWithHttpInfo

public ApiResponse<MerchantsList> executeWithHttpInfo()
                                               throws ApiException

Execute listMerchants request with HTTP info returned

Returns:

ApiResponse<MerchantsList>

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 of Merchants objects	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

executeAsync

public okhttp3.Call executeAsync(ApiCallback<MerchantsList> _callback)
                          throws ApiException

Execute listMerchants 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 of Merchants objects	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -