pl.rspective.voucherify.client.module

Class VoucherModule

java.lang.Object

pl.rspective.voucherify.client.module.VoucherModule

public final class VoucherModule
extends java.lang.Object

Vouchers Module to manage communication with Voucherify

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	pl.rspective.voucherify.client.module.AbsModule.Async
static class	pl.rspective.voucherify.client.module.AbsModule.Rx
class	VoucherModule.ExtAsync Async extension.
class	VoucherModule.ExtRxJava RxJava extension.

Constructor Summary

Constructors

Constructor and Description
VoucherModule(VoucherifyApi api, java.util.concurrent.Executor executor)

Method Summary

Modifier and Type	Method and Description
VoucherModule.ExtAsync	async() Returns the asynchronous extension of this module.
Voucher	createVoucher(Voucher voucher) Create a voucher.
void	disableVoucher(java.lang.String code) Disable a voucher.
void	enableVoucher(java.lang.String code) Enable a voucher.
Voucher	fetchVoucher(java.lang.String identifier) Fetch a single resource with an identifier.
java.util.List<RedemptionDetails>	listRedemptions(RedemptionsFilter filter) List redemptions across all vouchers.
java.util.List<Voucher>	listVouchers(VouchersFilter filter) Fetch user's list of vouchers which meet provided filters.
VoucherRedemptionResult	redeem(java.lang.String identifier, java.lang.String trackingId) Redeem a voucher identified by code
VoucherRedemptionResult	redeem(java.lang.String identifier, VoucherRedemptionContext redemptionContext) Redeem a voucher identified by code
VoucherRedemption	redemption(java.lang.String identifier) Fetch information about voucher redemption
VoucherModule.ExtRxJava	rx() Returns the RxJava extension of this module.

Methods inherited from class java.lang.Object

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

Constructor Detail

VoucherModule

public VoucherModule(VoucherifyApi api,
                     java.util.concurrent.Executor executor)

Parameters:

api - describes Voucherify REST API

executor - of threads for current platform

Method Detail

listVouchers

public 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 Voucher fetchVoucher(java.lang.String identifier)

Fetch a single resource with an identifier.

Parameters:

identifier - resource id

Returns:

resource result instance

createVoucher

public Voucher createVoucher(Voucher voucher)

Create a voucher.

Parameters:

voucher - voucher to be created

Returns:

created voucher

disableVoucher

public void disableVoucher(java.lang.String code)

Disable a voucher.

Parameters:

code - code of a voucher that should be disabled

enableVoucher

public void enableVoucher(java.lang.String code)

Enable a voucher.

Parameters:

code - code of a voucher that should be enabled

redeem

public VoucherRedemptionResult redeem(java.lang.String identifier,
                                      java.lang.String trackingId)

Redeem a voucher identified by code

Parameters:

identifier - code of the voucher

Returns:

voucher which was redeemed

redeem

public VoucherRedemptionResult redeem(java.lang.String identifier,
                                      VoucherRedemptionContext redemptionContext)

Redeem a voucher identified by code

Parameters:

identifier - code of the voucher

Returns:

voucher which was redeemed

redemption

public 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 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

async

public VoucherModule.ExtAsync async()

Returns the asynchronous extension of this module.

rx

public VoucherModule.ExtRxJava rx()

Returns the RxJava extension of this module.