com.bymdev.voucherhub.api

Class OrderRecordResourceApi

java.lang.Object

com.bymdev.voucherhub.api.OrderRecordResourceApi

public class OrderRecordResourceApi
extends Object

Constructor Summary

Constructors

Constructor and Description
OrderRecordResourceApi()
OrderRecordResourceApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
OrderRecordDTO	createOrderRecord(OrderRecordDTO orderRecordDto) createOrderRecord 1) Cellphone number must be in E.164 format;<br/>2) «PricePaid» is a price for 1 product;<br/>3) Required permissions: CAN_CREATE_ORDER.
com.squareup.okhttp.Call	createOrderRecordAsync(OrderRecordDTO orderRecordDto, ApiCallback<OrderRecordDTO> callback) createOrderRecord (asynchronously) 1) Cellphone number must be in E.164 format;<br/>2) «PricePaid» is a price for 1 product;<br/>3) Required permissions: CAN_CREATE_ORDER.
com.squareup.okhttp.Call	createOrderRecordCall(OrderRecordDTO orderRecordDto, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for createOrderRecord
ApiResponse<OrderRecordDTO>	createOrderRecordWithHttpInfo(OrderRecordDTO orderRecordDto) createOrderRecord 1) Cellphone number must be in E.164 format;<br/>2) «PricePaid» is a price for 1 product;<br/>3) Required permissions: CAN_CREATE_ORDER.
List<OrderRecordExtendDTO>	getAllOrderRecords(String query, String from, String till, String timeZone, String deliveryMethod, String deliveryStatus, Integer size, Integer page, String sortBy, String sortOrder) getAllOrderRecords Required permissions: CAN_GET_ORDERS
com.squareup.okhttp.Call	getAllOrderRecordsAsync(String query, String from, String till, String timeZone, String deliveryMethod, String deliveryStatus, Integer size, Integer page, String sortBy, String sortOrder, ApiCallback<List<OrderRecordExtendDTO>> callback) getAllOrderRecords (asynchronously) Required permissions: CAN_GET_ORDERS
com.squareup.okhttp.Call	getAllOrderRecordsCall(String query, String from, String till, String timeZone, String deliveryMethod, String deliveryStatus, Integer size, Integer page, String sortBy, String sortOrder, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getAllOrderRecords
ApiResponse<List<OrderRecordExtendDTO>>	getAllOrderRecordsWithHttpInfo(String query, String from, String till, String timeZone, String deliveryMethod, String deliveryStatus, Integer size, Integer page, String sortBy, String sortOrder) getAllOrderRecords Required permissions: CAN_GET_ORDERS
ApiClient	getApiClient()
OrderRecordExtendDTO	getOrderRecord(Long id) getOrderRecord Required permissions: CAN_GET_ORDERS
com.squareup.okhttp.Call	getOrderRecordAsync(Long id, ApiCallback<OrderRecordExtendDTO> callback) getOrderRecord (asynchronously) Required permissions: CAN_GET_ORDERS
com.squareup.okhttp.Call	getOrderRecordCall(Long id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getOrderRecord
ApiResponse<OrderRecordExtendDTO>	getOrderRecordWithHttpInfo(Long id) getOrderRecord Required permissions: CAN_GET_ORDERS
GenericStatusDTO	mergeVouchers(Long orderId, String newVoucherId) mergeVouchers Replaces voucher IDs of order items with new voucher ID in the specified order.
com.squareup.okhttp.Call	mergeVouchersAsync(Long orderId, String newVoucherId, ApiCallback<GenericStatusDTO> callback) mergeVouchers (asynchronously) Replaces voucher IDs of order items with new voucher ID in the specified order.
com.squareup.okhttp.Call	mergeVouchersCall(Long orderId, String newVoucherId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for mergeVouchers
ApiResponse<GenericStatusDTO>	mergeVouchersWithHttpInfo(Long orderId, String newVoucherId) mergeVouchers Replaces voucher IDs of order items with new voucher ID in the specified order.
void	setApiClient(ApiClient apiClient)
OrderRecordDTO	updateOrderRecord(OrderRecordDTO orderRecordDto) updateOrderRecord 1) Cellphone number must be in E.164 format;<br/>2) «PricePaid» is a price for 1 product;<br/>3) Required permissions: CAN_EDIT_ORDER.
com.squareup.okhttp.Call	updateOrderRecordAsync(OrderRecordDTO orderRecordDto, ApiCallback<OrderRecordDTO> callback) updateOrderRecord (asynchronously) 1) Cellphone number must be in E.164 format;<br/>2) «PricePaid» is a price for 1 product;<br/>3) Required permissions: CAN_EDIT_ORDER.
com.squareup.okhttp.Call	updateOrderRecordCall(OrderRecordDTO orderRecordDto, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for updateOrderRecord
ApiResponse<OrderRecordDTO>	updateOrderRecordWithHttpInfo(OrderRecordDTO orderRecordDto) updateOrderRecord 1) Cellphone number must be in E.164 format;<br/>2) «PricePaid» is a price for 1 product;<br/>3) Required permissions: CAN_EDIT_ORDER.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrderRecordResourceApi

