pl.rspective.voucherify.client.api

Interface VoucherifyApi

public interface VoucherifyApi

An interface used internally to create a Retrofit API.

Method Summary

Modifier and Type	Method and Description
java.util.List<Voucher>	fetchAllVouchers() Method used to download all vouchers
Voucher	fetchVoucher(java.lang.String code)
VoucherUsage	useVoucher(java.lang.String code) Method used to consume the voucher based on his code

Method Detail

fetchAllVouchers

@GET(value="/vouchers")
java.util.List<Voucher> fetchAllVouchers()

Method used to download all vouchers

Returns:

list of vouchers

fetchVoucher

@GET(value="/vouchers/{code}")
Voucher fetchVoucher(@Path(value="code")
                                                    java.lang.String code)

Parameters:

code - of the voucher

Returns:

voucher based on his code

useVoucher

@PUT(value="/vouchers/{code}/usage")
VoucherUsage useVoucher(@Path(value="code")
                                                             java.lang.String code)

Method used to consume the voucher based on his code

Parameters:

code - of the voucher

Returns: