pl.rspective.voucherify.client.module

Class VoucherModule.ExtRxJava

java.lang.Object

pl.rspective.voucherify.client.module.AbsModule.Rx

pl.rspective.voucherify.client.module.VoucherModule.ExtRxJava

Enclosing class:

VoucherModule

public class VoucherModule.ExtRxJava
extends pl.rspective.voucherify.client.module.AbsModule.Rx

RxJava extension.

Constructor Summary

Constructors

Constructor and Description
ExtRxJava()

Method Summary

Modifier and Type	Method and Description
rx.Observable<Voucher>	createVoucher(Voucher voucher) Create a voucher.
rx.Observable<java.lang.Void>	disableVoucher(java.lang.String code) Disable a voucher.
rx.Observable<java.lang.Void>	enableVoucher(java.lang.String code) Enable a voucher.
rx.Observable<Voucher>	fetchVoucher(java.lang.String identifier) Fetch a single resource with an identifier.
rx.Observable<java.util.List<RedemptionDetails>>	listRedemptions(RedemptionsFilter filter) List redemptions across all vouchers.
rx.Observable<java.util.List<Voucher>>	listVouchers(VouchersFilter filter) Fetch user's list of vouchers which meet provided filters.
rx.Observable<VoucherRedemptionResult>	redeem(java.lang.String identifier, java.lang.String trackingId) Redeem a voucher by his identifier
rx.Observable<VoucherRedemptionResult>	redeem(java.lang.String identifier, VoucherRedemptionContext redemptionContext) Redeem a voucher by his identifier
rx.Observable<VoucherRedemption>	redemption(java.lang.String identifier) Fetch information about voucher redemption
rx.Observable<VoucherRedemptionResult>	rollbackRedemption(java.lang.String redemptionId, java.lang.String trackingId, java.lang.String reason) Redemption rollback reverts a redemption.
rx.Observable<Voucher>	updateVoucher(java.lang.String code, VoucherUpdate voucherUpdate) Update voucher.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtRxJava

public ExtRxJava()

Method Detail

listVouchers

public rx.Observable<java.util.List<Voucher>> listVouchers(VouchersFilter filter)

Fetch user's list of vouchers which meet provided filters.

Parameters:

filter - a set of conditions to narrow down the result

Returns:

list of vouchers

fetchVoucher

public rx.Observable<Voucher> fetchVoucher(java.lang.String identifier)

Fetch a single resource with an identifier.

Parameters:

identifier - resource id

Returns:

resource result instance

createVoucher

public rx.Observable<Voucher> createVoucher(Voucher voucher)

Create a voucher.

Parameters:

voucher - voucher to be created

Returns:

created voucher

updateVoucher

public rx.Observable<Voucher> updateVoucher(java.lang.String code,
                                            VoucherUpdate voucherUpdate)

Update voucher.

Parameters:

code - code of a voucher that should be updated

voucherUpdate - voucher fields to be updated

Returns:

updated voucher

disableVoucher

public rx.Observable<java.lang.Void> disableVoucher(java.lang.String code)

Disable a voucher.

Parameters:

code - code of a voucher that should be disabled

enableVoucher

public rx.Observable<java.lang.Void> enableVoucher(java.lang.String code)

Enable a voucher.

Parameters:

code - code of a voucher that should be enabled

redeem

public rx.Observable<VoucherRedemptionResult> redeem(java.lang.String identifier,
                                                     java.lang.String trackingId)

Redeem a voucher by his identifier

Parameters:

identifier - of the voucher

Returns:

voucher which was consumed

redeem

public rx.Observable<VoucherRedemptionResult> redeem(java.lang.String identifier,
                                                     VoucherRedemptionContext redemptionContext)

Redeem a voucher by his identifier

Parameters:

identifier - of the voucher

Returns:

voucher which was consumed

redemption

public rx.Observable<VoucherRedemption> redemption(java.lang.String identifier)

Fetch information about voucher redemption

Parameters:

identifier - of the voucher for which we fetch the redemption details

Returns:

voucher redemption information

listRedemptions

public rx.Observable<java.util.List<RedemptionDetails>> listRedemptions(RedemptionsFilter filter)

List redemptions across all vouchers.

Parameters:

filter - a set of conditions to narrow down the result

Returns:

a list of redemption details

rollbackRedemption

public rx.Observable<VoucherRedemptionResult> rollbackRedemption(java.lang.String redemptionId,
                                                                 java.lang.String trackingId,
                                                                 java.lang.String reason)

Redemption rollback reverts a redemption.

Parameters:

redemptionId - (required) id of a redemption

trackingId - (optional) id of a customer

reason - (optional)

Returns:

rollback result