public OrderRecordResourceApi()

OrderRecordResourceApi

public OrderRecordResourceApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createOrderRecordCall

public com.squareup.okhttp.Call createOrderRecordCall(OrderRecordDTO orderRecordDto,
                                                      ProgressResponseBody.ProgressListener progressListener,
                                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                               throws ApiException

Build call for createOrderRecord

Parameters:

orderRecordDto - the OrderRecord Dto (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createOrderRecord

public OrderRecordDTO createOrderRecord(OrderRecordDTO orderRecordDto)
                                 throws ApiException

createOrderRecord 1) Cellphone number must be in E.164 format;<br/>2) «PricePaid» is a price for 1 product;<br/>3) Required permissions: CAN_CREATE_ORDER.

Parameters:

orderRecordDto - the OrderRecord Dto (required)

Returns:

OrderRecordDTO

Throws:

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

createOrderRecordWithHttpInfo

public ApiResponse<OrderRecordDTO> createOrderRecordWithHttpInfo(OrderRecordDTO orderRecordDto)
                                                          throws ApiException

createOrderRecord 1) Cellphone number must be in E.164 format;<br/>2) «PricePaid» is a price for 1 product;<br/>3) Required permissions: CAN_CREATE_ORDER.

Parameters:

orderRecordDto - the OrderRecord Dto (required)

Returns:

ApiResponse<OrderRecordDTO>

Throws:

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

createOrderRecordAsync

public com.squareup.okhttp.Call createOrderRecordAsync(OrderRecordDTO orderRecordDto,
                                                       ApiCallback<OrderRecordDTO> callback)
                                                throws ApiException

createOrderRecord (asynchronously) 1) Cellphone number must be in E.164 format;<br/>2) «PricePaid» is a price for 1 product;<br/>3) Required permissions: CAN_CREATE_ORDER.

Parameters:

orderRecordDto - the OrderRecord Dto (required)

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

getAllOrderRecordsCall

