com.bymdev.voucherhub.api

Class VendorResourceApi

java.lang.Object

com.bymdev.voucherhub.api.VendorResourceApi

public class VendorResourceApi
extends Object

Constructor Summary

Constructors

Constructor and Description
VendorResourceApi()
VendorResourceApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
List<VendorDetailDTO>	getAllVendors(String query, Integer size, Integer page, String sortBy, String sortOrder) getAllVendors Required permissions: CAN_GET_VENDORS
com.squareup.okhttp.Call	getAllVendorsAsync(String query, Integer size, Integer page, String sortBy, String sortOrder, ApiCallback<List<VendorDetailDTO>> callback) getAllVendors (asynchronously) Required permissions: CAN_GET_VENDORS
com.squareup.okhttp.Call	getAllVendorsCall(String query, Integer size, Integer page, String sortBy, String sortOrder, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getAllVendors
ApiResponse<List<VendorDetailDTO>>	getAllVendorsWithHttpInfo(String query, Integer size, Integer page, String sortBy, String sortOrder) getAllVendors Required permissions: CAN_GET_VENDORS
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

VendorResourceApi

public VendorResourceApi()

VendorResourceApi

public VendorResourceApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getAllVendorsCall

public com.squareup.okhttp.Call getAllVendorsCall(String query,
                                                  Integer size,
                                                  Integer page,
                                                  String sortBy,
                                                  String sortOrder,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException

Build call for getAllVendors

Parameters:

query - query text (optional)

size - quantity of listed records on page (optional)

page - listing starts from page value (optional)

sortBy - sort by (optional)

sortOrder - sort order (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getAllVendors

public List<VendorDetailDTO> getAllVendors(String query,
                                           Integer size,
                                           Integer page,
                                           String sortBy,
                                           String sortOrder)
                                    throws ApiException

getAllVendors Required permissions: CAN_GET_VENDORS

Parameters:

query - query text (optional)

size - quantity of listed records on page (optional)

page - listing starts from page value (optional)

sortBy - sort by (optional)

sortOrder - sort order (optional)

Returns:

java.util.List<VendorDetailDTO>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getAllVendorsWithHttpInfo

public ApiResponse<List<VendorDetailDTO>> getAllVendorsWithHttpInfo(String query,
                                                                    Integer size,
                                                                    Integer page,
                                                                    String sortBy,
                                                                    String sortOrder)
                                                             throws ApiException

getAllVendors Required permissions: CAN_GET_VENDORS

Parameters:

query - query text (optional)

size - quantity of listed records on page (optional)

page - listing starts from page value (optional)

sortBy - sort by (optional)

sortOrder - sort order (optional)

Returns:

ApiResponse<java.util.List<VendorDetailDTO>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getAllVendorsAsync

public com.squareup.okhttp.Call getAllVendorsAsync(String query,
                                                   Integer size,
                                                   Integer page,
                                                   String sortBy,
                                                   String sortOrder,
                                                   ApiCallback<List<VendorDetailDTO>> callback)
                                            throws ApiException

getAllVendors (asynchronously) Required permissions: CAN_GET_VENDORS

Parameters:

query - query text (optional)

size - quantity of listed records on page (optional)

page - listing starts from page value (optional)

sortBy - sort by (optional)

sortOrder - sort order (optional)

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