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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
pl.rspective.voucherify.client.module.BaseModule.ExtAsync	async() Returns the asynchronous extension of this module.
T	fetchVoucher(java.lang.String identifier) Fetch a single resource with an identifier.
RR	redeem(java.lang.String identifier, java.lang.String trackingId) Redeem a voucher identified by code
RR	redeem(java.lang.String identifier, VoucherRedemptionContext redemptionContext) Redeem a voucher identified by code
R	redemption(java.lang.String identifier) Fetch information about voucher redemption
pl.rspective.voucherify.client.module.BaseModule.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

async

public pl.rspective.voucherify.client.module.BaseModule.ExtAsync async()

Returns the asynchronous extension of this module.

rx

public pl.rspective.voucherify.client.module.BaseModule.ExtRxJava rx()

Returns the RxJava extension of this module.

fetchVoucher

public T fetchVoucher(java.lang.String identifier)

Fetch a single resource with an identifier.

Parameters:

identifier - resource id

Returns:

resource result instance

redeem

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