public com.squareup.okhttp.Call getAllOrderRecordsCall(String query,
                                                       String from,
                                                       String till,
                                                       String timeZone,
                                                       String deliveryMethod,
                                                       String deliveryStatus,
                                                       Integer size,
                                                       Integer page,
                                                       String sortBy,
                                                       String sortOrder,
                                                       ProgressResponseBody.ProgressListener progressListener,
                                                       ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                throws ApiException

Build call for getAllOrderRecords

Parameters:

query - query text (optional)

from - Begin the of date range, format: YYYY-MM-DD (e.g. 2016-01-25) (optional)

till - End the of date range, format: YYYY-MM-DD (e.g. 2016-01-25) (optional)

timeZone - A timezone for date/time representation. Example: America/Chicago or EST. If zone is not set, then UTC timezone will be used. (optional)

deliveryMethod - delivery method (optional)

deliveryStatus - status of delivery (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

getAllOrderRecords

public List<OrderRecordExtendDTO> getAllOrderRecords(String query,
                                                     String from,
                                                     String till,
                                                     String timeZone,
                                                     String deliveryMethod,
                                                     String deliveryStatus,
                                                     Integer size,
                                                     Integer page,
                                                     String sortBy,
                                                     String sortOrder)
                                              throws ApiException

getAllOrderRecords Required permissions: CAN_GET_ORDERS

Parameters:

query - query text (optional)

from - Begin the of date range, format: YYYY-MM-DD (e.g. 2016-01-25) (optional)

till - End the of date range, format: YYYY-MM-DD (e.g. 2016-01-25) (optional)

timeZone - A timezone for date/time representation. Example: America/Chicago or EST. If zone is not set, then UTC timezone will be used. (optional)

deliveryMethod - delivery method (optional)

deliveryStatus - status of delivery (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<OrderRecordExtendDTO>

Throws:

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

getAllOrderRecordsWithHttpInfo

public ApiResponse<List<OrderRecordExtendDTO>> getAllOrderRecordsWithHttpInfo(String query,
                                                                              String from,
                                                                              String till,
                                                                              String timeZone,
                                                                              String deliveryMethod,
                                                                              String deliveryStatus,
                                                                              Integer size,
                                                                              Integer page,
                                                                              String sortBy,
                                                                              String sortOrder)
                                                                       throws ApiException

getAllOrderRecords Required permissions: CAN_GET_ORDERS

Parameters:

query - query text (optional)

from - Begin the of date range, format: YYYY-MM-DD (e.g. 2016-01-25) (optional)

till - End the of date range, format: YYYY-MM-DD (e.g. 2016-01-25) (optional)

timeZone - A timezone for date/time representation. Example: America/Chicago or EST. If zone is not set, then UTC timezone will be used. (optional)

deliveryMethod - delivery method (optional)

deliveryStatus - status of delivery (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<OrderRecordExtendDTO>>

Throws:

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

getAllOrderRecordsAsync

public com.squareup.okhttp.Call getAllOrderRecordsAsync(String query,
                                                        String from,
                                                        String till,
                                                        String timeZone,
                                                        String deliveryMethod,
                                                        String deliveryStatus,
                                                        Integer size,
                                                        Integer page,
                                                        String sortBy,
                                                        String sortOrder,
                                                        ApiCallback<List<OrderRecordExtendDTO>> callback)
                                                 throws ApiException

getAllOrderRecords (asynchronously) Required permissions: CAN_GET_ORDERS

Parameters:

query - query text (optional)

from - Begin the of date range, format: YYYY-MM-DD (e.g. 2016-01-25) (optional)

till - End the of date range, format: YYYY-MM-DD (e.g. 2016-01-25) (optional)

timeZone - A timezone for date/time representation. Example: America/Chicago or EST. If zone is not set, then UTC timezone will be used. (optional)

deliveryMethod - delivery method (optional)

deliveryStatus - status of delivery (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

getOrderRecordCall

public com.squareup.okhttp.Call getOrderRecordCall(Long id,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for getOrderRecord

Parameters:

id - the internal id of order (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getOrderRecord

public OrderRecordExtendDTO getOrderRecord(Long id)
                                    throws ApiException

getOrderRecord Required permissions: CAN_GET_ORDERS

Parameters:

id - the internal id of order (required)

Returns:

OrderRecordExtendDTO

Throws:

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

getOrderRecordWithHttpInfo

public ApiResponse<OrderRecordExtendDTO> getOrderRecordWithHttpInfo(Long id)
                                                             throws ApiException

getOrderRecord Required permissions: CAN_GET_ORDERS

Parameters:

id - the internal id of order (required)

Returns:

ApiResponse<OrderRecordExtendDTO>

Throws:

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

getOrderRecordAsync

public com.squareup.okhttp.Call getOrderRecordAsync(Long id,
                                                    ApiCallback<OrderRecordExtendDTO> callback)
                                             throws ApiException

getOrderRecord (asynchronously) Required permissions: CAN_GET_ORDERS

Parameters:

id - the internal id of order (required)

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

mergeVouchersCall

public com.squareup.okhttp.Call mergeVouchersCall(Long orderId,
                                                  String newVoucherId,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException

Build call for mergeVouchers

Parameters:

orderId - the internal id of order (required)

newVoucherId - newVoucherId (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

mergeVouchers

public GenericStatusDTO mergeVouchers(Long orderId,
                                      String newVoucherId)
                               throws ApiException

mergeVouchers Replaces voucher IDs of order items with new voucher ID in the specified order. All groups are merged to one 'MergedGroup'.<br/>Required permissions: CAN_EDIT_ORDER

Parameters:

orderId - the internal id of order (required)

newVoucherId - newVoucherId (required)

Returns:

GenericStatusDTO

Throws:

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

mergeVouchersWithHttpInfo

public ApiResponse<GenericStatusDTO> mergeVouchersWithHttpInfo(Long orderId,
                                                               String newVoucherId)
                                                        throws ApiException

mergeVouchers Replaces voucher IDs of order items with new voucher ID in the specified order. All groups are merged to one 'MergedGroup'.<br/>Required permissions: CAN_EDIT_ORDER

Parameters:

orderId - the internal id of order (required)

newVoucherId - newVoucherId (required)

Returns:

ApiResponse<GenericStatusDTO>

Throws:

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

mergeVouchersAsync

public com.squareup.okhttp.Call mergeVouchersAsync(Long orderId,
                                                   String newVoucherId,
                                                   ApiCallback<GenericStatusDTO> callback)
                                            throws ApiException

mergeVouchers (asynchronously) Replaces voucher IDs of order items with new voucher ID in the specified order. All groups are merged to one 'MergedGroup'.<br/>Required permissions: CAN_EDIT_ORDER

Parameters:

orderId - the internal id of order (required)

newVoucherId - newVoucherId (required)

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

updateOrderRecordCall

public com.squareup.okhttp.Call updateOrderRecordCall(OrderRecordDTO orderRecordDto,
                                                      ProgressResponseBody.ProgressListener progressListener,
                                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                               throws ApiException

Build call for updateOrderRecord

Parameters:

orderRecordDto - the OrderRecord Dto (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updateOrderRecord

public OrderRecordDTO updateOrderRecord(OrderRecordDTO orderRecordDto)
                                 throws ApiException

updateOrderRecord 1) Cellphone number must be in E.164 format;<br/>2) «PricePaid» is a price for 1 product;<br/>3) Required permissions: CAN_EDIT_ORDER.

Parameters:

orderRecordDto - the OrderRecord Dto (required)

Returns:

OrderRecordDTO

Throws:

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

updateOrderRecordWithHttpInfo

public ApiResponse<OrderRecordDTO> updateOrderRecordWithHttpInfo(OrderRecordDTO orderRecordDto)
                                                          throws ApiException

updateOrderRecord 1) Cellphone number must be in E.164 format;<br/>2) «PricePaid» is a price for 1 product;<br/>3) Required permissions: CAN_EDIT_ORDER.

Parameters:

orderRecordDto - the OrderRecord Dto (required)

Returns:

ApiResponse<OrderRecordDTO>

Throws:

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

updateOrderRecordAsync

public com.squareup.okhttp.Call updateOrderRecordAsync(OrderRecordDTO orderRecordDto,
                                                       ApiCallback<OrderRecordDTO> callback)
                                                throws ApiException

updateOrderRecord (asynchronously) 1) Cellphone number must be in E.164 format;<br/>2) «PricePaid» is a price for 1 product;<br/>3) Required permissions: CAN_EDIT_ORDER.

Parameters:

orderRecordDto - the OrderRecord Dto (required)

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