com.bymdev.voucherhub.api

Class VoucherResourceApi

java.lang.Object

com.bymdev.voucherhub.api.VoucherResourceApi

public class VoucherResourceApi
extends Object

Constructor Summary

Constructors

Constructor and Description
VoucherResourceApi()
VoucherResourceApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
GenericStatusDTO	cancelValidation(String transactionTag, String reason, OrderNoteParamDTO note) [V2] Cancel validation for the voucher Required permissions: CAN_CANCEL_VALIDATION
com.squareup.okhttp.Call	cancelValidationAsync(String transactionTag, String reason, OrderNoteParamDTO note, ApiCallback<GenericStatusDTO> callback) [V2] Cancel validation for the voucher (asynchronously) Required permissions: CAN_CANCEL_VALIDATION
com.squareup.okhttp.Call	cancelValidationCall(String transactionTag, String reason, OrderNoteParamDTO note, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for cancelValidation
ApiResponse<GenericStatusDTO>	cancelValidationWithHttpInfo(String transactionTag, String reason, OrderNoteParamDTO note) [V2] Cancel validation for the voucher Required permissions: CAN_CANCEL_VALIDATION
GenericStatusDTO	cancelVoucher(Long orderId, String voucherId, OrderNoteParamDTO note) cancelVoucher Required permissions: CAN_CANCEL_ORDER
com.squareup.okhttp.Call	cancelVoucherAsync(Long orderId, String voucherId, OrderNoteParamDTO note, ApiCallback<GenericStatusDTO> callback) cancelVoucher (asynchronously) Required permissions: CAN_CANCEL_ORDER
com.squareup.okhttp.Call	cancelVoucherCall(Long orderId, String voucherId, OrderNoteParamDTO note, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for cancelVoucher
ApiResponse<GenericStatusDTO>	cancelVoucherWithHttpInfo(Long orderId, String voucherId, OrderNoteParamDTO note) cancelVoucher Required permissions: CAN_CANCEL_ORDER
JSONObject	convertVoucher(String oldVoucherId, String newVoucherId) convertVoucher Required permissions: CAN_CONVERT_VOUCHER
com.squareup.okhttp.Call	convertVoucherAsync(String oldVoucherId, String newVoucherId, ApiCallback<JSONObject> callback) convertVoucher (asynchronously) Required permissions: CAN_CONVERT_VOUCHER
com.squareup.okhttp.Call	convertVoucherCall(String oldVoucherId, String newVoucherId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for convertVoucher
ApiResponse<JSONObject>	convertVoucherWithHttpInfo(String oldVoucherId, String newVoucherId) convertVoucher Required permissions: CAN_CONVERT_VOUCHER
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
ValidationResult	validateVoucher(String validationId, Long vendorId, String productTag, List<Long> orderItemIds, Boolean skipExpiryCheck, ExtraValidationParamDTO extraParamDTO) [V2] Validates voucher which represents single order item or group of them.
com.squareup.okhttp.Call	validateVoucherAsync(String validationId, Long vendorId, String productTag, List<Long> orderItemIds, Boolean skipExpiryCheck, ExtraValidationParamDTO extraParamDTO, ApiCallback<ValidationResult> callback) [V2] Validates voucher which represents single order item or group of them.
com.squareup.okhttp.Call	validateVoucherCall(String validationId, Long vendorId, String productTag, List<Long> orderItemIds, Boolean skipExpiryCheck, ExtraValidationParamDTO extraParamDTO, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for validateVoucher
ApiResponse<ValidationResult>	validateVoucherWithHttpInfo(String validationId, Long vendorId, String productTag, List<Long> orderItemIds, Boolean skipExpiryCheck, ExtraValidationParamDTO extraParamDTO) [V2] Validates voucher which represents single order item or group of them.

Methods inherited from class java.lang.Object

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

Constructor Detail

VoucherResourceApi

public VoucherResourceApi()

VoucherResourceApi

public VoucherResourceApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

cancelValidationCall

public com.squareup.okhttp.Call cancelValidationCall(String transactionTag,
                                                     String reason,
                                                     OrderNoteParamDTO note,
                                                     ProgressResponseBody.ProgressListener progressListener,
                                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                              throws ApiException

Build call for cancelValidation

Parameters:

transactionTag - the transaction tag of validation (required)

reason - the reason of validation (optional)

note - the validation note dto (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

cancelValidation

public GenericStatusDTO cancelValidation(String transactionTag,
                                         String reason,
                                         OrderNoteParamDTO note)
                                  throws ApiException

[V2] Cancel validation for the voucher Required permissions: CAN_CANCEL_VALIDATION

Parameters:

transactionTag - the transaction tag of validation (required)

reason - the reason of validation (optional)

note - the validation note dto (optional)

Returns:

GenericStatusDTO

Throws:

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

cancelValidationWithHttpInfo

public ApiResponse<GenericStatusDTO> cancelValidationWithHttpInfo(String transactionTag,
                                                                  String reason,
                                                                  OrderNoteParamDTO note)
                                                           throws ApiException

[V2] Cancel validation for the voucher Required permissions: CAN_CANCEL_VALIDATION

Parameters:

transactionTag - the transaction tag of validation (required)

reason - the reason of validation (optional)

note - the validation note dto (optional)

Returns:

ApiResponse<GenericStatusDTO>

Throws:

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

cancelValidationAsync

public com.squareup.okhttp.Call cancelValidationAsync(String transactionTag,
                                                      String reason,
                                                      OrderNoteParamDTO note,
                                                      ApiCallback<GenericStatusDTO> callback)
                                               throws ApiException

[V2] Cancel validation for the voucher (asynchronously) Required permissions: CAN_CANCEL_VALIDATION

Parameters:

transactionTag - the transaction tag of validation (required)

reason - the reason of validation (optional)

note - the validation note dto (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

cancelVoucherCall

public com.squareup.okhttp.Call cancelVoucherCall(Long orderId,
                                                  String voucherId,
                                                  OrderNoteParamDTO note,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException

Build call for cancelVoucher

Parameters:

orderId - the internal id of order (required)

voucherId - the voucher id (optional)

note - the voucher note dto (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

cancelVoucher

public GenericStatusDTO cancelVoucher(Long orderId,
                                      String voucherId,
                                      OrderNoteParamDTO note)
                               throws ApiException

cancelVoucher Required permissions: CAN_CANCEL_ORDER

Parameters:

orderId - the internal id of order (required)

voucherId - the voucher id (optional)

note - the voucher note dto (optional)

Returns:

GenericStatusDTO

Throws:

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

cancelVoucherWithHttpInfo

public ApiResponse<GenericStatusDTO> cancelVoucherWithHttpInfo(Long orderId,
                                                               String voucherId,
                                                               OrderNoteParamDTO note)
                                                        throws ApiException

cancelVoucher Required permissions: CAN_CANCEL_ORDER

Parameters:

orderId - the internal id of order (required)

voucherId - the voucher id (optional)

note - the voucher note dto (optional)

Returns:

ApiResponse<GenericStatusDTO>

Throws:

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

cancelVoucherAsync

public com.squareup.okhttp.Call cancelVoucherAsync(Long orderId,
                                                   String voucherId,
                                                   OrderNoteParamDTO note,
                                                   ApiCallback<GenericStatusDTO> callback)
                                            throws ApiException

cancelVoucher (asynchronously) Required permissions: CAN_CANCEL_ORDER

Parameters:

orderId - the internal id of order (required)

voucherId - the voucher id (optional)

note - the voucher note dto (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

convertVoucherCall

public com.squareup.okhttp.Call convertVoucherCall(String oldVoucherId,
                                                   String newVoucherId,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for convertVoucher

Parameters:

oldVoucherId - the old voucher id (required)

newVoucherId - the new voucher id (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

convertVoucher

public JSONObject convertVoucher(String oldVoucherId,
                                 String newVoucherId)
                          throws ApiException

convertVoucher Required permissions: CAN_CONVERT_VOUCHER

Parameters:

oldVoucherId - the old voucher id (required)

newVoucherId - the new voucher id (required)

Returns:

JSONObject

Throws:

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

convertVoucherWithHttpInfo

public ApiResponse<JSONObject> convertVoucherWithHttpInfo(String oldVoucherId,
                                                          String newVoucherId)
                                                   throws ApiException

convertVoucher Required permissions: CAN_CONVERT_VOUCHER

Parameters:

oldVoucherId - the old voucher id (required)

newVoucherId - the new voucher id (required)

Returns:

ApiResponse<JSONObject>

Throws:

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

convertVoucherAsync

public com.squareup.okhttp.Call convertVoucherAsync(String oldVoucherId,
                                                    String newVoucherId,
                                                    ApiCallback<JSONObject> callback)
                                             throws ApiException

convertVoucher (asynchronously) Required permissions: CAN_CONVERT_VOUCHER

Parameters:

oldVoucherId - the old voucher id (required)

newVoucherId - the new voucher id (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

validateVoucherCall

public com.squareup.okhttp.Call validateVoucherCall(String validationId,
                                                    Long vendorId,
                                                    String productTag,
                                                    List<Long> orderItemIds,
                                                    Boolean skipExpiryCheck,
                                                    ExtraValidationParamDTO extraParamDTO,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException

Build call for validateVoucher

Parameters:

validationId - the voucher validation id (required)

vendorId - the internal id of vendor (required)

productTag - the product tag (optional)

orderItemIds - the array of order item ids (optional)

skipExpiryCheck - flag to skip expiry check within strategy (optional)

extraParamDTO - the validation extra params dto (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

validateVoucher

public ValidationResult validateVoucher(String validationId,
                                        Long vendorId,
                                        String productTag,
                                        List<Long> orderItemIds,
                                        Boolean skipExpiryCheck,
                                        ExtraValidationParamDTO extraParamDTO)
                                 throws ApiException

[V2] Validates voucher which represents single order item or group of them. Required permissions: CAN_VALIDATE;

Parameters:

validationId - the voucher validation id (required)

vendorId - the internal id of vendor (required)

productTag - the product tag (optional)

orderItemIds - the array of order item ids (optional)

skipExpiryCheck - flag to skip expiry check within strategy (optional)

extraParamDTO - the validation extra params dto (optional)

Returns:

ValidationResult

Throws:

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

validateVoucherWithHttpInfo

public ApiResponse<ValidationResult> validateVoucherWithHttpInfo(String validationId,
                                                                 Long vendorId,
                                                                 String productTag,
                                                                 List<Long> orderItemIds,
                                                                 Boolean skipExpiryCheck,
                                                                 ExtraValidationParamDTO extraParamDTO)
                                                          throws ApiException

[V2] Validates voucher which represents single order item or group of them. Required permissions: CAN_VALIDATE;

Parameters:

validationId - the voucher validation id (required)

vendorId - the internal id of vendor (required)

productTag - the product tag (optional)

orderItemIds - the array of order item ids (optional)

skipExpiryCheck - flag to skip expiry check within strategy (optional)

extraParamDTO - the validation extra params dto (optional)

Returns:

ApiResponse<ValidationResult>

Throws:

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

validateVoucherAsync

public com.squareup.okhttp.Call validateVoucherAsync(String validationId,
                                                     Long vendorId,
                                                     String productTag,
                                                     List<Long> orderItemIds,
                                                     Boolean skipExpiryCheck,
                                                     ExtraValidationParamDTO extraParamDTO,
                                                     ApiCallback<ValidationResult> callback)
                                              throws ApiException

[V2] Validates voucher which represents single order item or group of them. (asynchronously) Required permissions: CAN_VALIDATE;

Parameters:

validationId - the voucher validation id (required)

vendorId - the internal id of vendor (required)

productTag - the product tag (optional)

orderItemIds - the array of order item ids (optional)

skipExpiryCheck - flag to skip expiry check within strategy (optional)

extraParamDTO - the validation extra params dto (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