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
Voucher	createVoucher(Voucher voucher) Create a voucher with generated code.
Voucher	createVoucherWithCode(java.lang.String code, Voucher voucher) Create a voucher with specified code.
com.squareup.okhttp.Response	disableVoucher(java.lang.String code) Disable a voucher.
com.squareup.okhttp.Response	enableVoucher(java.lang.String code) Enable a voucher.
Voucher	fetch(java.lang.String code) Fetch details for a specific voucher.
java.util.List<RedemptionDetails>	listRedemptions(RedemptionsFilter filter) List redemptions across all vouchers.
java.util.List<Voucher>	listVouchers(VouchersFilter filter) List vouchers which meet provided filters.
VoucherRedemptionResult	redeem(java.lang.String code, java.lang.String trackingId) Method used to redeem a voucher identified by code
VoucherRedemptionResult	redeem(java.lang.String code, VoucherRedemptionContext redemptionContext) Method used to redeem a voucher and provide a context information.
VoucherRedemption	redemption(java.lang.String code) Fetch information about voucher redemption details

Method Detail

listVouchers

@GET(value="/vouchers/")
java.util.List<Voucher> listVouchers(@QueryMap
                                                               VouchersFilter filter)

List vouchers which meet provided filters.

Parameters:

filter - a set of conditions to narrow down the result

Returns:

a list of user vouchers

fetch

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

Fetch details for a specific voucher.

Parameters:

code - code of the voucher

Returns:

details of a the voucher identified by given code

createVoucher

@POST(value="/vouchers/")
Voucher createVoucher(@Body
                                                 Voucher voucher)

Create a voucher with generated code.

Parameters:

voucher - voucher to be created

Returns:

created voucher

createVoucherWithCode

@POST(value="/vouchers/{code}")
Voucher createVoucherWithCode(@Path(value="code")
                                                               java.lang.String code,
                                                               @Body
                                                               Voucher voucher)

Create a voucher with specified code.

Parameters:

voucher - voucher to be created

Returns:

created voucher

disableVoucher

@POST(value="/vouchers/{code}/disable")
com.squareup.okhttp.Response disableVoucher(@Path(value="code")
                                                                                     java.lang.String code)

Disable a voucher.

Parameters:

code - code of a voucher that should be disabled

enableVoucher

@POST(value="/vouchers/{code}/enable")
com.squareup.okhttp.Response enableVoucher(@Path(value="code")
                                                                                   java.lang.String code)

Enable a voucher.

Parameters:

code - code of a voucher that should be enabled

redeem

@POST(value="/vouchers/{code}/redemption")
VoucherRedemptionResult redeem(@Path(value="code")
                                                                           java.lang.String code,
                                                                           @Query(value="tracking_id")
                                                                           java.lang.String trackingId)

Method used to redeem a voucher identified by code

Parameters:

code - code of the voucher

trackingId - an id enabling you to correlate who has redeemed the voucher

Returns:

redeem

@POST(value="/vouchers/{code}/redemption")
VoucherRedemptionResult redeem(@Path(value="code")
                                                                           java.lang.String code,
                                                                           @Body
                                                                           VoucherRedemptionContext redemptionContext)

Method used to redeem a voucher and provide a context information.

Parameters:

code - code of the voucher

redemptionContext - a context in terms of which the voucher is being redeemed (e.g. customer profile)

Returns:

redemption

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

Fetch information about voucher redemption details

Parameters:

code - of the voucher

Returns:

voucher redemption information

listRedemptions

@GET(value="/redemptions")
java.util.List<RedemptionDetails> listRedemptions(@QueryMap
                                                                              RedemptionsFilter filter)

List redemptions across all vouchers.

Parameters:

filter - a set of conditions to narrow down the result

Returns:

a list of redemption details